Prerequisites
Before installing the midPilot Connector Generator, ensure you have the following installed:Python 3.12+
Python 3.12 or later is required
UV Package Manager
Modern Python package manager
PostgreSQL 15
PostgreSQL database for data persistence
Docker (Optional)
For containerized deployment
Installation Methods
Choose your preferred installation method:- Using UV (Recommended)
- Docker
Install dependencies
UV will automatically create a virtual environment and install all dependencies:This installs all production dependencies listed in
pyproject.toml.Development Dependencies
For development, install additional tools for testing, linting, and type checking:- mypy - Static type checker
- pytest - Testing framework
- ruff - Fast Python linter and formatter
- pre-commit - Git hook framework
- poethepoet - Task runner
Installing Additional Dependencies
Production Dependencies
Production Dependencies
To add a production dependency:Example:
Development Dependencies
Development Dependencies
To add a development dependency:Example:
Pre-commit Hooks
Set up pre-commit hooks to ensure code quality on every commit:.pre-commit-config.yaml that will automatically run quality checks (linting, formatting, type checking) before each commit.
Next Steps
Configuration
Configure environment variables and settings
Database Setup
Set up PostgreSQL and run migrations
Docker Setup
Deploy with Docker Compose
API Reference
Explore the API endpoints
Troubleshooting
UV command not found
UV command not found
If Add this line to your
uv is not found after installation, ensure that ~/.cargo/bin is in your PATH:~/.bashrc or ~/.zshrc to make it permanent.Python version mismatch
Python version mismatch
Ensure you have Python 3.12 or later:UV will use the system Python by default. To use a specific version:
Permission errors
Permission errors
If you encounter permission errors, avoid using
sudo. Instead, ensure your user has write permissions to the project directory: