Awesome
crlbuilder
A Python library for creating and signing X.509 certificate revocation lists (CRLs).
- Related Crypto Libraries
- Current Release
- Dependencies
- Installation
- License
- Documentation
- Continuous Integration
- Testing
- Development
- CI Tasks
Related Crypto Libraries
crlbuilder is part of the modularcrypto family of Python packages:
Current Release
0.10.2 - changelog
Dependencies
- asn1crypto
- oscrypto
- Python 2.6, 2.7, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9 or pypy
Installation
pip install crlbuilder
License
crlbuilder is licensed under the terms of the MIT license. See the LICENSE file for the exact license text.
Documentation
Continuous Integration
- macOS, Linux, Windows via GitHub Actions
- arm64 via CircleCI
Testing
Tests are written using unittest
and require no third-party packages.
Depending on what type of source is available for the package, the following commands can be used to run the test suite.
Git Repository
When working within a Git working copy, or an archive of the Git repository, the full test suite is run via:
python run.py tests
To run only some tests, pass a regular expression as a parameter to tests
.
python run.py tests build
PyPi Source Distribution
When working within an extracted source distribution (aka .tar.gz
) from
PyPi, the full test suite is run via:
python setup.py test
Development
To install the package used for linting, execute:
pip install --user -r requires/lint
The following command will run the linter:
python run.py lint
Support for code coverage can be installed via:
pip install --user -r requires/coverage
Coverage is measured by running:
python run.py coverage
To install the packages requires to generate the API documentation, run:
pip install --user -r requires/api_docs
The documentation can then be generated by running:
python run.py api_docs
To change the version number of the package, run:
python run.py version {pep440_version}
To install the necessary packages for releasing a new version on PyPI, run:
pip install --user -r requires/release
Releases are created by:
-
Making a git tag in PEP 440 format
-
Running the command:
python run.py release
Existing releases can be found at https://pypi.org/project/crlbuilder.
CI Tasks
A task named deps
exists to ensure a modern version of pip
is installed,
along with all necessary testing dependencies.
The ci
task runs lint
(if flake8 is avaiable for the version of Python) and
coverage
(or tests
if coverage is not available for the version of Python).
If the current directory is a clean git working copy, the coverage data is
submitted to codecov.io.
python run.py deps
python run.py ci