pyFFEDITC

This Python module wraps the ffeditc_unicode.exe utility. The module allows you to compress and decompress MSTS files such as shape and world files on Windows.

Important

This module requires ffeditc_unicode.exe from Microsoft Train Simulator (MSTS). It is not included with this Python module. You must provide the executable from your own MSTS installation.

See also:

• pytkutils - handles compression and decompression of MSTS files such as shape and world file through the TK.MSTS.Tokens.dll library by Okrasa Ghia.

Prerequisites

This Python module requires Windows, and in addition you must supply the ffeditc_unicode.exe utility found in MSTS installations yourself.

Installation

Install from PyPI

pip install --upgrade pyffeditc

Install from wheel

If you have downloaded a .whl file from the Releases page, install it with:

pip install path/to/pyffeditc-<version>‑py3‑none‑any.whl

Replace <version> with the actual version number in the filename.

Install from source

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

Usage

Check if a file on disk is compressed

To check whether a file on disk is compressed, you can use the is_compressed function. This function returns True if the file is compressed and False if it is not. If the file is empty or its state cannot be determined, the function will return None.

import pyffeditc

compressed = pyffeditc.is_compressed("./path/to/example.s")

if compressed is True:
    print("Compressed")
elif compressed is False:
    print("Uncompressed")
else:
    print("Could not determine (possibly empty file)")

Compress or decompress files

The compression and decompression functions in this module use the ffeditc_unicode.exe utility found in MSTS installations. This utility is not included with the Python module.

Alternatively, you can use pytkutils on both Windows, Linux and macOS. But note that only compression appears to work properly using the TK.MSTS.Tokens.dll library by Okrasa Ghia.

You can also compress/decompress manually using ffeditc_unicode.exe through the Shape File Manager or use the FFEDIT_Sub v1.2 utility by Ged Saunders.

import pyffeditc

ffeditc_path = "./path/to/ffeditc_unicode.exe"

# Compress and decompress in-place.
pyffeditc.compress(ffeditc_path, "./path/to/example.s")
pyffeditc.decompress(ffeditc_path, "./path/to/example.s")

# Compress and decompress to an output file.
pyffeditc.compress(ffeditc_path, "./path/to/example.s", "./path/to/output.s")
pyffeditc.decompress(ffeditc_path, "./path/to/example.s", "./path/to/output.s")

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 pytest-dependency

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.

Contributing

Contributions of all kinds are welcome. These could be suggestions, issues, bug fixes, documentation improvements, or new features.

For more details see the contribution guidelines.

License

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