diff options
| author | Adam Janovsky | 2022-12-10 10:02:12 +0100 |
|---|---|---|
| committer | Adam Janovsky | 2022-12-10 10:02:12 +0100 |
| commit | 570665cc82f00eb92f0980fc562b28af18fdca65 (patch) | |
| tree | dbd8f7a942ddf77ce9601f9152f469f146304bdb | |
| parent | 1ce496a783cdbd7bd471e758ca4ad80a667dbefc (diff) | |
| download | sec-certs-570665cc82f00eb92f0980fc562b28af18fdca65.tar.gz sec-certs-570665cc82f00eb92f0980fc562b28af18fdca65.tar.zst sec-certs-570665cc82f00eb92f0980fc562b28af18fdca65.zip | |
update pypi action
| -rw-r--r-- | Dockerfile | 3 | ||||
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | docs/installation.md | 2 | ||||
| -rw-r--r-- | docs/quickstart.md | 4 | ||||
| -rw-r--r-- | pyproject.toml | 1 |
5 files changed, 7 insertions, 5 deletions
@@ -48,7 +48,8 @@ RUN \ pip3 install wheel && \ pip3 install -r requirements/requirements.txt && \ pip3 install --no-cache notebook jupyterlab && \ - pip3 install -e . + pip3 install -e . && \ + python3 -m spacy download en_core_web_sm # #just to be sure that pdftotext is in $PATH ENV PATH /usr/bin/pdftotext:${PATH} @@ -14,7 +14,7 @@ A tool for data scraping and analysis of security certificates from Common Crite ## Installation -Use Docker with `docker pull seccerts/sec-certs` or just `pip install -U sec-certs`. For more elaborate description, see [docs](https://seccerts.org/docs/installation.html). +Use Docker with `docker pull seccerts/sec-certs` or just `pip install -U sec-certs && python -m spacy download en_core_web_sm`. For more elaborate description, see [docs](https://seccerts.org/docs/installation.html). ## Usage diff --git a/docs/installation.md b/docs/installation.md index 741bd72e..7a119f62 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -7,6 +7,7 @@ The tool can be installed from PyPi with ```bash pip install -U sec-certs +python -m spacy download en_core_web_sm ``` Note, that `Python>=3.8` is required. @@ -31,6 +32,7 @@ git clone https://github.com/crocs-muni/sec-certs.git python3 -m venv venv source venv/bin/activate pip install -e . +python -m spacy download en_core_web_sm ``` Alternatively, our Our [Dockerfile](https://github.com/crocs-muni/sec-certs/blob/main/Dockerfile) represents a reproducible way of setting up the environment. diff --git a/docs/quickstart.md b/docs/quickstart.md index 57033259..d916bc5a 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -3,7 +3,7 @@ ::::{tab-set} :::{tab-item} Common Criteria -1. Install the latest version with `pip install -U sec-certs` (see [installation](installation.md)). +1. Install the latest version with `pip install -U sec-certs && python -m spacy download en_core_web_sm` (see [installation](installation.md)). 2. In your Python interpreter, type ```python from sec_certs.dataset import CCDataset @@ -16,7 +16,7 @@ to obtain to obtain freshly processed dataset from [seccerts.org](https://seccer ::: :::{tab-item} FIPS 140 -1. Install the latest version with `pip install -U sec-certs` (see [installation](installation.md)). +1. Install the latest version with `pip install -U sec-certs && python -m spacy download en_core_web_sm` (see [installation](installation.md)). 2. In your Python interpreter, type ```python from sec_certs.dataset import FIPSDataset diff --git a/pyproject.toml b/pyproject.toml index 266b4dd5..5948f79a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -53,7 +53,6 @@ "ipykernel", "ipywidgets", "spacy", - "en_core_web_sm @ https://github.com/explosion/spacy-models/releases/download/en_core_web_sm-3.4.1/en_core_web_sm-3.4.1.tar.gz", "pkgconfig", "seaborn", "pySankeyBeta", |