Description:
qwikcrud 0.0.4
qwikcrud
qwikcrud is a powerful command-line tool designed to enhance your backend development experience by automating the
generation of comprehensive REST APIs and admin interfaces. Say goodbye to the tedious task of
writing repetitive CRUD (Create, Read, Update, Delete) endpoints when starting a new project, allowing developers to
concentrate on the core business logic and functionality.
[!WARNING]
The generated application is not ready for production use. Additional steps are required to
set up a secure and production-ready environment.
Table of Contents
Installation
Quickstart
Environment variables
Usage
Generated Application stack
Roadmap
Contributing
Acknowledgments
License
Installation
pip install qwikcrud
Quickstart
Environment variables
Before running the command-line tool, ensure the following environment variables are configured:
Google
export GOOGLE_API_KEY="your_google_api_key"
OpenAI
export OPENAI_API_KEY="your_openai_api_key"
export OPENAI_MODEL="your_openai_model" # Defaults to "gpt-3.5-turbo-1106"
Usage
To generate your application, open your terminal, run the following command and follow the instructions:
Google
qwikcrud -o output_dir
OpenAI
qwikcrud -o output_dir --ai openai
Generated Application stack
FastAPI
SQLAlchemy v2
Pydantic v2
Starlette-admin
SQLAlchemy-file
Examples
Task
Management (prompt, generated app)
Roadmap
qwikcrud is designed to support various frameworks and AI providers. Here's an overview of what has been accomplished
and
what is planned for the future:
Frameworks
FastAPI + SQLAlchemy
Restful APIs
Admin interfaces
Authentication
FastAPI + Beanie
Spring Boot
AI providers
Google (default)
OpenAI
Anthropic
Ollama (self-hosted LLMs)
Pricing
qwikcrud makes one API call per prompt and add a system prompt of around 900 tokens to
your prompt.
Google: Currently free.
OpenAI: With the default gpt-3.5-turbo model, each app generation costs approximately $0.003. The exact cost can
vary slightly based on the model selected and the output length
Contributing
Contributions are welcome and greatly appreciated! If you have ideas for improvements or encounter issues, please feel
free to submit a pull request or open an issue.
Acknowledgments
The FastAPI + SQLAlchemy template is inspired by the excellent work
in full-stack-fastapi-postgresql
by [Sebastian Ramirez (tiangolo)].
License
qwikcrud is distributed under the terms of the Apache-2.0 license.
License
For personal and professional use. You cannot resell or redistribute these repositories in their original state.
Customer Reviews
There are no reviews.
