Code Monkey home page Code Monkey logo

fmetools's Introduction

fmetools: helpers for FME Python

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.7 or newer.

Getting started

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/.

Installation

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.

For maintainers of fmetools

  1. Start with a clean environment
  2. Install dev requirements using pip install -r requirements.txt
  3. Do a dev install using pip install --editable .
  4. Run tests using pytest
  5. Build wheel using python -m build --wheel
  6. To build docs: sphinx-build -M html docs docs/_build

fmetools's People

Contributors

carsonyl avatar hhtong avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

drroad

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.