Newer
Older
Fork this project and adjust the following files to your needs to get started
with a new Python project:
- ``requirements.txt`` - a list of Python packages needed for your software
- ``setup.py`` - this includes meta data for your package and is required
for the ``pip install`` procedure. The most important things to change
are listed at the top of the file.
- ``doc/conf.py`` - the documentation is configured in this file. Make sure
to update the descriptions, title, ``import`` statements and so on.
Add ``*.rst`` files inside the ``doc`` folder and include them in
``index.rst``. If you need more information, check out the Sphinx
documentation.
- ``.gitlab-ci.yml`` - this file describes the stages and jobs you want to
- ``.coveragerc`` - contains a list of files to include or skip. Make sure
to update the package name to match yours and exclude files which should
not be tracked
Please note that the GitLab CI is using KM3NeT services (the GitLab runners and
the KM3NeT Docker registry), so make sure you update the settings to match
your environment.
Don't write me a mail, please create an issue
(https://git.km3net.de/examples/python_project/issues) if you have any
questions, feedback or feature requests. Merge requests are welcome!
- Package installation using ``pip install .`` (also via ``make install``)
- Test Suite infrastructure included
- ``make test`` will run all tests
- ``make test-loop`` will run the tests and watch files for changes to rerun
them continuously
- Documentation infrastructure which includes automatic generation of HTML
pages, publishing using **GitLab pages**
and the generation of a fully browsable coverage report under the following
links:
- Docs: https://examples.pages.km3net.de/python_project
- Code coverage: https://examples.pages.km3net.de/python_project/coverage/
Installing the Python Package
-----------------------------
This Python package works out of the box. Explore it with with the following
commands.
Install it with::
make install
Run the tests with::
make test