Skip to main content

Core Python framework and blessed dependencies for production-ready FastAPI + MongoDB + HTMX projects

Project description

vibetuner

Core Python framework and blessed dependencies for Vibetuner projects

This package provides the complete Python framework and curated dependency set for building modern web applications with Vibetuner. It includes everything from FastAPI and MongoDB integration to authentication, background jobs, and CLI tools.

What is Vibetuner?

Vibetuner is a production-ready scaffolding tool for FastAPI web applications. This package (vibetuner) is the Python component that provides:

  • Complete web application framework built on FastAPI
  • Flexible database support: MongoDB (Beanie ODM) or SQL (SQLModel/SQLAlchemy)
  • OAuth and magic link authentication out of the box
  • Background job processing with Redis + Streaq (optional)
  • CLI framework with Typer
  • Email services, blob storage, and more

This package is designed to be used within projects generated by the Vibetuner scaffolding tool. For standalone use, you'll need to set up the project structure manually.

Installation

# In a Vibetuner-generated project (automatic)
uv sync

# Add to an existing project
uv add vibetuner

# With development dependencies
uv add vibetuner[dev]

Quick Start

The recommended way to use Vibetuner is via the scaffolding tool:

# Create a new project with all the framework code
uvx vibetuner scaffold new my-project
cd my-project
just dev

This will generate a complete project with:

  • Pre-configured FastAPI application
  • Authentication system (OAuth + magic links)
  • MongoDB models and configuration
  • Frontend templates and asset pipeline
  • Docker setup for development and production
  • CLI commands and background job infrastructure

What's Included

Core Framework (src/vibetuner/)

  • frontend/: FastAPI app, routes, middleware, auth
  • models/: User, OAuth, email verification, blob storage models
  • services/: Email (Mailjet), blob storage (S3)
  • tasks/: Background job infrastructure
  • cli/: CLI framework with scaffold, run, db commands
  • config.py: Pydantic settings management
  • mongo.py: MongoDB/Beanie setup (optional)
  • sqlmodel.py: SQLModel/SQLAlchemy setup (optional)
  • logging.py: Structured logging configuration

Blessed Dependencies

  • FastAPI (0.121+): Modern, fast web framework
  • Beanie: Async MongoDB ODM with Pydantic (optional)
  • SQLModel + SQLAlchemy: SQL databases - PostgreSQL, MySQL, SQLite (optional)
  • Authlib: OAuth 1.0/2.0 client
  • Granian: High-performance ASGI server
  • Redis + Streaq: Background task processing (optional)
  • Typer: CLI framework
  • Rich: Beautiful terminal output
  • Loguru: Structured logging
  • Pydantic: Data validation and settings

See pyproject.toml for the complete dependency list.

CLI Tools

When installed, provides the vibetuner command:

# Create new project from template
vibetuner scaffold new my-project
vibetuner scaffold new my-project --defaults

# Update existing project
vibetuner scaffold update

# Database management (SQLModel)
vibetuner db create-schema    # Create SQL database tables

# Run development server (in generated projects)
vibetuner run dev frontend
vibetuner run dev worker

# Run production server (in generated projects)
vibetuner run prod frontend
vibetuner run prod worker

Development Dependencies

The [dev] extra includes all tools needed for development:

  • Ruff: Fast linting and formatting
  • Babel: i18n message extraction
  • pre-commit: Git hooks (prek is a fast pre-commit drop-in replacement)
  • Type stubs: For aioboto3, authlib, PyYAML
  • And more...

Usage in Generated Projects

In a Vibetuner-generated project, import from vibetuner:

# Use core models
from vibetuner.models import UserModel, OAuthAccountModel

# Use services
from vibetuner.services.email import EmailService

# Use configuration
from vibetuner.config import settings

# Extend core routes
from vibetuner.frontend import app

# Add your routes
@app.get("/api/hello")
async def hello():
    return {"message": "Hello World"}

Documentation

For complete documentation, guides, and examples, see the main Vibetuner repository:

📖 Vibetuner Documentation

Package Ecosystem

Vibetuner consists of four packages that work together:

  1. vibetuner (this package): Python framework and dependencies
  2. @alltuner/vibetuner: JavaScript/CSS build dependencies (tailwind, daisyui, htmx, etc.)
  3. @alltuner/vibetuner-jinja: npm-shipped mirror of this package's frontend jinja templates, pulled in transitively by @alltuner/vibetuner so tailwind can scan them at frontend build time without shelling out to Python (no direct install needed)
  4. Scaffolding template: Copier template for project generation

All four are version-locked and tested together to ensure compatibility.

Contributing

Contributions welcome! See the main repository for contribution guidelines:

🤝 Contributing to Vibetuner

License

MIT License - Copyright (c) 2025 All Tuner Labs, S.L.

See LICENSE for details.

Links

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vibetuner-10.18.0.tar.gz (195.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vibetuner-10.18.0-py3-none-any.whl (243.4 kB view details)

Uploaded Python 3

File details

Details for the file vibetuner-10.18.0.tar.gz.

File metadata

  • Download URL: vibetuner-10.18.0.tar.gz
  • Upload date:
  • Size: 195.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for vibetuner-10.18.0.tar.gz
Algorithm Hash digest
SHA256 74535fe3f1e343463cf4a13b10b9b3957f97399611ff8d837b5db631e8388285
MD5 cf9593fa2732a53071bda7fac8fca484
BLAKE2b-256 ac2d262e0b994c3eda25b43d1dbdc10ac042c72fa3edfa70e785c5200ba5e21d

See more details on using hashes here.

File details

Details for the file vibetuner-10.18.0-py3-none-any.whl.

File metadata

  • Download URL: vibetuner-10.18.0-py3-none-any.whl
  • Upload date:
  • Size: 243.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for vibetuner-10.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ce4ff09800a8b5f98f06fe9c426845f49216927a3518f5880d91e205fb9ebfa4
MD5 d0992f0d98db3a2431624e6a373907fa
BLAKE2b-256 f06f074212aadcb3df85545a244a6077f8d6423cd602f2c5d0ecc58a4a316d25

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page