spotriver
Development
Styleguide
Follow the Google Python Style Guide from https://google.github.io/styleguide/pyguide.html.
Pre commit checks
Before you commit your code, please check that it is "clean".
To do so, first run black from the projects root directory:
$ black .
Next, check if flake8 shows any errors:
$ flake8
Fix any shown errors before you commit.
Installation
github
- Clone the github repository.
Python
-
Mac Users: Install brew
brew install pythonandbrew install graphvizetc.
-
Generate and activate a virtual environment, see venv, e.g.,
cd ~; python3 -m venv .venvsource ~/.venv/bin/activate
Python mkdocs
python -m pip install mkdocs mkdocs-gen-files mkdocs-literate-nav mkdocs-section-index mkdocs-materialmkdocs buildmkdocs servehttp://127.0.0.1:8000/
Optimizing/Profiling Code
https://scipy-lectures.org/advanced/optimizing/index.html
Editor/IDE
- Optional: Install visualstudio
- Optional: Install quarto
Package Installation
Configuration Files
- This information is based on https://packaging.python.org/en/latest/tutorials/packaging-projects/
- Information is stored in
pyproject.toml(setup.pyis not used anymore.) - A
srcfolder is used for the package sources. - The following files are used for the package building:
pyproject.toml: see pyproject.toml.- Important: Follow the instructions from https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html for including data files (like *.csv, *.tar, etc.). These files can be specified in the following
MANIFESTfile:MANIFEST: see MANIFEST. It describes the data files to be included, e.g.:include src/spotriver/data/*.rst
LICENSE: see LICENSE
Installation
- Perform the following steps to install the package:
- Make sure you have the latest version of PyPA’s build installed:
python3 -m pip install --upgrade build
- Start the package building process via:
python3 -m build - This command should output a lot of text and once completed should generate two files in the
distdirectory. - You can use the local
spotriver*.tar.gzfile from thedistfolder for your package installation withpip, e.g.; python3 -m pip install ./dist/spotriver-*.tar.gz
- Make sure you have the latest version of PyPA’s build installed:
1 maintainer
Metadata
1 maintainer
Release files for spotriver 0.4.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| spotriver-0.4.4.tar.gz | 477.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| spotriver-0.4.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 961.5 kB
Release files / spotriver-0.4.4.tar.gz
| Download URL | spotriver-0.4.4.tar.gz |
|---|---|
| Size | 477.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6c15dafede481f8cc8b81e7ac71ea8aa5fdcb647cfc82b690b00d1d37b189c82
|
|
BLAKE2b-256 checksum How to use checksums |
5986a6609bdba39eb7a9df256146901c4530128ac16b02fb29c9a76f4e3b2203
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.5
|
Release files / spotriver-0.4.4-py3-none-any.whl
| Download URL | spotriver-0.4.4-py3-none-any.whl |
|---|---|
| Size | 483.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d28bf7a875151cb023642bbd8a05606a1655485a1b829a2b3fb02f97476c5481
|
|
BLAKE2b-256 checksum How to use checksums |
38bac08caebdf08383fb766203dfdec75dd30b5598264a1468236c1f4247f9de
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.5
|
