How to setup py-libp2p (post revamp)

[arcinston]

relating to PR #618

We are deprecating setup.py to use the updated pyproject.toml to allow for easy configuration using any python dependency management tool (pip , uv , poetry )

1. using Ruff for linting and formatting
2. using PyRight for static type checking

Guide to setting up the repo

Using pip

1. Upgrade pip:
   Ensure you have the latest version of pip:

   python -m pip install --upgrade pip
   

2. Install Project for Development:
   Navigate to the root directory of the py-libp2p repository. To install the project along with its core and development dependencies, run:

   pip install -e .[dev]
   

   The -e flag installs the project in "editable" mode. The [dev] part installs the optional dependencies needed for development, as defined in pyproject.toml.

Using Poetry

Poetry is a comprehensive tool for Python dependency management and packaging.

1. Install Poetry:
   Follow the official installation instructions on the Poetry website.

   curl -sSL https://install.python-poetry.org | python3 -
   

   Ensure Poetry's bin directory is in your system's PATH.

2. Configure Poetry (Optional but Recommended):
   To have Poetry create virtual environments within your project directory:

   poetry config virtualenvs.in-project true
   

3. Install Dependencies for Development:
   Navigate to the root of the py-libp2p repository. To install all dependencies, including those for development, run:

   poetry install --extras "dev"
   

   (Or poetry install --all-extras if you want all optional groups).

4. Activate Poetry's Virtual Environment:

   poetry shell
   

   Alternatively, prefix commands with poetry run.

Using uv

uv is a fast Python package installer and resolver.

1. Install uv:
   Refer to the official uv installation guide at astral.sh/uv.

   curl -LsSf https://astral.sh/uv/install.sh | sh
   

2. Ensure Virtual Environment is Active:
   Activate the virtual environment created in "General Prerequisites". uv will use it.

   source .venv/bin/activate # Or equivalent for your OS
   

3. Install Project for Development:
   Navigate to the root of the py-libp2p repository.

   uv sync --all-extras 
   

Development Workflow: Linting and Type Checking

Once you have installed the dependencies using your preferred method and your virtual environment is active (or you are using poetry run / uv run), you can use the following make commands for common development tasks:

1. Ruff (Linting & Formatting):
   To automatically fix linting and formatting issues using Ruff:

   make fix
   

   This command is defined in the Makefile and runs python -m ruff check --fix.

2. PyRight & Mypy (Static Type Checking):
   To run static type checks using PyRight (and Mypy, as per the Makefile):

   make typecheck
   

   This command is defined in the Makefile and executes pre-commit run mypy-local --all-files && pre-commit run pyright-pretty --all-files. This implies that pre-commit hooks are also a part of the development setup, which is good practice. Users might also want to install these hooks:

   pre-commit install
   

   This command should be run once after cloning the repository to ensure checks are run automatically before commits.

[Sahilgill24]

Hi , so I was trying to setup py-libp2p on my mac and faced an error with the fastecdsa library related to the gmp.h header file , on searching I found it was a common issue .
The issue in detail can be seen here AntonKueltz/fastecdsa#74
To resolve this instead of directly using

pip install -e '.[dev]'

This command can be used

CFLAGS=-I/opt/homebrew/opt/gmp/include LDFLAGS=-L/opt/homebrew/opt/gmp/lib pip install -e '.[dev]'

just make sure to use the correct path to the gmp file , this can be used directly if gmp was installed using homebrew

[seetadev]

@arcinston : This is very nicely done. Great, thank you for sharing the docs.

@Sahilgill24 : The issue shared is a known one. Please refer to: https://docs.google.com/document/d/1zctGtMQLUEr3dYT7o6UCXn940Wztec8CfjF8eMKBmas/edit?usp=sharing . We will add these details in Py-libp2p wiki.