Skip to content

developing.md

Latest commit

 

History

History
85 lines (59 loc) · 1.67 KB

developing.md

File metadata and controls

85 lines (59 loc) · 1.67 KB

Development Setup

Python Environment with uv

This project uses uv for Python package management. uv provides fast dependency resolution and virtual environment management.

Quick Start

  1. Install uv:

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

  2. Sync dependencies:

    uv sync

  3. Run commands with uv:

    uv run pytest
uv run python -m build --wheel

Automatic Environment with direnv

For automatic environment activation, install direnv and run:

direnv allow

This will automatically:

  • Activate the uv environment when entering the directory
  • Add the Python virtual environment to your PATH
  • Sync dependencies if needed

After setup, you can run Python commands directly without uv run:

pytest
python -c "import procstar"

Pre-commit Hooks

This project uses pre-commit hooks to automatically format and lint code before commits. The hooks include:

  • ruff format - Format Python code
  • ruff check - Lint Python code with auto-fixes
  • cargo fmt - Format Rust code
  • cargo clippy - Lint Rust code

Setup

Pre-commit is already included as a dev dependency. To install the hooks:

uv run pre-commit install

Manual Run

To run all hooks on all files:

uv run pre-commit run --all-files

The hooks will automatically run before each commit and may modify files to fix formatting or linting issues.

Packaging

Wheel - PyPI

$ uv run python -m build --wheel
$ twine upload dist/procstar-...

RHEL8/Rocky binary

$ ./tools/rhel8/build.sh
$ ls -l target/rhel8/release/procstar