Template repository for a library project
Initial set up
- In the link above, replace
librarynamewith your library's name. - Rename the
librarynamefolder to the name of your library, do not use hyphens, '-', in the name. - Replace all instances of
libraryname,vscodenb, andfunctionnamefor the names of/in your library (Shift-Cmd-Fin VScode).
Development
In addition to any dependencies of your library, the development setup requires quarto the following packages:
conda-forge::jupyter conda-forge::nbconvert conda-forge::quartodoc conda-forge::gh conda-forge::git conda-forge::pip
Version
The only version you need to change is the one in setup.cfg.
Unit tests
Test are put in test/test_vscodenb.py. Run these and all other test_* files you create by running ./scripts/test.sh.
Creating docs
Use type hits (with the typing module) for code and add this to your settings.json in VScode.
"files.associations": {
"*.qmd": "quarto"
},
"autoDocstring.docstringFormat": "numpy",
"autoDocstring.startOnNewLine": true,
"autoDocstring.customTemplatePath": "docs/autodoc.mustache",
That lets you can autogenerate doc-strings by typing """ at the top of your functions.
Publishing docs
Docs are published to your github pages site https://{user}.github.io/{libraryname}. The template is set up for the user munch-group, but you can substitute all its instances for your own github user name.
Run all documentation notebooks inplace by running ./docs-run-notebooks.sh. Build and render all documentation by running ./docs-build-render.sh.
Publishing conda package
Once pushed to github the library can be published as a conda package by running ./conda-release.sh.
Publishing the conda package to anaconda requires that you set up a github secret, ANACONDA_TOKEN, that you create on your anaconda.org account.
Library dependencies
Dependencies are managed in pyproject.toml and automatically read by conda-build/meta.yaml.
Entry points
Entry points are defined in pyproject.toml and automatically read by conda-build/meta.yaml.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file vscodenb-1.0.7.tar.gz.
File metadata
- Download URL: vscodenb-1.0.7.tar.gz
- Upload date:
- Size: 626.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3325a03d4a5d225eea2edcd6ad5c974f8ac8ce941736ac7b536fd3de091a10d1
|
|
| MD5 |
8f794e8bb37881c22e3aeedaec437c52
|
|
| BLAKE2b-256 |
ba8b805ff459d765b9f78291336b3a3e823f3f497bf503976b7a08d1506a12e1
|
File details
Details for the file vscodenb-1.0.7-py3-none-any.whl.
File metadata
- Download URL: vscodenb-1.0.7-py3-none-any.whl
- Upload date:
- Size: 47.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1bd4a1b755f92692c8c13aa7daa2730a685190d5c90e81b38a8a963252d6421f
|
|
| MD5 |
982a94ee00d8357a9023c98df56c2d55
|
|
| BLAKE2b-256 |
119b64dfb8e5c82a2e2b2e798f4e81a9bc48621a60b82504640f61192597604d
|
