{"id":23228003,"url":"https://github.com/Quantivio/faag_cli","last_synced_at":"2025-08-19T14:33:02.447Z","repository":{"id":61060928,"uuid":"544126665","full_name":"Quantivio/faag_cli","owner":"Quantivio","description":"FastAPI/Flask project generator with best folder structure. (Fast/Flask Architecture App Generator)","archived":false,"fork":false,"pushed_at":"2023-05-15T15:03:36.000Z","size":633,"stargazers_count":2,"open_issues_count":8,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-08T15:28:33.505Z","etag":null,"topics":["fastapi","flask","flask-application","pydantic","python","sql","sqlalchemy","sqlmodel"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/faag-cli/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Quantivio.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-10-01T18:05:16.000Z","updated_at":"2023-03-23T17:43:12.000Z","dependencies_parsed_at":"2022-10-09T10:23:14.639Z","dependency_job_id":null,"html_url":"https://github.com/Quantivio/faag_cli","commit_stats":null,"previous_names":["quantivio/faag_cli","devzonecommunity/faag_cli"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quantivio%2Ffaag_cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quantivio%2Ffaag_cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quantivio%2Ffaag_cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quantivio%2Ffaag_cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Quantivio","download_url":"https://codeload.github.com/Quantivio/faag_cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230359940,"owners_count":18214158,"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":["fastapi","flask","flask-application","pydantic","python","sql","sqlalchemy","sqlmodel"],"created_at":"2024-12-19T01:11:02.136Z","updated_at":"2024-12-19T01:11:03.055Z","avatar_url":"https://github.com/Quantivio.png","language":"Python","readme":"# Faag-CLI\n\n**FastAPI/Flask project generator with the best folder structure.** (Fast/Flask Architecture App Generator)\nFlask / FastAPI app generator with a maintainable architecture and sample codes for the best practices.\nCurrently, supports generation of FastAPI apps only. Flask support is coming soon. Currently, in `pre-release`. Feel\nfree\nto raise suggestions and issues. This package is made with [Typer](https://typer.tiangolo.com/).\n\n## Installation\n\n```bash\npoetry add faag-cli\n```\n\n```bash\npip install faag-cli\n```\n\n# Usage\n\nCurrently, we support generation of apps only. Adding support for other features like adding models, routes, etc. is\ncoming soon.\n\n## To generate a FastAPI/Flask app\n\n```faag generate``` will automatically generate a Fast App by default. You can also specify the type of app you want to\ngenerate with the `--type` flag. Default app will be generated with 'sample_app' as the name. You can also specify the\nname of the app with the `--name` flag.\n\n```bash\n Usage: faag [OPTIONS] COMMAND [ARGS]...\n\n FastAPI/Flask project generator with the best folder structure. Generate a new app using Faag CLI. \n\n╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────╮\n│ --version             -v        Prints the version of Faag CLI                                                          │\n│ --install-completion            Install completion for the current shell.                                               │\n│ --show-completion               Show completion for the current shell, to copy it or customize the installation.        │\n│ --help                          Show this message and exit.                                                             │\n╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯\n\n╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────────────────────────╮\n│                                                                                                                         │\n│ generate          FastAPI/Flask project generator with the best folder structure. Generate a new app using Faag CLI     │\n╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯\n```\n\n1. Help\n    ```bash\n    faag --help\n    ```\n\n2. Generate a FastAPI app\n    ```bash\n   faag generate\n    ```\n\n3. Generate a FastAPI/Flask App with custom app name\n    ```bash\n   faag generate --type fast --name fast_app\n   faag generate -t flask -n flask_app\n    ```\n\n4. View options for generating a FastAPI/Flask app\n    ```bash\n   faag generate --help\n    ```\n\n# Setup for development\n\n\u003e ## Virtual environment setup with Poetry\n\u003e 1. Create a fork of the repository\n\u003e 2. Clone the repository to your local machine\n     `git clone git@github.com:\u003cusername\u003e/PyNotion.git`\n\u003e 3. Install poetry with `pip install poetry` or `pip3 install poetry`\n\u003e 4. Navigate to the root of the project and run `poetry install`\n\n\u003e ## Setup Pre-commit hooks\n\u003e 1. Install pre-commit hooks `pre-commit install`\n\u003e 2. Migrate pre-commit configs `pre-commit migrate-config`\n\u003e 3. In case of error run `git config --global --unset-all core.hooksPath` or `git config --unset-all core.hooksPath`\n\n## Contribution Guidelines\n\nThank your for taking your valuable time to contribute to Faag-CLI.\nPull requests are welcome. For major changes, please open an issue\nfirst to discuss what you would like to change.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FQuantivio%2Ffaag_cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FQuantivio%2Ffaag_cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FQuantivio%2Ffaag_cli/lists"}