{"id":14065434,"url":"https://github.com/ozanonurtek/flask-now","last_synced_at":"2025-08-19T14:33:01.458Z","repository":{"id":57430532,"uuid":"119871947","full_name":"ozanonurtek/flask-now","owner":"ozanonurtek","description":"Flask-Now is a Flask Application Generator/Build-Tool runs via CLI","archived":false,"fork":false,"pushed_at":"2019-10-19T19:31:24.000Z","size":1948,"stargazers_count":63,"open_issues_count":3,"forks_count":12,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-03-15T01:20:42.682Z","etag":null,"topics":["app-generator","architecture","build-tool","cli","code-generation","code-generator","flask","flask-build-tool","flask-extension"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ozanonurtek.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}},"created_at":"2018-02-01T17:50:57.000Z","updated_at":"2024-02-29T04:50:30.000Z","dependencies_parsed_at":"2022-08-26T05:02:04.612Z","dependency_job_id":null,"html_url":"https://github.com/ozanonurtek/flask-now","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ozanonurtek%2Fflask-now","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ozanonurtek%2Fflask-now/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ozanonurtek%2Fflask-now/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ozanonurtek%2Fflask-now/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ozanonurtek","download_url":"https://codeload.github.com/ozanonurtek/flask-now/tar.gz/refs/heads/master","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":["app-generator","architecture","build-tool","cli","code-generation","code-generator","flask","flask-build-tool","flask-extension"],"created_at":"2024-08-13T07:04:29.412Z","updated_at":"2024-12-19T01:11:01.391Z","avatar_url":"https://github.com/ozanonurtek.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e \n\u003cimg src=\"../master/images/logo.png\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003eFlask-Now is a Flask Application Generator/Build-Tool runs via CLI\u003c/p\u003e \n\n## What is Flask-Now\nSince Flask is commonly used in kickstarting a project, developers shouldn't waste their time with creating folders like static/css, static/js, configuration, controllers, models etc. Aim of Flask-Now is __*auto generating necessity folders and files according to your architectural pattern and semi-automatically installing desired flask extension*__. Since Flask is very flexible microframework, it may fit many architectural pattern. Currently following patterns can be auto generated using Flask-Now:\n\n### Supported Patterns\nFlask-Now supports two different patterns:\n\n#### simple\n- It is a very simple flask application structure for very small applications\n```\n/your_project_folder\n    venv\n    run.py\n    config.py\n    models.py\n    requirements.txt\n```\n\n#### bp (Known as blueprints)\n- As suggested in [official tutorial](https://flask.palletsprojects.com/en/1.1.x/blueprints/), Flask Now has a similar folder structure which is called as bp:\n```\n\n/your_project_folder\n    venv\n    run.py\n    requirements.txt\n    /project\n        __init__.py\n        /blueprints\n            /index -\u003e an example blueprint\n                __init__.py\n                controller.py\n                forms.py  \n        models.py\n        config.py\n        /static\n            /css\n                style.css\n            /js\n                script.js\n        /templates\n            index.html\n```\n\n## How to use\n\n#### Requirements\n- Python 3.x\n- Virtualenvironment\n- pip3\n\nLet me explain this project with an example. Assume that we want to create an Flask Application called ```flaskr```\n\n### GNU/Linux - OSX\n\n#### Install\n- Install flask-now with pip to your global environment, this will add an executable file to your /bin with the name flask-now which is the runnable application:\n```\nsudo pip3 install flask-now\n```\n#### Usage\n- Go to the folder you wish to create the project:\n```\ncd my_development_folder\n```\n- Create the app! Let's assume that we want to create an app named 'flaskr' with simple pattern with flask-wtf and flask-sqlalchemy installed\n\n```\nflask-now flaskr simple -e sqlalchemy wtf\n\n```\n- That's it. Now activate the virtualenv and run the project:\n```\ncd flaskr \u0026\u0026 source/venv/bin/activate \u0026\u0026 python run.py\n```\n- As you can understand from the example we drop Flask keyword while installing flask extensions to our project.\n\n- Some examples which may confuse you:\n  - Flask-Rest-Jsonapi -\u003e rest-jsonapi\n  - Frozen-Flask -\u003e frozen\n\n### Uninstall\nTo uninstall :\n```sudo pip3 uninstall flask-now```\n## TODO\n\n- Adding more architectural patterns.\n- Adding more options for configuration file.\n- Adding smart code generation according to desired extensions.(for example if you install Flask-SqlAlchemy, sample model, imports and db configurations will be ready)\n\n\n## RoadMap\n- Generate architecture for rest api's via using [Flask-RESTPlus](https://flask-restplus.readthedocs.io/en/stable/) planned version: 0.3.0. New architectural pattern :+1:\n- Adding flask-admin via using [Flask-Admin](https://flask-admin.readthedocs.io/en/latest/) planned version: 0.4.0. New architectural pattern :+1:\n- Decide if application will be renamed as flask-up, maybe both will be used while calling from console. [Naming proposal](https://github.com/ozanonurtek/flask-now/issues/5) which is started under [this reddit post](https://www.reddit.com/r/flask/comments/ddtprp/flasknow_flask_app_generator_v021/). Not planned yet.\n\n## ChangeLog\n\n- 0.2.1 project recreated.\n- 0.2.2 \n    - Thanks to [this issue](https://github.com/ozanonurtek/flask-now/pull/6) which is created by [c-w](https://github.com/c-w), flask-now perfectly works on Windows. :clap:\n    - RoadMap and ChangeLog added.\n    - Minor addition: flask-now waits for confirmation to create your project if given project name exists as folder. \n\n\n## Contribution\n\nPlease feel free to contribute to this project, open issues, fork it, send pull requests.\n\nYou can also send email to my mail adress.__ozanonurtek@gmail.com__\n\nHappy coding :metal:\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fozanonurtek%2Fflask-now","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fozanonurtek%2Fflask-now","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fozanonurtek%2Fflask-now/lists"}