{"id":16545905,"url":"https://github.com/jowilf/qwikcrud","last_synced_at":"2025-03-21T10:31:40.858Z","repository":{"id":209753605,"uuid":"724854409","full_name":"jowilf/qwikcrud","owner":"jowilf","description":"An AI-powered command-line tool that generates REST APIs and admin interfaces based on one line requirement","archived":false,"fork":false,"pushed_at":"2023-12-18T22:02:15.000Z","size":66,"stargazers_count":29,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-14T02:03:58.616Z","etag":null,"topics":["admin","admin-dashboard","ai","chatgpt","cli","code-generation","fastapi","gemini","gpt","llm","pydantic-v2","python3","restful-api","sqlalchemy-file","sqlalchemy2","starlette-admin"],"latest_commit_sha":null,"homepage":"https://qwikcrud-demo.jowilf.com/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jowilf.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-28T23:32:25.000Z","updated_at":"2024-11-12T15:28:58.000Z","dependencies_parsed_at":"2023-12-18T02:24:32.370Z","dependency_job_id":"b225a40e-72c2-486f-b681-b325231fbb39","html_url":"https://github.com/jowilf/qwikcrud","commit_stats":{"total_commits":34,"total_committers":1,"mean_commits":34.0,"dds":0.0,"last_synced_commit":"560dcabb1dfcf6ea5885d7077e63dd3496a89908"},"previous_names":["jowilf/qwikcrud"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jowilf%2Fqwikcrud","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jowilf%2Fqwikcrud/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jowilf%2Fqwikcrud/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jowilf%2Fqwikcrud/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jowilf","download_url":"https://codeload.github.com/jowilf/qwikcrud/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244777900,"owners_count":20508807,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["admin","admin-dashboard","ai","chatgpt","cli","code-generation","fastapi","gemini","gpt","llm","pydantic-v2","python3","restful-api","sqlalchemy-file","sqlalchemy2","starlette-admin"],"created_at":"2024-10-11T19:08:05.634Z","updated_at":"2025-03-21T10:31:40.569Z","avatar_url":"https://github.com/jowilf.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# qwikcrud\n\n[![PyPI - Version](https://img.shields.io/pypi/v/qwikcrud.svg)](https://pypi.org/project/qwikcrud)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/qwikcrud.svg)](https://pypi.org/project/qwikcrud)\n\n-----\n\n`qwikcrud` is a powerful command-line tool designed to enhance your backend development experience by automating the\ngeneration of comprehensive REST APIs and admin interfaces. Say goodbye to the tedious task of\nwriting repetitive CRUD (Create, Read, Update, Delete) endpoints when starting a new project, allowing developers to\nconcentrate on the core business logic and functionality.\n\n\u003e [!WARNING]\n\u003e The generated application is not ready for production use. Additional steps are required to\n\u003e set up a secure and production-ready environment.\n\n\n[![qwikcrud demo](https://github.com/jowilf/qwikcrud/assets/31705179/fc010d41-597c-4ab7-a0ad-22570ba3b182)](https://youtu.be/XYuLDk0bjQA \"qwikcrud demo - A restaurant management app\")\n\n## Table of Contents\n\n* [Installation](#installation)\n* [Quickstart](#quickstart)\n    * [Environment variables](#environment-variables)\n    * [Usage](#usage)\n    * [Generated Application stack](#generated-application-stack)\n* [Roadmap](#roadmap)\n* [Contributing](#contributing)\n* [Acknowledgments](#acknowledgments)\n* [License](#license)\n\n## Installation\n\n```shell\npip install qwikcrud\n```\n\n## Quickstart\n\n### Environment variables\n\nBefore running the command-line tool, ensure the following environment variables are configured:\n\n#### Google\n\n```shell\nexport GOOGLE_API_KEY=\"your_google_api_key\"\n```\n\n#### OpenAI\n\n```shell\nexport OPENAI_API_KEY=\"your_openai_api_key\"\nexport OPENAI_MODEL=\"your_openai_model\" # Defaults to \"gpt-3.5-turbo-1106\"\n```\n\n### Usage\n\nTo generate your application, open your terminal, run the following command and follow the instructions:\n\n#### Google\n\n```shell\nqwikcrud -o output_dir\n```\n\n#### OpenAI\n\n```shell\nqwikcrud -o output_dir --ai openai\n```\n\n### Generated Application stack\n\n- [FastAPI](https://fastapi.tiangolo.com/)\n- [SQLAlchemy v2](https://www.sqlalchemy.org/)\n- [Pydantic v2](https://docs.pydantic.dev/latest/)\n- [Starlette-admin](https://github.com/jowilf/starlette-admin)\n- [SQLAlchemy-file](https://github.com/jowilf/sqlalchemy-file)\n\n### Examples\n\n- Task\n  Management ([prompt](./examples/fastapi/task-management/prompt), [generated app](./examples/fastapi/task-management/generated))\n\n## Roadmap\n\n`qwikcrud` is designed to support various frameworks and AI providers. Here's an overview of what has been accomplished\nand\nwhat is planned for the future:\n\n### Frameworks\n\n- [x] FastAPI + SQLAlchemy\n    - [x] Restful APIs\n    - [x] Admin interfaces\n    - [ ] Authentication\n- [ ] FastAPI + Beanie\n- [ ] Spring Boot\n\n### AI providers\n\n- [x] Google (_default_)\n- [x] OpenAI\n- [ ] Anthropic\n- [ ] Ollama (_self-hosted LLMs_)\n\n## Pricing\n\n`qwikcrud` makes one API call per prompt and add a system prompt of around 900 tokens to\nyour prompt.\n\n- **Google**: Currently free.\n- **OpenAI**: With the default gpt-3.5-turbo model, each app generation costs approximately $0.003. The exact cost can\n  vary slightly based on the model selected and the output length\n\n## Contributing\n\nContributions are welcome and greatly appreciated! If you have ideas for improvements or encounter issues, please feel\nfree to submit a pull request or open an issue.\n\n## Acknowledgments\n\n- The FastAPI + SQLAlchemy template is inspired by the excellent work\n  in [full-stack-fastapi-postgresql](https://github.com/tiangolo/full-stack-fastapi-postgresql)\n  by [Sebastian Ramirez (tiangolo)].\n\n## License\n\n``qwikcrud`` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjowilf%2Fqwikcrud","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjowilf%2Fqwikcrud","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjowilf%2Fqwikcrud/lists"}