Skip to content

Commit

Permalink
Add README with motivation
Browse files Browse the repository at this point in the history
  • Loading branch information
chaoflow committed Jul 3, 2023
1 parent 3f4d37a commit e157413
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions examples/v1-pip-compile/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## Motivation

A project consists of multiple python packages in different subdirectories. Each
of these has dependencies and optional dev dependencies. Compiled requirements
with hashes exist, written with pip-compile:

- ``code1/pypkg1/requirements.txt``
- ``code1/pypkg1/requirements-dev.txt``

Two modes of operation:

1. Use compiled requirements files and create nix lock files accordingly.
2. Create nix lock files without using compiled requirements, but only
dependency declarations in pyproject.toml, and pip-compile afterwards for
projects not using nix.

We'd like to create environments where requirements for individual packages and
combinations of these packages are available.

For the projects' python packages:

1. Do not install, environment with requirements only.

2. Install selected packages.

3. Install selected packages in editable mode.

0 comments on commit e157413

Please sign in to comment.