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 mkPoetryEnv shell.nix examples to README

Browse source 
It took me a while to figure this out, so I think it may be useful to add as a reference to future `poetry2nix` users.

Related to and inspired by #186, #60.
This commit is contained in:
Kyle Gentle 2020-12-13 12:44:27 -05:00 • committed by GitHub
parent fd0e5772e6
commit f70ffaa7ef
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -91,6 +91,38 @@ poetry2nix.mkPoetryEnv {
See [./tests/editable/default.nix](./tests/editable/default.nix) for a working example of an editable package.
#### Example shell.nix
The `env` attribute of the attribute set created by `mkPoetryEnv` contains a shell environment.
```nix
{ pkgs ? import <nixpkgs> {} }:
let
myAppEnv = poetry2nix.mkPoetryEnv {
projectDir = ./.;
editablePackageSources = {
my-app = ./src;
};
};
in myAppEnv.env
```
#### Example shell.nix with external dependencies
For a shell environment including external dependencies, pass the app environment and dependency packages (for example, `pkgs.hello`) as build inputs to `pkgs.mkShell`.
```nix
{ pkgs ? import <nixpkgs> {} }:
let
myAppEnv = poetry2nix.mkPoetryEnv {
projectDir = ./.;
editablePackageSources = {
my-app = ./src;
};
};
in
pkgs.mkShell {
buildInputs = [ myAppEnv pkgs.hello ];
}
```
### mkPoetryPackages
Creates an attribute set of the shape `{ python, poetryPackages, pyProject, poetryLock }`. Where `python` is the interpreter specified, `poetryPackages` is a list of all generated python packages, `pyProject` is the parsed `pyproject.toml` and `poetryLock` is the parsed `poetry.lock` file. `mkPoetryPackages` takes an attribute set with the following attributes (attributes without default are mandatory):