Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
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
Templates
Python Project
Commits
08279a81
Verified
Commit
08279a81
authored
3 years ago
by
Tamas Gal
Browse files
Options
Downloads
Patches
Plain Diff
Update readme
parent
29ece1af
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Pipeline
#26277
failed
3 years ago
Stage: install
Stage: install-dev
Stage: test
Stage: doc
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
{{cookiecutter.project_slug}}/README.rst
+30
-0
30 additions, 0 deletions
{{cookiecutter.project_slug}}/README.rst
with
30 additions
and
0 deletions
{{cookiecutter.project_slug}}/README.rst
+
30
−
0
View file @
08279a81
...
...
@@ -10,3 +10,33 @@
.. image:: https://git.km3net.de/examples/km3badges/-/raw/master/docs-latest-brightgreen.svg
:target: https://{{cookiecutter.gitlab_username}}.pages.km3net.de/{{cookiecutter.project_slug}}
Installation
~~~~~~~~~~~~
It is recommended to first create an isolated virtualenvironment to not interfere
with other Python projects::
git clone {{cookiecutter.gitlab_repo_path}}
cd {{cookiecutter.project_slug}}
python3 -m venv venv
. venv/bin/activate
Install directly from the Git server via ``pip`` (no cloneing needed)::
pip install git+{{cookiecutter.gitlab_repo_path}}
Or clone the repository and run::
make install
To install all the development dependencies, in case you want to contribute or
run the test suite::
make install-dev
make test
---
*Created with ``cookiecutter https://git.km3net.de/templates/python-project``*
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