fastapi-jet 1.1.2

Managing FastAPI projects made easy.

FastAPI-Jet is a modern, fast web administration interface designed to work with FastAPI. It is built to provide an intuitive and easy-to-use interface for managing your FastAPI applications.

Introduction

FastAPI-Jet offers a streamlined way to manage your FastAPI applications. With an array of commands and a user-friendly interface, it simplifies the development and administration of your FastAPI projects.

Features

1. Command Line Interface (CLI): fastapi-jet includes a CLI for easy management and interaction with FastAPI projects.
2. Project Generation: Automated generation of project structure, adhering to best practices in FastAPI development.
3. Context Management: Provides utilities for context management within FastAPI applications.
4. Decorator Utilities: A set of decorators to simplify common tasks in FastAPI.
5. Template Integration: In-built support for various templates to accelerate development.
6. Utility Functions: A collection of utility functions designed to enhance FastAPI functionality.

Installation

To install fastapi-jet, you need to have Python installed on your system. Then you can install the library using pip. Below are the steps for installation:

# Install fastapi-jet via pip
pip install fastapi-jet

Usage

• CLI: The CLI can be used to generate a new project, create a new app, and run the application. The CLI can be accessed using the jet command.

# Create a new project
fastjet startproject <project_name>

# Create a new app
fastjet startapp <app_name>

# Run the application
fastjet runserver

Contributing

Contributions are welcome and appreciated! Here's a quick guide on how you can contribute:

• Fork and Clone: Fork the project on GitHub, then clone your fork.
• Create a Branch: Make a new branch for your changes.
• Make Changes: Work on your feature, bug fix, or documentation improvement.
• Test Your Changes: Ensure your changes work as expected.
• Commit and Push: Commit your changes and push them to your branch.
• Create a Pull Request: Submit a pull request (PR) to the main project.

Your PRs should be clear and concise, explaining what the changes are and why they're needed.

We appreciate all your contributions, big or small!

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

This project draws inspiration from a blend of established and innovative web development practices. We extend our heartfelt gratitude to the following sources:

• Django Admin: Our project is notably influenced by the Django Admin framework. Django's robust and versatile approach to web application administration has been a guiding force in shaping our architectural and design decisions.

• FastAPI Manager: We also owe a debt of gratitude to the manage-fastapi project on GitHub. This resource has been instrumental in our understanding and implementation of FastAPI-specific features and methodologies.

The integration of ideas from these sources has been pivotal in the development of our project. We are deeply appreciative of the open-source community and its contributors for their pioneering work, which continues to inspire and revolutionize the field of web development.