Skip to content

Commit

Permalink
doc: Update intro
Browse files Browse the repository at this point in the history
  • Loading branch information
adisbladis committed Sep 24, 2024
1 parent c3d44c7 commit 53c1e54
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions doc/src/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@
Pyproject.nix is a collection of Nix utilities to work with Python project metadata in [Nix](https://nixos.org/).
It mainly targets [PEP-621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` files and data formats, but also implement support for other & legacy formats such as [Poetry](https://python-poetry.org/) & `requirements.txt`.

Pyproject.nix aims to be a swiss army knife of simple customizable utilities that works together with the [nixpkgs Python infrastructure](https://nixos.org/manual/nixpkgs/stable/#python).
Pyproject.nix aims to be a swiss army knife of simple customizable utilities that works either together with the [nixpkgs Python infrastructure](https://nixos.org/manual/nixpkgs/stable/#python), or [our own build infrastructure](./build.md).

## Foreword

This documentation only helps you to get started with `pyproject.nix`.
As it's a toolkit with many use cases not every use case can be documented fully.

First and foremost `pyproject.nix` is a _Python metadata toolkit_, and not a 2nix tool.

This documentation is centered around packaging Python applications & managing development environments.
For other use cases see the reference documentation.

Expand Down Expand Up @@ -42,7 +44,7 @@ This can be useful to check that a package set is compilant with the specificati

### [Renderers](./lib/renderers.md)

A `renderer` takes a `project` together with a Python interpreter derivation and renders it into a form understood by various pieces of nixpkgs Python infrastructure.
A `renderer` takes a `project` together with a Python interpreter derivation and renders it into a form understood by various pieces of Python infrastructure.

For example: The `buildPythonPackage` renderer returns an attribute set that can be passed to either nixpkgs function `buildPythonPackage` or `buildPythonApplication`.

Expand Down

0 comments on commit 53c1e54

Please sign in to comment.