https://github.com/djpugh/mkdocs_licenseinfo

mkdocs extension to visualise package dependencies license information
https://github.com/djpugh/mkdocs_licenseinfo

license-checking mkdocs mkdocs-plugin sbom

Last synced: about 2 months ago
JSON representation

mkdocs extension to visualise package dependencies license information

• Host: GitHub
• URL: https://github.com/djpugh/mkdocs_licenseinfo
• Owner: djpugh
• License: mit
• Created: 2023-12-23T12:02:23.000Z (almost 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-02T18:29:20.000Z (12 months ago)
• Last Synced: 2024-10-16T11:36:45.317Z (2 months ago)
• Topics: license-checking, mkdocs, mkdocs-plugin, sbom
• Language: Python
• Homepage: https://djpugh.github.io/mkdocs_licenseinfo/
• Size: 658 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# mkdocs_licenseinfo

mkdocs extension to visualise package dependencies license information

## Introduction

## Contributing

To see the contribution guidelines, see [docs/source/developing/index.md](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 --  ``

## 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 ``..``. Increment the:

* ```` version when you make incompatible API changes,

* ```` version when you add functionality in a backwards-compatible manner, and

* ```` 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 ..`` and then make sure to push that tag with ``git push origin ..``,

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``.