You contribution is warmly welcomed. You can help by:
Spread the word about this project, look at generated processed webpages
Trying the tool and reporting issues and suggestions for improvement (open Github issue)
Add new regular expressions to extract relevant information from certificates (update cert_rules.py)
Perform additional analysis with extracted data (analyze_certificates.py)
Improve the code (TODO: Follow Github contribution guidelines, ideally contact us first about your plan)
For complete list of system dependencies, see docs/installation.
Requirements are maintained with pip-tools. The main ideas are:
List actual dependencies in pyproject.toml without pinning them.
Additionally, compile.sh script is used to compile pinned versions of requirements that reside in
.txtfiles in the same folder.
Tests, linting and Docker all run against this reproducible environment of pinned requirements.
main is the default branch against which all pull requests are to be made. This branch is not neccessarily stable, only the releases are.
Releases and version strings#
Version string is not indexed in
gitbut can be retreived maintained by
setuptools-scmfrom git tags instead.
setuptools-scmwill automatically, upon editable/real install of a package, infer its version and write it to
sec_certs/_version.py. This file is not indexed as well. See more at setuptools-scm GitHub
On publishing a release, the tool is automatically published to PyPi and DockerHub.
Note on single-sourcing the package version: More can be read here. The downside of our approach is that
.git folder and editable/real install is needed to infer the version of the package. Releases can be infered without installing the project.
Currently, the release process is as follows#
Update dependencies with
pre-commit autoupdate, pin new versions of linters into
cd requirements && ./compile.sh.
Create a release from GitHub UI. Include release notes, add proper version tag and publish the release (or create it from scratch with new tag).
This will automatically update PyPi and DockerHub packages.
All commits shall pass the lint pipeline of the following tools:
Mypy (see pyproject.toml for settings)
Black (see pyproject.toml for settings)
Ruff (see pyproject.toml for settings)
These tools can be installed via dev_requirements.txt You can use pre-commit tool to register git hook that will evalute these checks prior to any commit and abort the commit for you. Note that the pre-commit is not meant to automatically fix the issues, just warn you.
It should thus suffice to:
pip3 install -r ./dev_requirements.txt && pre-commit install && pre-commit run --all-files
To ivoke the tools manually, you can, in the repository root, use:
black --check .(without the flag to reformat)
ruff ." (or with–fix` flag to apply fixes)
Every public method of a module that can be leveraged as an API by user should be documented. The docstrng style should
The documentation is built using
mnyst extension that allows for markdown files. Folder
notebooks/examples is symbolically linked to
/docs and its contents will be automatically parsed. These notebooks are supposed to be runnable from Binder.