mirror of
https://github.com/nix-community/dream2nix.git
synced 2024-11-23 00:13:02 +03:00
docs/pip: Add intro to README
This commit is contained in:
parent
a7ebf95ad4
commit
00ccd3da76
@ -5,4 +5,26 @@ maintainers:
|
||||
- phaer
|
||||
---
|
||||
|
||||
Python packaging via [pip](https://pip.pypa.io/).
|
||||
A module to package python projects via [pip](https://pip.pypa.io/).
|
||||
|
||||
Under the hood, it uses [./pkgs/fetchPipMetadata](https://github.com/nix-community/dream2nix/tree/main/pkgs/fetchPipMetadata) to
|
||||
run `pip install --dry-run --report [...]` with reproducible inputs and converts the resulting installation report into a dream2nix
|
||||
lock file.
|
||||
|
||||
!!! note
|
||||
|
||||
Due to limitations in `pip`s cross-platform support, the resulting
|
||||
lock-files are platform-specific!
|
||||
We therefore recommend setting `paths.lockFile` to `lock.${system}.json`
|
||||
for all projects where you use the pip module.
|
||||
|
||||
Check out the [pdm module](../WIP-python-pdm/index.md) if you need a solution that
|
||||
allows locking for multiple platforms at once!
|
||||
|
||||
During building, it uses this lock file to build each dependency as well as the top-level package in separate derivations
|
||||
while allowing overrides and further customization via [dream2nix module system](../../modules.md).
|
||||
|
||||
## Getting started
|
||||
|
||||
See [Build a python project with pip](../../guides/pip.md).
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user