| Name | burocrata JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | |
| Summary | Check and insert copyright and license notices into source code |
| upload_time | 2024-03-04 12:05:48 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
license
development
copyright
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# Burocrata: Check and insert copyright and license notices into source code
Part of the [Fatiando a Terra][fatiando] project.
[][pypi]
[][conda-forge]
[][coverage]
[][pypi]
## About
*Burocrata* is a small command-line program that can check the existence of
copyright and license notices in source code files and add them when they are
missing.
## Installing
*Burocrata* is available from PyPI:
```
python -m pip install burocrata
```
and conda-forge:
```
conda install burocrata -c conda-forge
```
## Using
Check that very `.py` file in a directory has a license notice:
```
$ burocrata --check --extension=py source_folder
```
Removing the `--check` option will make Burocrata add the license notice to
the files that don't have them:
```
$ burocrata --extension=py source_folder
```
The license and copyright notice can be configured in a `pyproject.toml` file
located in the directory where `burocrata` is run:
```
$ cat pyproject.toml
[tool.burocrata]
notice = '''
# Copyright (c) YYYY Name of Developer.
# Distributed under the terms of the BSD 3-Clause License.
# SPDX-License-Identifier: BSD-3-Clause'''
```
See a full list of options:
```
$ burocrata --help
```
## Dependencies
We use the following dependencies (see `pyproject.toml` for specific version
constraints):
* [click](https://click.palletsprojects.com) for building the command-line
interface.
* [tomli](https://github.com/hukkin/tomli) to parse the TOML configuration
files.
* [pathspec](https://github.com/cpburnz/python-pathspec) to parse `.gitignore`
files.
## Contacting Us
Find out more about how to reach us at
[fatiando.org/contact][contact]
## Contributing
### Code of conduct
Please note that this project is released with a [Code of Conduct][coc].
By participating in this project you agree to abide by its terms.
### Contributing Guidelines
Please read our
[Contributing Guide][contrib]
to see how you can help and give feedback.
## License
Burocrata is free and open-source software distributed under the
[MIT License][license].
[pypi]: https://pypi.org/project/burocrata/
[conda-forge]: https://github.com/conda-forge/burocrata-feedstock
[coverage]: https://app.codecov.io/gh/fatiando/burocrata
[license]: https://github.com/fatiando/burocrata/blob/main/LICENSE.txt
[contrib]: https://github.com/fatiando/burocrata/blob/main/CONTRIBUTING.md
[coc]: https://github.com/fatiando/community/blob/main/CODE_OF_CONDUCT.md
[fatiando]: https://www.fatiando.org
[contact]: https://www.fatiando.org/contact
Raw data
{
"_id": null,
"home_page": "",
"name": "burocrata",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Leonardo Uieda <leo@uieda.com>",
"keywords": "license,development,copyright",
"author": "",
"author_email": "The Burocrata Developers <fatiandoaterra@protonmail.com>",
"download_url": "https://files.pythonhosted.org/packages/6d/ee/0e04573044210f766049006dfe383ce98f1385a79b029cc58097381782d1/burocrata-0.2.0.tar.gz",
"platform": null,
"description": "# Burocrata: Check and insert copyright and license notices into source code\n\nPart of the [Fatiando a Terra][fatiando] project.\n\n[][pypi]\n[][conda-forge]\n[][coverage]\n[][pypi]\n\n## About\n\n*Burocrata* is a small command-line program that can check the existence of\ncopyright and license notices in source code files and add them when they are\nmissing.\n\n## Installing\n\n*Burocrata* is available from PyPI:\n\n```\npython -m pip install burocrata\n```\n\nand conda-forge:\n\n```\nconda install burocrata -c conda-forge\n```\n\n## Using\n\nCheck that very `.py` file in a directory has a license notice:\n\n```\n$ burocrata --check --extension=py source_folder\n```\n\nRemoving the `--check` option will make Burocrata add the license notice to\nthe files that don't have them:\n\n```\n$ burocrata --extension=py source_folder\n```\n\nThe license and copyright notice can be configured in a `pyproject.toml` file\nlocated in the directory where `burocrata` is run:\n\n```\n$ cat pyproject.toml\n[tool.burocrata]\nnotice = '''\n# Copyright (c) YYYY Name of Developer.\n# Distributed under the terms of the BSD 3-Clause License.\n# SPDX-License-Identifier: BSD-3-Clause'''\n```\n\nSee a full list of options:\n\n```\n$ burocrata --help\n```\n\n## Dependencies\n\nWe use the following dependencies (see `pyproject.toml` for specific version\nconstraints):\n\n* [click](https://click.palletsprojects.com) for building the command-line\n interface.\n* [tomli](https://github.com/hukkin/tomli) to parse the TOML configuration\n files.\n* [pathspec](https://github.com/cpburnz/python-pathspec) to parse `.gitignore`\n files.\n\n## Contacting Us\n\nFind out more about how to reach us at\n[fatiando.org/contact][contact]\n\n## Contributing\n\n### Code of conduct\n\nPlease note that this project is released with a [Code of Conduct][coc].\nBy participating in this project you agree to abide by its terms.\n\n### Contributing Guidelines\n\nPlease read our\n[Contributing Guide][contrib]\nto see how you can help and give feedback.\n\n## License\n\nBurocrata is free and open-source software distributed under the\n[MIT License][license].\n\n[pypi]: https://pypi.org/project/burocrata/\n[conda-forge]: https://github.com/conda-forge/burocrata-feedstock\n[coverage]: https://app.codecov.io/gh/fatiando/burocrata\n[license]: https://github.com/fatiando/burocrata/blob/main/LICENSE.txt\n[contrib]: https://github.com/fatiando/burocrata/blob/main/CONTRIBUTING.md\n[coc]: https://github.com/fatiando/community/blob/main/CODE_OF_CONDUCT.md\n[fatiando]: https://www.fatiando.org\n[contact]: https://www.fatiando.org/contact\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Check and insert copyright and license notices into source code",
"version": "0.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/fatiando/burocrata/issues",
"Changelog": "https://github.com/fatiando/burocrata/blob/main/CHANGELOG.md",
"Homepage": "https://github.com/fatiando/burocrata",
"Source Code": "https://github.com/fatiando/burocrata"
},
"split_keywords": [
"license",
"development",
"copyright"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "829f2500ef06d21dd18711555bbdf1c658fb5beed7b6ca21a0882310794e2ed2",
"md5": "fef07f36572911db2b56743a60fdcf06",
"sha256": "1b33a194a06fe88fbcb68eed76c4ff7cb562be39730c5f00417e3f03fd53513e"
},
"downloads": -1,
"filename": "burocrata-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fef07f36572911db2b56743a60fdcf06",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7076,
"upload_time": "2024-03-04T12:05:47",
"upload_time_iso_8601": "2024-03-04T12:05:47.455667Z",
"url": "https://files.pythonhosted.org/packages/82/9f/2500ef06d21dd18711555bbdf1c658fb5beed7b6ca21a0882310794e2ed2/burocrata-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6dee0e04573044210f766049006dfe383ce98f1385a79b029cc58097381782d1",
"md5": "744158a63aff1bbe7b5a46302377896d",
"sha256": "75118b093c7373dbf67343afa35e8fb748200d5fd103ef972e71fb4d285ce22f"
},
"downloads": -1,
"filename": "burocrata-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "744158a63aff1bbe7b5a46302377896d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7606,
"upload_time": "2024-03-04T12:05:48",
"upload_time_iso_8601": "2024-03-04T12:05:48.461716Z",
"url": "https://files.pythonhosted.org/packages/6d/ee/0e04573044210f766049006dfe383ce98f1385a79b029cc58097381782d1/burocrata-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-04 12:05:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fatiando",
"github_project": "burocrata",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "burocrata"
}
