Repository files navigation

qwikcrud is a powerful command-line tool designed to enhance your backend development experience by automating thegeneration of comprehensive REST APIs and admin interfaces. Say goodbye to the tedious task ofwriting repetitive CRUD (Create, Read, Update, Delete) endpoints when starting a new project, allowing developers toconcentrate on the core business logic and functionality.

• Installation
• Quickstart
  • Environment variables
  • Usage
  • Generated Application stack
• Roadmap
• Contributing
• Acknowledgments
• License

pip install qwikcrud

Before running the command-line tool, ensure the following environment variables are configured:

export GOOGLE_API_KEY="your_google_api_key"

export OPENAI_API_KEY="your_openai_api_key"export OPENAI_MODEL="your_openai_model"# Defaults to "gpt-3.5-turbo-1106"

To generate your application, open your terminal, run the following command and follow the instructions:

qwikcrud -o output_dir

qwikcrud -o output_dir --ai openai

• FastAPI
• SQLAlchemy v2
• Pydantic v2
• Starlette-admin
• SQLAlchemy-file

• TaskManagement (prompt,generated app)

qwikcrud is designed to support various frameworks and AI providers. Here's an overview of what has been accomplishedandwhat is planned for the future:

• FastAPI + SQLAlchemy
  • Restful APIs
  • Admin interfaces
  • Authentication
• FastAPI + Beanie
• Spring Boot

• Google (default)
• OpenAI
• Anthropic
• Ollama (self-hosted LLMs)

qwikcrud makes one API call per prompt and add a system prompt of around 900 tokens toyour prompt.

• Google: Currently free.
• OpenAI: With the default gpt-3.5-turbo model, each app generation costs approximately $0.003. The exact cost canvary slightly based on the model selected and the output length

Contributions are welcome and greatly appreciated! If you have ideas for improvements or encounter issues, please feelfree to submit a pull request or open an issue.

• The FastAPI + SQLAlchemy template is inspired by the excellent workinfull-stack-fastapi-postgresqlby [Sebastian Ramirez (tiangolo)].

qwikcrud is distributed under the terms of theApache-2.0 license.