diff options
| author | adamjanovsky | 2022-04-04 18:01:25 +0200 |
|---|---|---|
| committer | GitHub | 2022-04-04 18:01:25 +0200 |
| commit | b0e4e9ed1a25f163dab45980cc5a32bcb0dacee9 (patch) | |
| tree | 052eb8b6bdae4ac3c9ff1c89a5e469bce8ba01c6 /CONTRIBUTING.md | |
| parent | 7df07064bb0deb4deb51d7cf6ad3e9717a4a5edc (diff) | |
| download | sec-certs-b0e4e9ed1a25f163dab45980cc5a32bcb0dacee9.tar.gz sec-certs-b0e4e9ed1a25f163dab45980cc5a32bcb0dacee9.tar.zst sec-certs-b0e4e9ed1a25f163dab45980cc5a32bcb0dacee9.zip | |
Refactor/pdftotext as library (#183)
- Update Docker Ubuntu to 22.04
- Test pipeline now installs fresh Poppler
- Poppler-utils package no longer needed
- Paragraph on project dependencies added to CONTRIBUTING.md
- Pdftotext is no longer called with subprocess call, but API is leveraged instead
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 10094a99..9ce96222 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,10 +4,20 @@ You contribution is warmly welcomed. You can help by: 0. Spread the word about this project, look at generated processed webpages 1. Trying the tool and reporting issues and suggestions for improvement (open Github issue) - 2. Add new regular expressions to extract relevant information from certificates (update cert_rules.py) + 2. Add new regular expressions to extract relevant information from certificates (update cert_rules.py) 3. Perform additional analysis with extracted data (analyze_certificates.py) 3. Improve the code (TODO: Follow Github contribution guidelines, ideally contact us first about your plan) +## Dependencies + +Our [Dockerfile](https://github.com/crocs-muni/sec-certs/blob/main/docker/Dockerfile) presents all the required dependencies, elaborated below. + +- [Java](https://www.java.com/en) is needed to parse tables in FIPS pdf documents, must be available from `PATH`. +- Some imported libraries have non-trivial dependencies to resolve: + - [pdftotext](https://github.com/jalan/pdftotext) requires [Poppler](https://poppler.freedesktop.org/) to be installed. We've experienced issues with older versions of Poppler (`0.x`), make sure to install `20.x` version of these libraries. + - [graphviz](https://pypi.org/project/graphviz/) requires `graphviz` to be on the path +- + ## Branches and releases - `main` is the default branch against which all pull requests are to be made. This branch is not neccessarily stable, only the releases are. @@ -23,7 +33,7 @@ All commits shall pass the lint pipeline of the following tools: - isort (see [pyproject.toml](https://github.com/crocs-muni/sec-certs/blob/dev/pyproject.toml) for settings) - Flake8 (see [.flake8](https://github.com/crocs-muni/sec-certs/blob/dev/.flake8) for settings) -These tools can be installed via [dev_requirements.txt](https://github.com/crocs-muni/sec-certs/blob/dev/dev_requirements.txt) You can use [pre-commit](https://pre-commit.com/) tool 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. +These tools can be installed via [dev_requirements.txt](https://github.com/crocs-muni/sec-certs/blob/dev/dev_requirements.txt) You can use [pre-commit](https://pre-commit.com/) tool 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: |
