python-library-mockup
Template repository to create a python library (like julearn)
Instructions
- Create a repository on Github using this one as a template.
- Clone your repository.
- Change the name of the library (currently
mockup) - Replace the following tokens with search and replace.
| Token | Content | Example |
|---|---|---|
brainrevenge |
Package name | julearn |
https://github.com/brainrevenge/brainrevenge |
Github URL | https://github.com/juaml/julearn/ |
https://brainrevenge.github.io/brainrevenge/ |
DOCs URL | https://juaml.github.io/julearn |
Fede Raimondo |
Author's name | Fede Raimondo |
f.raimondo@fz-juelich.de |
Author's name | f.raimondo@fz-juelich.de |
BrainRevenge Project Library |
Short description | FZJ AML Library |
- Go to https://pypi.org/
- login (maybe create an account)
- Go to account settings
- Scroll down to API tokens
- Create a token for all projects, take note.
- Repeat 4. but for https://test.pypi.org
- On your Github repository, go to "Settings" and the "Secrets". Add the respective
PYPI_TOKENandTESTPYPI_TOKEN - Commit the changes and push to your repository.
- Open the documentation and follow the instructions to release a version.
