hiro/poetry2nix
1
0
Fork 0
mirror of https://github.com/vale981/poetry2nix synced 2025-03-04 16:51:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add docs for dependencyEnv passthru

Browse source
This commit is contained in:
Silvan Mosberger 2020-05-08 22:03:04 +02:00
parent 08da79595a
commit a371e771f1
No known key found for this signature in database
GPG key ID: E8F1E9EAD284E17D
1 changed files with 23 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -38,6 +38,29 @@ poetry2nix.mkPoetryApplication {
See [./pkgs/poetry/default.nix](./pkgs/poetry/default.nix) for a working example.
#### Dependency environment
The resulting derivation also has the passthru attribute `dependencyEnv`, which is an environment with a python interpreter, all non-development dependencies and your application.
This can be used if your application doesn't provide any binaries on its own and instead relies on dependencies binaries to call its modules (as is often the case with `celery` or `gunicorn`).
For example, if your application defines a CLI for the module `admin` and a gunicorn app for the module `web`, a working `default.nix` would contain
```nix
let
app = poetry2nix.mkPoetryApplication {
projectDir = ./.;
};
in app.dependencyEnv
```
After building this expression, your CLI and app can be called with these commands
```shell
$ result/bin/python -m admin
$ result/bin/gunicorn web:app
```
Note: If you need to perform overrides on the application, use `app.dependencyEnv.override { app = app.override { ... }; }`. See [./tests/dependency-environment/default.nix](./tests/dependency-environment/default.nix) for a full example.
### mkPoetryEnv
Creates an environment that provides a Python interpreter along with all dependencies declared by the designated poetry project and lock files. `mkPoetryEnv` takes an attribute set with the following attributes (attributes without default are mandatory):