Skip to main content

​
System requirements

FastrAPI requires Python 3.8 or higher. It’s built with Rust and PyO3, but you don’t need to install Rust separately as the package includes pre-compiled binaries.
Minimum requirements:
  • Python 3.8+
  • pip or uv package manager
  • 64-bit architecture (x86_64 or ARM64)

​
Installation methods

​
Dependencies

FastrAPI automatically installs the following dependencies:
  • fastapi >= 0.124.4 - For compatibility with FastAPI ecosystem
  • pydantic >= 2.10.6 - For data validation and serialization
  • httpx >= 0.28.1 - For HTTP client functionality
  • pytest >= 8.3.5 - For testing support
These dependencies are installed automatically when you install FastrAPI.

​
Verifying installation

After installation, verify that FastrAPI is installed correctly by checking the version:
1

Open Python

Open a Python interactive shell:
python
2

Import FastrAPI

Try importing FastrAPI:
from fastrapi import FastrAPI
If no errors appear, FastrAPI is installed correctly.
3

Create a test app

Create a simple test application:
app = FastrAPI()

@app.get("/")
def hello():
    return {"message": "FastrAPI is working!"}

print("FastrAPI installation verified!")
You should see: FastrAPI installation verified!

​
Installation in virtual environments

It’s recommended to install FastrAPI in a virtual environment to avoid conflicts with other packages.

​
Using venv

# Create virtual environment
python -m venv myenv

# Activate it (Linux/macOS)
source myenv/bin/activate

# Activate it (Windows)
myenv\Scripts\activate

# Install FastrAPI
pip install fastrapi

​
Using uv

# Create and activate virtual environment with uv
uv venv
source .venv/bin/activate  # Linux/macOS
# or
.venv\Scripts\activate  # Windows

# Install FastrAPI
uv install fastrapi

​
Troubleshooting

This means FastrAPI is not installed in your current Python environment.Solution:
  • Ensure you’re using the correct Python environment
  • Reinstall FastrAPI: pip install fastrapi
  • Check if your virtual environment is activated
FastrAPI includes pre-compiled binaries, so compilation should not be necessary.Solution:
  • Ensure you’re using Python 3.8 or higher: python --version
  • Update pip: pip install --upgrade pip
  • Try installing with --no-cache-dir: pip install --no-cache-dir fastrapi
FastrAPI includes fastapi as a dependency for compatibility.Solution:
  • Let FastrAPI manage the fastapi dependency version
  • If you need a specific fastapi version, install it after FastrAPI
  • Check compatibility: pip show fastrapi fastapi
FastrAPI provides pre-built wheels for common architectures.Solution:
  • Ensure you’re on a 64-bit system
  • Supported platforms: Linux (x86_64, ARM64), macOS (x86_64, ARM64), Windows (x86_64)
  • For other architectures, you may need to build from source

​
Building from source

If you need to build FastrAPI from source (for development or unsupported architectures):
1

Install Rust

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
2

Install maturin

pip install maturin
3

Clone and build

git clone https://github.com/ppmpreetham/fastrapi.git
cd fastrapi
maturin develop --release

​
Next steps

Quickstart

Build your first FastrAPI application

Migration guide

Migrate from FastAPI to FastrAPI

Build docs developers (and LLMs) love

Get started for freeTalk to us