# QuickCRUD
QuickCRUD is a command-line interface (CLI) tool designed to automatically generate FastAPI APIs from a provided SQL schema. By using this tool, developers can quickly generate CRUD (Create, Read, Update, Delete) operations for each table in the database schema, saving valuable time when setting up backend APIs.
## Features
- Automatically generates FastAPI CRUD operations for SQL schema tables.
- Supports PostgreSQL, MySQL, and SQLite databases.
- Generates API routes for basic operations: GET, POST, PUT, DELETE.
- Creates a ready-to-use Docker Compose setup with two containers: one for the FastAPI application and another for the database.
## Current Status
As of now, **QuickCRUD** is in its **early stages**.
## Installation
To install **QuickCRUD**:
```
pip install quickcrud
```
## Usage
To generate FastAPI APIs from your SQL schema, simply run the following command:
```
quickcrud --schema path/to/your/schema.sql --db-type postgres
```
Replace `postgres` with `mysql` or `sqlite` depending on your database type.
## Development
To contribute to QuickCRUD, clone the repository and install the dependencies:
```
git clone https://github.com/wendersoon/QuickCRUD
cd QuickCRUD
poetry install
```
You can run tests, format the code with Black, and check for linting issues using the pre-configured tools.
Raw data
{
"_id": null,
"home_page": "https://github.com/wendersoon/QuickCRUD",
"name": "quickcrud",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": "fastapi, crud, sql, docker",
"author": "Wenderson",
"author_email": "ds.wendersonmelo@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b6/36/2904be7b35e0562dc393544b79e2061b420862a44cdc7045380278a419dc/quickcrud-0.1.0.tar.gz",
"platform": null,
"description": "# QuickCRUD\n\nQuickCRUD is a command-line interface (CLI) tool designed to automatically generate FastAPI APIs from a provided SQL schema. By using this tool, developers can quickly generate CRUD (Create, Read, Update, Delete) operations for each table in the database schema, saving valuable time when setting up backend APIs.\n\n## Features\n\n- Automatically generates FastAPI CRUD operations for SQL schema tables.\n- Supports PostgreSQL, MySQL, and SQLite databases.\n- Generates API routes for basic operations: GET, POST, PUT, DELETE.\n- Creates a ready-to-use Docker Compose setup with two containers: one for the FastAPI application and another for the database.\n\n## Current Status\n\nAs of now, **QuickCRUD** is in its **early stages**. \n\n## Installation\n\nTo install **QuickCRUD**:\n\n\n```\npip install quickcrud\n```\n\n## Usage\n\nTo generate FastAPI APIs from your SQL schema, simply run the following command:\n\n```\nquickcrud --schema path/to/your/schema.sql --db-type postgres\n```\n\nReplace `postgres` with `mysql` or `sqlite` depending on your database type.\n\n## Development\n\nTo contribute to QuickCRUD, clone the repository and install the dependencies:\n\n```\ngit clone https://github.com/wendersoon/QuickCRUD\ncd QuickCRUD\npoetry install\n```\n\nYou can run tests, format the code with Black, and check for linting issues using the pre-configured tools.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CLI to automatically generate FastAPI APIs from a SQL schema.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/wendersoon/QuickCRUD",
"Repository": "https://github.com/wendersoon/QuickCRUD"
},
"split_keywords": [
"fastapi",
" crud",
" sql",
" docker"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3d7590b34884c0836ed9f12731a11530b78fa6e1cca0c6a6963393e53e2024fa",
"md5": "108367ea14cd21cb3c8e4169d0777db7",
"sha256": "eb34d446c34eba7f8c13414ecf4de1b6d1151ef289e19d7622a0c7fe2ebd5ae0"
},
"downloads": -1,
"filename": "quickcrud-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "108367ea14cd21cb3c8e4169d0777db7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 3978,
"upload_time": "2024-11-17T14:41:51",
"upload_time_iso_8601": "2024-11-17T14:41:51.978384Z",
"url": "https://files.pythonhosted.org/packages/3d/75/90b34884c0836ed9f12731a11530b78fa6e1cca0c6a6963393e53e2024fa/quickcrud-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b6362904be7b35e0562dc393544b79e2061b420862a44cdc7045380278a419dc",
"md5": "099c05f1223fc3100470eb64251bfa27",
"sha256": "d616d8c87377bcdddb8ecb8cc94220b25941b3ecd1ce012b1a2172463a53d1d6"
},
"downloads": -1,
"filename": "quickcrud-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "099c05f1223fc3100470eb64251bfa27",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 2989,
"upload_time": "2024-11-17T14:41:53",
"upload_time_iso_8601": "2024-11-17T14:41:53.651655Z",
"url": "https://files.pythonhosted.org/packages/b6/36/2904be7b35e0562dc393544b79e2061b420862a44cdc7045380278a419dc/quickcrud-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-17 14:41:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wendersoon",
"github_project": "QuickCRUD",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "quickcrud"
}
JSON
