mkdocs extension to visualise package dependencies license information
Project description
mkdocs_licenseinfo
mkdocs extension to visualise package dependencies license information
Introduction
Contributing
To see the contribution guidelines, see docs/source/developing/index.md.
Setting up for development
Create a virtual environment.
Install the package using pip install -e .[dev]
Then add code to the package as appropriate - submodules can be created under src/mkdocs_licenseinfo
Tests can be added to the tests folder
CI
There are a set of CI checks:
- lint:
nox -t lint
- test:
nox -t test
- build:
nox -t build
specific subfolders can be passed to the test tag in nox: nox -t test -- <subfolder1> <subfolder2>
Versioning
It is important to track and version code, and to aid that with the python packages and models, setuptools_scm
is used.
This links the version reported at __version__
to the git tag (+ commit hash if appropriate), to reduce the amount of
places that need editing when changing versions.
For describing versions we are using semantic versioning <major>.<minor>.<patch>
. Increment the:
<major>
version when you make incompatible API changes,<minor>
version when you add functionality in a backwards-compatible manner, and<patch>
version when you make backwards-compatible bug fixes.
There are also codes for pre-releases and other descriptions (see https://semver.org/)
To create a version, use git tag <major>.<minor>.<patch>
and then make sure to push that tag with git push origin <major>.<minor>.<patch>
,
or an equivalent tagging tool (e.g. Github releases).
TODO
- Add sbom file links for serving (::license-embed)
Repo created from nskit.recipes.python.package:PackageRecipe (version 0.0.post1.dev15+ga59b052.d20231223) using nskit
.
Project details
Release history Release notifications | RSS feed
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
Hashes for mkdocs_licenseinfo-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b92a1f5a3caf0289dfe6d2de8cb59f00fe8c25086a50ab46d2d6073d6a134ff4 |
|
MD5 | 45c4884690130784951a9f68b7b7937f |
|
BLAKE2b-256 | 08f0dee256883470a8cf56572f7680e3e6b9587a0834a2570e3bcbeedd787148 |