Merge pull request #297 from crocs-muni/fix/pypi-action

update release on pypi action

.github/workflows/release.yml

@@ -22,7 +22,7 @@ jobs:
         shell: bash -l {0}
         run: python -m build
       - name: Publish package to PyPI
-        uses: pypa/gh-action-pypi-publish@master
+        uses: pypa/gh-action-pypi-publish@release/v1
         with:
           user: ${{ secrets.PYPI_USERNAME }}
           password: ${{ secrets.PYPI_PASSWORD }}

Dockerfile

@@ -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}

README.md

@@ -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
 

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.

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

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",