Skip to content

Commit

Permalink
introduce all_requirements.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
adamjanovsky committed Oct 18, 2023
1 parent 9596801 commit d67361d
Show file tree
Hide file tree
Showing 9 changed files with 574 additions and 21 deletions.
1 change: 0 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ jobs:
run: sudo apt-get install build-essential libpoppler-cpp-dev pkg-config python3-dev -y
- name: Install sec-certs and deps
run: |
pip install -r requirements/requirements.txt
pip install -r requirements/dev_requirements.txt
pip install -e .
- name: Build docs
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,9 @@ jobs:
python-version: "3.8"
cache: "pip"
cache-dependency-path: |
requirements/requirements.txt
requirements/test_requirements.txt
- name: Install python dependencies
run: |
pip install -r requirements/requirements.txt
pip install -r requirements/test_requirements.txt
- name: Install sec-certs
run: |
Expand Down
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Requirements are maintained with [pip-tools](https://github.com/jazzband/pip-too
- List actual dependencies in [pyproject.toml](https://github.com/crocs-muni/sec-certs/blob/main/pyproject.toml) without pinning them.
- Additionally, [compile.sh](https://github.com/crocs-muni/sec-certs/blob/main/requirements/compile.sh) script is used to compile pinned versions of requirements that reside in `.txt` files in the same folder.
- Tests, linting and Docker all run against this reproducible environment of pinned requirements.
- To install all requirements, use `pip install -U pip-tools && pip-sync requirements/all_requirements.txt`

## Branches

Expand Down Expand Up @@ -67,4 +68,4 @@ To ivoke the tools manually, you can, in the repository root, use:
Every public method of a module that can be leveraged as an API by user should be documented. The docstrng style should
be `sphinx-oneline`.

The documentation is built using `sphinx` with `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.
The documentation is built using `sphinx` with `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.
9 changes: 4 additions & 5 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,14 @@ ENV PATH="${VENV_PATH}/bin:$PATH"

# Install dependencies, notebook is because of mybinder.org
RUN \
pip3 install -U pip && \
pip3 install wheel && \
pip3 install -r requirements/requirements.txt && \
pip3 install -U pip wheel pip-tools && \
pip-sync requirements/all_requirements.txt && \
pip3 install --no-cache notebook jupyterlab && \
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}

# # Run the application:
# CMD ["python3", "./cc_cli.py"]
# Run the application:
ENTRYPOINT ["sec-certs"]
Loading

0 comments on commit d67361d

Please sign in to comment.