Open Source Template

A demo for the OSS template at MeteoSwiss.

The template can be use as an example how to configure MeteoSwiss Github projects.

It uses:

• Github actions to execute the CI/CD pipelines

• Github pages to host the documentation

• PyPI to publish the python packages

Development Setup with Poetry

Building the Project

$ cd open-source-template
$ poetry install

Run Tests

$ poetry run pytest

Run Quality Tools

$ poetry run pylint open_source_template
$ poetry run mypy open_source_template

Generate Documentation

$ poetry run sphinx-build doc doc/_build

Then open the index.html file generated in open-source-template/doc/_build/.

Build wheels

$ poetry build

Using the Library

To install open-source-template in your project, run this command in your terminal:

$ poetry add open-source-template

You can then use the library in your project through

import open_source_template

Releasing

• Adapt CHANGELOG.rst with release information

• Adapt doc/_static/switcher_config.json adding the new documentation URL for the release

• Create a new Release in the Github project