Skip to content

Latest commit

 

History

History
40 lines (25 loc) · 1.99 KB

README.md

File metadata and controls

40 lines (25 loc) · 1.99 KB
Raw

PyRoll Plugin

Template for PyRoll Plugin Repositories.

Please follow the following instructions when creating your own PyRoll plugins:

  • The folder pyroll is a namespace package, place your plugin package therein to make it discoverable by the CLI for example by just renaming the nested plugin package to the desired).

  • Use pytest for creating unit tests. Place all test files in the tests folder.

  • Update the pyproject.toml with your metadata. It is recommended to use hatch to maintain dependencies, as is preconfigured. It is recommended that the plugin major version corresponds to the PyRoll Core major version (so plugin versions 2.x.x working with pyroll-core 2.x.x).

  • Place documentation in the docs folder:

    • you may provide a printable documentation using LaTeX based on the docs.tex template and the provided PyRollDocs class
    • you may provide a web documentation using Markdown or RST rendered by GitHub or external tools like Sphinx
    • you may provide a printable documentation built from Markdown or RST by tools such as Pandoc
    • if appropriate, include the result PDF in the commit and link it from README.md like so
    • include model and usage information in the documentation

  • Please use a permissive license such as BSD or MIT

  • Edit this readme file with contents of your own needs.

  • If you want your plugin to be listed on the main documentation website (see here), please contact the maintainers preferably using an issue or PR.

Usage of the Preconfigured Hatch Scripts

To build the docs use (needs a working LaTeX installation)

hatch run docs:build

To run the tests use

hatch run test:all

The test environment is preconfigured to test with Python 3.9, 3.10 and 3.11. The tests are skipped for the respective version, if it can not be found.