Installation — Aquilia Documentation
Comprehensive guide and documentation for Installation in the Aquilia framework. View API reference, examples, and implementation patterns.
Installation Set up Aquilia in your Python environment System Requirements Python Environment Minimum Version 3.10 Recommended 3.12+ Aquilia heavily uses modern asyncio features and type hints introduced in recent Python versions. Operating System macOS / Linux (Fully Supported) Windows (Fully & Natively Supported) Install from PyPI Install Aquilia using uv (recommended): Or with standard pip: Optional Extras Aquilia uses optional dependencies for specialized subsystems. Install only what you need: Extra Installs When to Use ] ))} Development Install (From Source) To contribute to Aquilia or test against the latest changes: Verify Installation After installation, verify that the CLI (aq) is available: The aq doctor command checks your environment for common issues — missing optional dependencies, incompatible Python versions, and misconfigured workspace files. CLI Entry Points The CLI can be accessed via the registered script or direct module invocation: aq Registered CLI command Recommended The standard shortcut installed globally or in your virtual environment to perform workspace bootstrapping, code generation, migrations, and serving. python -m aquilia.cli Module invocation fallback Invokes the CLI directly through the Python interpreter. Use this fallback if the virtual environment binary path is not added to your shell's $PATH. Troubleshooting aq: command not found Ensure your Python scripts directory is in $PATH. For virtual environments, make sure the venv is activated. Alternatively use python -m aquilia.cli. ModuleNotFoundError: No module named 'click' Click is a core dependency. Reinstall with pip install aquilia --force-reinstall. If using a locked environment, ensure click and pyyaml are included. Python version incompatibility Aquilia requires Python 3.10 or newer. Check with python --version. If you have multiple Python versions installed, use python3.10 -m pip install aquilia. Next Steps → Quick Start: Build your first API → CLI Commands: Full command reference → Project Structure: Understand the workspace layout )
Go to Homepage