Skip to content

pgroenbaek/trackshape-utils

Repository files navigation

trackshape-utils

GitHub release (latest by date) Python 3.6+ License GNU GPL v3

🚧 Project Status: In Development This project is still being actively developed. Expect unstable functionality and frequent changes.

A collection of utilities for working with MSTS/ORTS track shapes.

List of companion modules:

  • shapeio - offers functions to convert shapes between structured text format and Python objects.
  • shapeedit - provides a wrapper for modifying the shape data structure safely.
  • pytkutils - handles compression and decompression of shape files through the TK.MSTS.Tokens.dll library by Okrasa Ghia.

Installation

Install from source

git clone https://github.com/pgroenbaek/trackshape-utils.git
pip install --upgrade ./trackshape-utils

Usage

TODO

Running Tests

You can run tests manually or use tox to test across multiple Python versions.

Run Tests Manually

First, install the required dependencies:

pip install pytest

Then, run tests with:

pytest

Run Tests with tox

tox allows you to test across multiple Python environments.

1. Install tox

pip install tox

2. Run Tests

tox

This will execute tests in all specified Python versions.

3. tox.ini Configuration

The tox.ini file should be in your project root:

[tox]
envlist = py36, py37, py38, py39, py310

[testenv]
deps = pytest
commands = pytest

Modify envlist to match the Python versions you want to support.

License

This Python module was created by Peter Grønbæk Andersen and is licensed under GNU GPL v3.

The module includes the standardized global tsection.dat build #60 by Derek Morton. This file is also distributed under the GNU General Public License.

About

A Python module that provides a collection of utilities for working with MSTS/ORTS track shapes.

Topics

Resources

License

Stars

Watchers

Forks

Languages