# flask-generator
A Library to generate a Flask app.
# Table of Contents
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Features](#features)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## Prerequisites
Before installing, make sure you have the following installed:
- Python 3.x
- pip
## Installation
### Installing via pip
Install the library using `pip`:
```sh
pip install flask-app-gen
```
### Manual Installation
If you prefer, you can manually install the library by cloning the repository:
```sh
git clone https://github.com/sushmithapopuri/flask-generator.git
cd flask-generator
pip install .
```
## Usage
### App Generation
this command helps to generate a skeleton flask app.
```sh
scaffold new <app-name>
```
Installing requirements and the app is ready
```sh
cd <app-name>
pip install -r requirements.txt
```
### Resource Generation
Generating a controller, a model and a view made simple
```sh
scaffold generate scaffold posts author:string description:text
```
For generating a controller/ model alone:
```sh
scaffold generate model posts author:string description:text
scaffold generate controller posts author:string description:text
scaffold generate view posts author:string description:text
```
### Starting the App
Migrating the DB, SQLITE here using flask-migrate and the app is ready for demo
```sh
flask db init
flask db migrate
flask db upgrade
flask run
```
## Features
<ol>
<li> Generate a Flask application from scratch</li>
<li> Create controllers, views with simple commands in rails style</li>
<li> Web pages neatly aligned</li>
<li> Cleanup of code using destroy command</li>
</ol>
## Contributing
Contributions are welcome! Please follow these steps:
<ol>
<li>Fork the repository.</li>
<li>Create a new branch: git checkout -b feature-branch.</li>
<li>Make your changes.
<li>Commit your changes: git commit -m 'Add some feature'.</li>
<li>Push to the branch: git push origin feature-branch.</li>
<li>Open a pull request.</li>
</ol>
## License
This project is licensed under the MIT License - see the LICENSE file for details.
## Contact
For any questions, issues, or suggestions, please reach out:
Maintainer: Sushmitha Popuri
Email: sushmithapopuri@ymail.com
Raw data
{
"_id": null,
"home_page": null,
"name": "flask-app-gen",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": "Python, Flask, FlaskPython, FlaskWebFramework, FlaskWebDevelopment, CodeGeneration, FlaskDeveloperTools, FlaskRapidDevelopment, FlaskDevTools, scaffold, FlaskScaffold, FlaskAPIDevelopment, Instant App",
"author": "Sushmitha Popuri",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b4/1d/f87bc1acdc8e51c3696550ff8380884d8bfdb4003245d6374a4920a75a5d/flask_app_gen-1.tar.gz",
"platform": null,
"description": "# flask-generator\nA Library to generate a Flask app.\n\n# Table of Contents\n- [Prerequisites](#prerequisites)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Features](#features)\n- [Contributing](#contributing)\n- [License](#license)\n- [Contact](#contact)\n\n## Prerequisites\n\nBefore installing, make sure you have the following installed:\n\n- Python 3.x\n- pip\n\n## Installation\n\n### Installing via pip\nInstall the library using `pip`:\n\n```sh\npip install flask-app-gen\n```\n### Manual Installation\nIf you prefer, you can manually install the library by cloning the repository:\n```sh\ngit clone https://github.com/sushmithapopuri/flask-generator.git\ncd flask-generator\npip install .\n```\n## Usage\n### App Generation\nthis command helps to generate a skeleton flask app.\n```sh\nscaffold new <app-name>\n```\nInstalling requirements and the app is ready\n```sh\ncd <app-name>\npip install -r requirements.txt\n```\n### Resource Generation\nGenerating a controller, a model and a view made simple\n```sh\nscaffold generate scaffold posts author:string description:text\n```\nFor generating a controller/ model alone:\n```sh\nscaffold generate model posts author:string description:text\nscaffold generate controller posts author:string description:text\nscaffold generate view posts author:string description:text\n```\n### Starting the App\nMigrating the DB, SQLITE here using flask-migrate and the app is ready for demo\n```sh\nflask db init\nflask db migrate\nflask db upgrade\nflask run\n```\n\n## Features\n\n<ol>\n<li> Generate a Flask application from scratch</li>\n<li> Create controllers, views with simple commands in rails style</li>\n<li> Web pages neatly aligned</li>\n<li> Cleanup of code using destroy command</li>\n</ol>\n\n## Contributing\nContributions are welcome! Please follow these steps:\n<ol>\n<li>Fork the repository.</li>\n<li>Create a new branch: git checkout -b feature-branch.</li>\n<li>Make your changes.\n<li>Commit your changes: git commit -m 'Add some feature'.</li>\n<li>Push to the branch: git push origin feature-branch.</li>\n<li>Open a pull request.</li>\n</ol>\n\n## License\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n## Contact\nFor any questions, issues, or suggestions, please reach out:\n\nMaintainer: Sushmitha Popuri\nEmail: sushmithapopuri@ymail.com\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Library for Generating Flask Applications in Rails-like Style",
"version": "1",
"project_urls": null,
"split_keywords": [
"python",
" flask",
" flaskpython",
" flaskwebframework",
" flaskwebdevelopment",
" codegeneration",
" flaskdevelopertools",
" flaskrapiddevelopment",
" flaskdevtools",
" scaffold",
" flaskscaffold",
" flaskapidevelopment",
" instant app"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "962233e5aa5574c3cf7b1834cbc4ec9eb595a05f5f3f9038a523a27d34e70bf5",
"md5": "16d353d0d9b0150989560329a7bf60c2",
"sha256": "cf14f33429eb224da08f64c79c725db8f00af37079c88def2d67a4b039edeee4"
},
"downloads": -1,
"filename": "flask_app_gen-1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "16d353d0d9b0150989560329a7bf60c2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 18710,
"upload_time": "2024-08-14T16:30:26",
"upload_time_iso_8601": "2024-08-14T16:30:26.758585Z",
"url": "https://files.pythonhosted.org/packages/96/22/33e5aa5574c3cf7b1834cbc4ec9eb595a05f5f3f9038a523a27d34e70bf5/flask_app_gen-1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b41df87bc1acdc8e51c3696550ff8380884d8bfdb4003245d6374a4920a75a5d",
"md5": "bfd888efd8e163eafa4c361236785ff4",
"sha256": "133d34df86792179fe51d1dfe6d0aeedc787f508f60d37cdf0a0275e26b9a6c8"
},
"downloads": -1,
"filename": "flask_app_gen-1.tar.gz",
"has_sig": false,
"md5_digest": "bfd888efd8e163eafa4c361236785ff4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 16061,
"upload_time": "2024-08-14T16:30:28",
"upload_time_iso_8601": "2024-08-14T16:30:28.160407Z",
"url": "https://files.pythonhosted.org/packages/b4/1d/f87bc1acdc8e51c3696550ff8380884d8bfdb4003245d6374a4920a75a5d/flask_app_gen-1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-14 16:30:28",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "flask-app-gen"
}
JSON