fmetools is a Python library that streamlines plugin development for Safe Software's FME. Developers should use fmetools as a foundation to create plugins such as transformers. It's part of the recommended toolchain for developing FME Packages to share on FME Hub.
fmetools is built on top of the Python fmeobjects API that's included with FME,
and requires an FME installation with Python 3.8 or newer.
The best way to get started with fmetools is through the tutorials in the FME Packages SDK Guide. The Hello World package tutorial guides you through creating a simple FME Package that uses fmetools.
The fmetools API reference is available at https://docs.safe.com/fme/html/fmetools/.
fmetools is distributed as a wheel on PyPI,
but it should not be installed with pip install.
Instead, developers include a copy of fmetools with their FME Package.
This process is called vendorizing, and can be done using the vendorize tool on PyPI.
The Hello World package tutorial covers this topic.
FME does not include fmetools, so packages that use it must include it themselves.
- Start with a clean environment
- Install dev requirements using
pip install -r requirements.txt - Do a dev install using
pip install --editable . - Run tests using
pytest - Build wheel using
python -m build --wheel - To build docs:
sphinx-build -M html docs docs/_build