Burocrata: Check and insert copyright and license notices into source code
Part of the Fatiando a Terra project.
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'''
exclude = ["__init__.py"]
See a full list of options:
$ burocrata --help
Dependencies
We use the following dependencies (see pyproject.toml for specific version
constraints):
- click for building the command-line interface.
- tomli to parse the TOML configuration files.
- pathspec to parse
.gitignorefiles.
Contacting Us
Find out more about how to reach us at fatiando.org/contact
Contributing
Code of conduct
Please note that this project is released with a Code of Conduct. By participating in this project you agree to abide by its terms.
Contributing Guidelines
Please read our Contributing Guide to see how you can help and give feedback.
License
Burocrata is free and open-source software distributed under the MIT License.
Metadata
Release files for burocrata 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| burocrata-0.3.0.tar.gz | 8.3 kB | With provenance | Details for burocrata-0.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| burocrata-0.3.0-py3-none-any.whl | Python 3 | none | any | Details for burocrata-0.3.0-py3-none-any.whl |
Total release size: 15.5 kB
Release files / burocrata-0.3.0.tar.gz
| Download URL | burocrata-0.3.0.tar.gz |
|---|---|
| Size | 8.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b63c1e7e75b926a972788c8a8b3c98d84deee9a0989f3c874597c8c03763e9b8
|
|
BLAKE2b-256 checksum How to use checksums |
336a42bd68870fea095ee63cedf136572bb8b46c79898a959ef3df4402d34f2a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 14, 2025.
Transparency logRelease files / burocrata-0.3.0-py3-none-any.whl
| Download URL | burocrata-0.3.0-py3-none-any.whl |
|---|---|
| Size | 7.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
710b80730e32a56c976791053f4ae9e19f304da4c64bb0d1f0e676e30579ab37
|
|
BLAKE2b-256 checksum How to use checksums |
2546ff737301f33789037c87eac307537fc6cd7ac7f305d749aa3b87cc67ee03
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 14, 2025.
Transparency logSecurity for burocrata 0.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for burocrata-0.3.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 14, 2025.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.