README.md

Nest 🪺

Python Package Index in rust 🦀

Getting Started

To run the server locally, first run postgres instance with docker-compose up db -d.

Then you can initialize the database by running sqlx migrations.

sqlx database create -D postgres://nest-user:nest-secret@localhost:5432/nest
sqlx migrate run -D postgres://nest-user:nest-secret@localhost:5432/nest

Then run the server with cargo run.

You can install Bunyan to get human readable logs cargo run | bunyan

You can test the server with the python's test module in the folder my-module.

To upload a package, you will first need an account. You can create one by filling the sign up form at http://localhost:5037 (default value).

Then you should be able to upload a package with the current command:

twine upload package.whl --repository-url http://127.0.0.1:5037/simple

and install the package with pip

pip install --index-url http://localhost:5037/simple package

Roadmap

Core features

• Simple Index Interface
  • PEP 503 - Simple Repository API
  • PEP 629 - Versioning PyPI’s Simple API
  • PEP 643 – Metadata for Package Source Distributions
  • PEP 658 - PEP 658 – Serve Distribution Metadata in the Simple Repository API
  • PEP 691 - JSON-based Simple API for Python Package Indexes
• Server configuration:
  • config.toml
• Manage users:
  • Admin page
  • User basic auth
  • User sign up
  • User login / User session
  • User Roles (Contributor & admin)
• Embed package readme to website (markdown file only.)
• Add Mirrors (and cache?) to others python indexes.
• Search package

Ideas

• Rely on uv for PEP implementations such as project, metadata, etc.

Useful Resources

Here is a list of the resources I heavily relied on to develop this project.

• https://docs.rs/axum/latest/axum/
• https://www.zero2prod.com/