Skip to content
PromptPack Logo PromptPack Python

Contributing

We welcome contributions to PromptPack Python! This guide will help you get started.

Development Setup

Section titled “Development Setup”

Prerequisites

Section titled “Prerequisites”
  • Python 3.10 or higher
  • Hatch for project management

Clone and Install

Section titled “Clone and Install”
Terminal window
git clone https://github.com/AltairaLabs/promptpack-python.git
cd promptpack-python
pip install hatch

Development Commands

Section titled “Development Commands”

All development commands are run through Hatch:

Terminal window
# Run tests
hatch run test


# Run tests with coverage
hatch run test-cov


# Lint code
hatch run lint


# Format code
hatch run format


# Type checking
hatch run typecheck

Project Structure

Section titled “Project Structure”
promptpack-python/
├── packages/
│   ├── promptpack/           # Base library
│   │   ├── src/promptpack/
│   │   └── tests/
│   └── promptpack-langchain/ # LangChain integration
│       ├── src/promptpack_langchain/
│       └── tests/
├── docs/                     # Documentation (Astro/Starlight)
└── pyproject.toml           # Root project configuration

Code Style

Section titled “Code Style”
  • Use ruff for linting and formatting
  • Follow PEP 8 style guidelines
  • Add type hints to all public functions and methods
  • Write docstrings for all public APIs (Google style)

Testing

Section titled “Testing”
  • Write tests for all new functionality
  • Maintain test coverage above 80%
  • Use pytest for testing
  • Place tests in the tests/ directory of each package

Running Specific Tests

Section titled “Running Specific Tests”
Terminal window
# Run tests for a specific package
hatch run test packages/promptpack/tests/


# Run a specific test file
hatch run test packages/promptpack/tests/test_parser.py


# Run tests matching a pattern
hatch run test -k "test_parse"

Pull Request Process

Section titled “Pull Request Process”
  1. Fork the repository
  2. Create a feature branch from main
  3. Make your changes
  4. Ensure all tests pass
  5. Ensure code passes linting and type checking
  6. Submit a pull request

Commit Messages

Section titled “Commit Messages”

Use clear, descriptive commit messages:

  • feat: add support for array variables
  • fix: handle missing optional fields
  • docs: update installation instructions
  • test: add tests for fragment parsing
  • chore: update dependencies

Documentation

Section titled “Documentation”

Building Documentation

Section titled “Building Documentation”
Terminal window
cd docs
npm install
npm run dev

The documentation site will be available at http://localhost:4321.

Writing Documentation

Section titled “Writing Documentation”
  • Documentation is in docs/src/content/docs/
  • Use Markdown or MDX format
  • Include frontmatter with title and description
  • Add code examples where appropriate

License

Section titled “License”

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.