mkdocs-licenseinfo


Namemkdocs-licenseinfo JSON
Version 0.1.0 PyPI version JSON
download
home_page
Summarymkdocs extension to visualise package dependencies license information
upload_time2023-12-27 11:46:33
maintainer
docs_urlNone
author
requires_python>3.7
license
keywords mkdocs mkdocs-plugin license licenseinfo documentation sbom
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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 -- <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``.


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "mkdocs-licenseinfo",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">3.7",
    "maintainer_email": "David J Pugh <djpugh@gmail.com>",
    "keywords": "mkdocs,mkdocs-plugin,license,licenseinfo,documentation,sbom",
    "author": "",
    "author_email": "David J Pugh <djpugh@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/f0/4b/20ddfcf4cd25b31ace60702d349174806269765f3584ea9a54e60ebb7807/mkdocs_licenseinfo-0.1.0.tar.gz",
    "platform": null,
    "description": "# mkdocs_licenseinfo\n\n\nmkdocs extension to visualise package dependencies license information\n\n\n## Introduction\n\n\n## Contributing\n\nTo see the contribution guidelines, see [docs/source/developing/index.md](docs/source/developing/index.md).\n\n## Setting up for development\n\nCreate a virtual environment.\nInstall the package using ``pip install -e .[dev]``\n\n\nThen add code to the package as appropriate - submodules can be created under ``src/mkdocs_licenseinfo``\nTests can be added to the tests folder\n\n\n\n### CI\n\nThere are a set of CI checks:\n\n* lint: ``nox -t lint``\n* test: ``nox -t test``\n* build: ``nox -t build``\n\nspecific subfolders can be passed to the test tag in nox: ``nox -t test -- <subfolder1> <subfolder2>``\n\n\n\n\n## Versioning\n\nIt is important to track and version code, and to aid that with the python packages and models, ``setuptools_scm`` is used.\nThis links the version reported at ``__version__`` to the git tag (+ commit hash if appropriate), to reduce the amount of\nplaces that need editing when changing versions.\n\nFor describing versions we are using semantic versioning ``<major>.<minor>.<patch>``. Increment the:\n\n* ``<major>`` version when you make incompatible API changes,\n* ``<minor>`` version when you add functionality in a backwards-compatible manner, and\n* ``<patch>`` version when you make backwards-compatible bug fixes.\n\nThere are also codes for pre-releases and other descriptions (see https://semver.org/)\n\nTo create a version, use ``git tag <major>.<minor>.<patch>`` and then make sure to push that tag with ``git push origin <major>.<minor>.<patch>``,\nor an equivalent tagging tool (e.g. Github releases).\n\n\n# TODO\n\n- [ ] Add sbom file links for serving (::license-embed)\n\n\n------------\n\nRepo created from nskit.recipes.python.package:PackageRecipe (version 0.0.post1.dev15+ga59b052.d20231223) using ``nskit``.\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "mkdocs extension to visualise package dependencies license information",
    "version": "0.1.0",
    "project_urls": {
        "repository": "https://github.com/djpugh/mkdocs_licenseinfo"
    },
    "split_keywords": [
        "mkdocs",
        "mkdocs-plugin",
        "license",
        "licenseinfo",
        "documentation",
        "sbom"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "08f0dee256883470a8cf56572f7680e3e6b9587a0834a2570e3bcbeedd787148",
                "md5": "45c4884690130784951a9f68b7b7937f",
                "sha256": "b92a1f5a3caf0289dfe6d2de8cb59f00fe8c25086a50ab46d2d6073d6a134ff4"
            },
            "downloads": -1,
            "filename": "mkdocs_licenseinfo-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "45c4884690130784951a9f68b7b7937f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">3.7",
            "size": 11446,
            "upload_time": "2023-12-27T11:46:32",
            "upload_time_iso_8601": "2023-12-27T11:46:32.281358Z",
            "url": "https://files.pythonhosted.org/packages/08/f0/dee256883470a8cf56572f7680e3e6b9587a0834a2570e3bcbeedd787148/mkdocs_licenseinfo-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f04b20ddfcf4cd25b31ace60702d349174806269765f3584ea9a54e60ebb7807",
                "md5": "d9d92396e11f59a3991e72550a8e94ef",
                "sha256": "53c736d7fad3aaa707c4333f8614e9805efe68d8e50fd5b28e521f3dc6b05e31"
            },
            "downloads": -1,
            "filename": "mkdocs_licenseinfo-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d9d92396e11f59a3991e72550a8e94ef",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">3.7",
            "size": 28425,
            "upload_time": "2023-12-27T11:46:33",
            "upload_time_iso_8601": "2023-12-27T11:46:33.308743Z",
            "url": "https://files.pythonhosted.org/packages/f0/4b/20ddfcf4cd25b31ace60702d349174806269765f3584ea9a54e60ebb7807/mkdocs_licenseinfo-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-27 11:46:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "djpugh",
    "github_project": "mkdocs_licenseinfo",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mkdocs-licenseinfo"
}
        
Elapsed time: 2.79019s