Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
P
python_project
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
examples
python_project
Commits
ef36c894
Commit
ef36c894
authored
6 years ago
by
Tamas Gal
Browse files
Options
Downloads
Patches
Plain Diff
Update README.rst
parent
7298a916
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Pipeline
#1798
passed
6 years ago
Stage: test
Stage: coverage
Stage: doc
Stage: deploy
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.rst
+24
-13
24 additions, 13 deletions
README.rst
with
24 additions
and
13 deletions
README.rst
+
24
−
13
View file @
ef36c894
...
...
@@ -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 server
s
- ``.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
N
ote that the GitLab CI is using KM3NeT services (the GitLab runners and
Please n
ote 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 request
s
. 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
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment