Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: integrate pip compile #1042

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,18 @@ To get a database dump, please contact the TAP team.
Installing
~~~~~~~~~~

We use [pip-tools](https://github.com/jazzband/pip-tools) to manage dependencies across three files - :code:`requirements.txt`, :code:`requirements-dev.txt` and :code:`requirements-dev-jupyter.txt`. These have corresponding :code:`.in` files where we specify our top-level dependencies. With :code:`pip-tools` installed, run :code:`pip-compile requirements.in` to regenerate :code:`requirements.txt`, then run :code:`pip-compile requirements-dev.in` to regenerate :code:`requirements-dev.txt`. You can then use :code:`pip-sync requirements-dev.txt` to install all dependencies locally/for testing/etc.

.. code:: sh

$ git clone [email protected]:uktrade/tamato
$ cd tamato
$ python -m venv venv
$ source venv/bin/activate
$ pip install -U pip
$ pip install wheel -r requirements-dev.txt
$ pip install pip-tools
$ pip-compile requirements-dev.in
$ pip install -r requirements-dev.txt
$ npm install
$ npm run build

Expand Down
4 changes: 4 additions & 0 deletions requirements-dev-jupyter.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
-r requirements-dev.txt

ipython
jupyter
Loading
Loading