| Name | reuse-shortcuts JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | None |
| Summary | Shortcuts Management for reuse license utility |
| upload_time | 2025-01-03 13:33:06 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | GPL-3.0-or-later |
| keywords |
reuse
licenses
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<!--
SPDX-FileCopyrightText: 2025 Helmholtz-Zentrum hereon GmbH
SPDX-License-Identifier: CC-BY-4.0
-->
# Reuse Shortcut Management
[](https://codebase.helmholtz.cloud/hcdc/reuse-shortcuts/-/pipelines?page=1&scope=all&ref=main)
[](https://codebase.helmholtz.cloud/hcdc/reuse-shortcuts/-/graphs/main/charts)
[](https://reuse-shortcuts.readthedocs.io/en/latest/)
[](https://codebase.helmholtz.cloud/hcdc/reuse-shortcuts)
[](https://pypi.python.org/pypi/reuse-shortcuts/)
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort/)
[](https://www.python.org/dev/peps/pep-0008/)
[](http://mypy-lang.org/)
[](https://api.reuse.software/info/codebase.helmholtz.cloud/hcdc/reuse-shortcuts)
Shortcuts Management for reuse license utility
## Installation
Install this package in a dedicated python environment via
```bash
python -m venv venv
source venv/bin/activate
pip install reuse-shortcuts
```
To use this in a development setup, clone the [source code][source code] from
gitlab, start the development server and make your changes::
```bash
git clone https://codebase.helmholtz.cloud/hcdc/reuse-shortcuts
cd reuse-shortcuts
python -m venv venv
source venv/bin/activate
make dev-install
```
More detailed installation instructions my be found in the [docs][docs].
[source code]: https://codebase.helmholtz.cloud/hcdc/reuse-shortcuts
[docs]: https://reuse-shortcuts.readthedocs.io/en/latest/installation.html
## Usage
Installing this package provides you with a `reuse-shortcuts` CLI executable.
When using this command in a repository, it will look for a file named
`.reuse/shortcuts.yaml` in the root of the repository. This file is supposed to
have the following format:
```yaml
<key>:
copyrights: []
years: []
licenses: []
```
where `copyrights`, `years` and `licenses` are what you would usually add with
`reuse annotate --year <year> --copyright <copyright> --license <license [further options]`, and
`<key>` is an identifier you define yourself.
Instead of calling the very verbose `reuse annotate [...] [further options]`
command, you can just run `reuse-shortcuts <key> [further options]` with the
`<key>` you defined in the `shortcuts.yaml` file.
More detailed usage instructions may be found in the [usage docs][usagedocs].
[usagedocs]: https://reuse-shortcuts.readthedocs.io/en/latest/usage.html
## Technical note
This package has been generated from the template
https://codebase.helmholtz.cloud/hcdc/software-templates/python-package-template.git.
See the template repository for instructions on how to update the skeleton for
this package.
## License information
Copyright © 2025 Helmholtz-Zentrum hereon GmbH
Code files in this repository are licensed under the
GPL-3.0-or-later, if not stated otherwise
in the file.
Documentation files in this repository are licensed under CC-BY-4.0, if not stated otherwise in the file.
Supplementary and configuration files in this repository are licensed
under CC0-1.0, if not stated otherwise
in the file.
Please check the header of the individual files for more detailed
information.
### License management
License management is handled with [``reuse``](https://reuse.readthedocs.io/).
If you have any questions on this, please have a look into the
[contributing guide][contributing] or contact the maintainers of
`reuse-shortcuts`.
[contributing]: https://reuse-shortcuts.readthedocs.io/en/latest/contributing.html
Raw data
{
"_id": null,
"home_page": null,
"name": "reuse-shortcuts",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "\"Philipp S. Sommer\" <philipp.sommer@hereon.de>",
"keywords": "reuse, licenses",
"author": null,
"author_email": "\"Philipp S. Sommer\" <philipp.sommer@hereon.de>",
"download_url": "https://files.pythonhosted.org/packages/21/13/dbd0529280ef08fe64f30eeb4a54a3256b798233cc5d0bddf1371484fcbf/reuse_shortcuts-1.0.1.tar.gz",
"platform": null,
"description": "<!--\nSPDX-FileCopyrightText: 2025 Helmholtz-Zentrum hereon GmbH\n\nSPDX-License-Identifier: CC-BY-4.0\n-->\n\n# Reuse Shortcut Management\n\n[](https://codebase.helmholtz.cloud/hcdc/reuse-shortcuts/-/pipelines?page=1&scope=all&ref=main)\n[](https://codebase.helmholtz.cloud/hcdc/reuse-shortcuts/-/graphs/main/charts)\n[](https://reuse-shortcuts.readthedocs.io/en/latest/)\n[](https://codebase.helmholtz.cloud/hcdc/reuse-shortcuts)\n[](https://pypi.python.org/pypi/reuse-shortcuts/)\n[](https://github.com/psf/black)\n[](https://pycqa.github.io/isort/)\n[](https://www.python.org/dev/peps/pep-0008/)\n[](http://mypy-lang.org/)\n[](https://api.reuse.software/info/codebase.helmholtz.cloud/hcdc/reuse-shortcuts)\n\n\nShortcuts Management for reuse license utility\n\n## Installation\n\nInstall this package in a dedicated python environment via\n\n```bash\npython -m venv venv\nsource venv/bin/activate\npip install reuse-shortcuts\n```\n\nTo use this in a development setup, clone the [source code][source code] from\ngitlab, start the development server and make your changes::\n\n```bash\ngit clone https://codebase.helmholtz.cloud/hcdc/reuse-shortcuts\ncd reuse-shortcuts\npython -m venv venv\nsource venv/bin/activate\nmake dev-install\n```\n\nMore detailed installation instructions my be found in the [docs][docs].\n\n\n[source code]: https://codebase.helmholtz.cloud/hcdc/reuse-shortcuts\n[docs]: https://reuse-shortcuts.readthedocs.io/en/latest/installation.html\n\n\n## Usage\n\nInstalling this package provides you with a `reuse-shortcuts` CLI executable.\nWhen using this command in a repository, it will look for a file named\n`.reuse/shortcuts.yaml` in the root of the repository. This file is supposed to\nhave the following format:\n\n```yaml\n<key>:\n copyrights: []\n years: []\n licenses: []\n```\n\nwhere `copyrights`, `years` and `licenses` are what you would usually add with\n`reuse annotate --year <year> --copyright <copyright> --license <license [further options]`, and\n`<key>` is an identifier you define yourself.\n\nInstead of calling the very verbose `reuse annotate [...] [further options]`\ncommand, you can just run `reuse-shortcuts <key> [further options]` with the\n`<key>` you defined in the `shortcuts.yaml` file.\n\nMore detailed usage instructions may be found in the [usage docs][usagedocs].\n\n[usagedocs]: https://reuse-shortcuts.readthedocs.io/en/latest/usage.html\n\n## Technical note\n\nThis package has been generated from the template\nhttps://codebase.helmholtz.cloud/hcdc/software-templates/python-package-template.git.\n\nSee the template repository for instructions on how to update the skeleton for\nthis package.\n\n\n## License information\n\nCopyright \u00a9 2025 Helmholtz-Zentrum hereon GmbH\n\n\n\nCode files in this repository are licensed under the\nGPL-3.0-or-later, if not stated otherwise\nin the file.\n\nDocumentation files in this repository are licensed under CC-BY-4.0, if not stated otherwise in the file.\n\nSupplementary and configuration files in this repository are licensed\nunder CC0-1.0, if not stated otherwise\nin the file.\n\nPlease check the header of the individual files for more detailed\ninformation.\n\n\n\n### License management\n\nLicense management is handled with [``reuse``](https://reuse.readthedocs.io/).\nIf you have any questions on this, please have a look into the\n[contributing guide][contributing] or contact the maintainers of\n`reuse-shortcuts`.\n\n[contributing]: https://reuse-shortcuts.readthedocs.io/en/latest/contributing.html\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Shortcuts Management for reuse license utility",
"version": "1.0.1",
"project_urls": {
"Documentation": "https://reuse-shortcuts.readthedocs.io/en/latest/",
"Homepage": "https://codebase.helmholtz.cloud/hcdc/reuse-shortcuts",
"Source": "https://codebase.helmholtz.cloud/hcdc/reuse-shortcuts",
"Tracker": "https://codebase.helmholtz.cloud/hcdc/reuse-shortcuts/issues/"
},
"split_keywords": [
"reuse",
" licenses"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5d5f47b01213d2fadac62723dc41a35c5d8acc9140c2151de5661187b4a0a8c0",
"md5": "5117129d94eb57d40ed4d151319618e6",
"sha256": "aa371f9b355d86148e7ac14c280efb5555ffd76151f6e0abe8fe620a443e0bea"
},
"downloads": -1,
"filename": "reuse_shortcuts-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5117129d94eb57d40ed4d151319618e6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 26606,
"upload_time": "2025-01-03T13:33:03",
"upload_time_iso_8601": "2025-01-03T13:33:03.654423Z",
"url": "https://files.pythonhosted.org/packages/5d/5f/47b01213d2fadac62723dc41a35c5d8acc9140c2151de5661187b4a0a8c0/reuse_shortcuts-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2113dbd0529280ef08fe64f30eeb4a54a3256b798233cc5d0bddf1371484fcbf",
"md5": "9e171a71584b6333c4ef54779360c81e",
"sha256": "4587f335c6d067d4e3b92661f7ed306a18afbfde7424c5d52987f40c0f55cbd9"
},
"downloads": -1,
"filename": "reuse_shortcuts-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "9e171a71584b6333c4ef54779360c81e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 25719,
"upload_time": "2025-01-03T13:33:06",
"upload_time_iso_8601": "2025-01-03T13:33:06.366688Z",
"url": "https://files.pythonhosted.org/packages/21/13/dbd0529280ef08fe64f30eeb4a54a3256b798233cc5d0bddf1371484fcbf/reuse_shortcuts-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-03 13:33:06",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "reuse-shortcuts"
}
