Skip to content

Commit 02d07a2

Browse files
committed
Add README with motivation
1 parent c01ceb7 commit 02d07a2

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

examples/v1-pip-compile/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Motivation
2+
3+
A project consists of multiple python packages in different subdirectories. Each
4+
of these has dependencies and optional dev dependencies. Compiled requirements
5+
with hashes exist, written with pip-compile:
6+
7+
- ``code1/pypkg1/requirements.txt``
8+
- ``code1/pypkg1/requirements-dev.txt``
9+
10+
Two modes of operation:
11+
12+
1. Use compiled requirements files and create nix lock files accordingly.
13+
2. Create nix lock files without using compiled requirements, but only
14+
dependency declarations in pyproject.toml, and pip-compile afterwards for
15+
projects not using nix.
16+
17+
We'd like to create environments where requirements for individual packages and
18+
combinations of these packages are available.
19+
20+
For the projects' python packages:
21+
22+
1. Do not install, environment with requirements only.
23+
24+
2. Install selected packages.
25+
26+
3. Install selected packages in editable mode.

0 commit comments

Comments
 (0)