Skip to main content

A modern Python development toolkit.

Project description

jbussdieker-app

A modern Python development toolkit plugin for creating and managing Flask web applications. This plugin integrates with the jbussdieker CLI framework to provide a streamlined development experience for Flask applications.

🚀 Features

  • Flask Application Generator: Quickly create and run Flask applications
  • Bootstrap Integration: Built-in Bootstrap 5 support for modern UI components
  • Health Check Endpoint: Automatic /healthz endpoint for monitoring
  • Development Server: Easy-to-use development server with configurable host
  • CLI Integration: Seamless integration with the jbussdieker CLI framework
  • Modern Python: Built with Python 3.9+ and modern Flask practices

📦 Installation

pip install jbussdieker-app --upgrade

🔧 Prerequisites

  • Python 3.9 or higher
  • jbussdieker CLI framework
  • Flask and related dependencies (automatically installed)

🎯 Usage

Basic Usage

Create and run a Flask application:

jbussdieker app

This will start a Flask development server on http://0.0.0.0:9000.

Custom Host Configuration

Specify a custom host for the development server:

jbussdieker app --host 127.0.0.1

Available Endpoints

  • Root (/): Displays application version information
  • Health Check (/healthz): Returns "OK" for health monitoring

🏗️ Project Structure

The plugin creates a Flask application with the following structure:

src/jbussdieker/app/
├── __init__.py      # Package initialization
├── cli.py           # CLI interface and argument parsing
├── factory.py       # Flask application factory
└── blueprint.py     # Route definitions and views

🔍 How It Works

  1. CLI Registration: Registers the app command with jbussdieker CLI
  2. Application Factory: Uses Flask's application factory pattern for clean architecture
  3. Bootstrap Integration: Automatically configures Bootstrap 5 for modern styling
  4. Blueprint Registration: Organizes routes using Flask blueprints
  5. Development Server: Runs the Flask development server with configurable options

🛠️ Development

This plugin is part of the jbussdieker ecosystem. It integrates seamlessly with the jbussdieker CLI framework.

Dependencies

  • Flask: Web framework
  • Bootstrap-Flask: Bootstrap 5 integration
  • Flask-SQLAlchemy: Database ORM (available for future use)

Extending the Application

You can extend the Flask application by:

  1. Adding new routes to blueprint.py
  2. Creating additional blueprints for modular organization
  3. Configuring database models with Flask-SQLAlchemy
  4. Adding custom middleware or extensions

📝 License

This project is licensed under MIT.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📚 Related

Project details


Download files

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

Source Distribution

jbussdieker_app-0.4.1.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

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

jbussdieker_app-0.4.1-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file jbussdieker_app-0.4.1.tar.gz.

File metadata

  • Download URL: jbussdieker_app-0.4.1.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for jbussdieker_app-0.4.1.tar.gz
Algorithm Hash digest
SHA256 ecc86f3a47110b638cc89679755045bd181bc18878f635f5e05ac5aec0607ceb
MD5 1c937d16a206444352994cab949b4a58
BLAKE2b-256 99f09cf5e5bd00d043ea67b2e1cfc0de3ba6969250af3efa38932727d210b3f4

See more details on using hashes here.

File details

Details for the file jbussdieker_app-0.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for jbussdieker_app-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b3df083e2a0a82d9cfc556ed979aae51de4da9e28a59d808f06fccf58f4cdaf1
MD5 883f5fbabf5c8a7fb677f6b6d1a115e4
BLAKE2b-256 765a9c2d0f60f43120a380b34c62b146d6527109eaaaa5b91ae2fe82d77509a5

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