{"id":40232768,"url":"https://github.com/itcentralng/flask-setup","last_synced_at":"2026-01-19T23:01:40.776Z","repository":{"id":37900733,"uuid":"258705945","full_name":"itcentralng/flask-setup","owner":"itcentralng","description":"Flask Setup","archived":false,"fork":false,"pushed_at":"2025-05-04T22:50:43.000Z","size":2667,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-01-13T17:23:09.814Z","etag":null,"topics":["flask","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/itcentralng.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-04-25T06:45:03.000Z","updated_at":"2025-05-04T22:50:47.000Z","dependencies_parsed_at":"2025-05-04T10:20:06.537Z","dependency_job_id":"aa940c21-9a88-460d-9a9a-b1ebe788ad47","html_url":"https://github.com/itcentralng/flask-setup","commit_stats":{"total_commits":106,"total_committers":5,"mean_commits":21.2,"dds":"0.047169811320754707","last_synced_commit":"1d50b25337f9068c85ce5e4dbc9ab46f776dd0a8"},"previous_names":["mrteey/flask-setup"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/itcentralng/flask-setup","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itcentralng%2Fflask-setup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itcentralng%2Fflask-setup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itcentralng%2Fflask-setup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itcentralng%2Fflask-setup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itcentralng","download_url":"https://codeload.github.com/itcentralng/flask-setup/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itcentralng%2Fflask-setup/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28588967,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-19T20:45:59.482Z","status":"ssl_error","status_checked_at":"2026-01-19T20:45:41.500Z","response_time":67,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["flask","python"],"created_at":"2026-01-19T23:00:41.743Z","updated_at":"2026-01-19T23:01:40.763Z","avatar_url":"https://github.com/itcentralng.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flask-Setup\n\nFlask-Setup is an open-source and user-friendly tool designed to help you set up a Flask project in under 10 minutes. With a single `fs` command, it takes care of all your CRUD operations (HTTP methods) such as post, get, put, and delete automatically.\n\nImagine skipping the tedious setup process and diving straight into building your application's features. Flask-Setup does the heavy lifting, so you can focus on what truly matters rather than setting up boilerplate code.\n\nExplore more and see how Flask-Setup can streamline your Flask development at the [Flask-Setup PyPI page](https://pypi.org/project/flask-setup/).\n\n# Getting Started\n\nIf you have any questions that are beyond the scope of the documentation, Please feel free to [email us](mailto:nasir@mrteey.com).\n\n## Installation\n\nMake sure [Python](https://www.python.org/downloads/) is installed on your system (Windows, Linux, macOS). Then, run the following command:\n\n```python\npip install flask-setup\n```\n\n## Upgrade\n\nTo upgrade Flask-Setup to the latest version, run the following command:\n\n```python\n pip install --upgrade flask-setup\n```\n\n## Usage\n\nTo use Flask-Setup, run the `fs` command followed by the desired argument (`fs command argument`) in the terminal. Here are the available commands:\n\n- build\n- init\n- add\n- remove\n- install\n- uninstall\n- start\n\nThe arguments can be a project name, blueprint name, and/or field names with their respective data types.\n\n## Commands\n\n### build\n\nThis creates a new project with the specified name.\n\n```python\nfs build projectname\n```\n\n### init\n\nThis initialises a `.fs` file in the root directory of an existing Flask project, enabling seamless use of Flask-Setup `fs` commands.\n\n```python\nfs init\n```\n\n### migrate\n\nThis migrates older version of a flask-setup project (v0.6.1 and below) to the latest version.\n\n```python\nfs migrate\n```\n\n### add\n\nThis command adds a blueprint with the name 'api' and the specified model fields.\n\n```python\nfs add api ..fields\n```\n\n- Supported field types include `str` (optional), `int`, `float`, `bool`, `date`, `fk`, `rel`.\n- Example usage:\n  - `fs add category name:str news:rel=news`\n  - `fs add news title:str date:date body views:int category_id:fk=category.id`\n\nIn the first example, a blueprint named 'category' will be created with the a `str` field 'name' and a relationship with the model 'news'.\n\nIn the second example, a blueprint named 'news' will be created with the specified model fields. Note that the `str` field type for `body` is optional and has been omitted.\n\n### remove\n\nThis will remove the blueprint named 'api' from the project.\n\n```python\nfs remove api\n```\n\n### install\n\nThis will install the specified module \"flask\" and freeze it to the requirements file.\n\n```python\nfs install flask\n```\n\n### uninstall\n\nThis will uninstall the specified module \"flask\" and remove it from the freeze requirements file.\n\n```python\nfs uninstall flask\n```\n\n### start\n\nThis will start the server.\n\n```python\nfs start\n```\n\n## Model Changes\n\n\u003e [!Note]\n\u003e To create database tables or apply model changes, perform the following database migration and upgrade steps:\n\n```python\nflask db migrate -m \"migration message\"\n```\n\n```python\nflask db upgrade\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitcentralng%2Fflask-setup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitcentralng%2Fflask-setup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitcentralng%2Fflask-setup/lists"}