Skip to content
Snippets Groups Projects
Commit ef36c894 authored by Tamas Gal's avatar Tamas Gal :speech_balloon:
Browse files

Update README.rst

parent 7298a916
No related branches found
No related tags found
No related merge requests found
Pipeline #1798 passed
......@@ -6,46 +6,57 @@ 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
- ``doc/conf.py`` - the documentation is configured in this file
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
run on the KM3NeT continuous integration server
run on the KM3NeT continuous integration servers
- ``.coveragerc`` - contains a list of files to include or skip. Make sure
to update the package name to match yours
to update the package name to match yours and exclude files which should
not be tracked
Note that the GitLab CI is using KM3NeT services (the GitLab runners and
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 request. Merge requests are welcome!
questions, feedback or feature requests. Merge requests are welcome!
**Tamás Gál**
Features of this Template
=========================
-------------------------
- 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: ``cd doc && make html``
- 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/
- Continuous Integration on the KM3NeT GitLab server
Installing
----------
Installing the Python Package
-----------------------------
This Python package works out of the box. Explore it with with the following
commands.
Install it with::
make install
Testing
-------
Run the tests with::
make test
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment