Installation

Requirements

Python 3.12 or higher
pip (Python package manager)

Install from Release (Recommended)

Download the latest wheel file from Git Releases and install it:

# Download the wheel file from releases
# Example: pyserve-0.7.0-py3-none-any.whl

pip install pyserve-0.7.0-py3-none-any.whl

After installation, the pyserve command will be available in your terminal:

pyserve --version

Install from Source

For development or if you want the latest changes:

# Clone the repository
git clone https://github.com/ShiftyX1/PyServe.git
cd PyServe

# Install with Poetry (recommended for development)
make init

# Or build and install the package
make build
pip install dist/pyserve-*.whl

Verify Installation

Check that pyserve is installed correctly:

pyserve --version
# Output: pyserve 0.7.0

Dependencies

pyserve automatically installs the following dependencies:

starlette — ASGI framework
uvicorn — ASGI server
pyyaml — YAML configuration parsing
structlog — Structured logging
httpx — HTTP client for reverse proxy

Next: Continue to Quick Start to run your first server.