# PIP CREATOR | FLASK
## Overview
This PIP CREATOR Plugin automates the creation of all necessary files and folders to set up a Flask application. You can choose between three types of Flask apps: **Basic**, **Advanced**, and **With Framework**. The plugin also supports additional features like virtual environment creation, git initialization, and CDN framework integration for front-end development.
## Features
1. **App Types**:
- **Basic**: Simple Flask structure with static files, templates, and virtual environment.
- **Advanced**: More structured Flask project with Blueprints, models, forms, and configuration files.
- **With Framework**: Flask integrated with front-end frameworks like React, Next.js, or Vite. Custom frameworks are also supported.
2. **Virtual Environment**: Automatically creates a Python virtual environment (`venv`) for safe package management.
3. **Git Initialization**: Optionally initialize a git repository with `.gitignore` and create a proper project structure.
4. **Test Folder**: Creates a test folder if required by the user.
5. **CDN Frameworks**: Easy integration with popular CSS frameworks via CDN:
- Bootstrap (v5.3.2)
- Foundation (v6.6.3)
- Materialize (v1.0.0)
- Bulma (v0.9.4)
- Semantic UI (v2.4.2)
- UIkit (v3.16.23)
- Tailwind (v3.3.3)
- Pure CSS (v2.1.0)
- Spectre.css (v0.5.9)
- Skeleton (v2.0.4)
[CDN Frameworks](https://github.com/rakeshkanna-rk/pipc-flask-app/blob/master/docs/CDN%20FRAMEWORKS.MD)
---
## App Structures
### 1. **Basic Flask App**
```
{project_name}/
│
├── static/
│ ├── css/
│ │ └── style.css
│ ├── js/
│ └── images/
├── templates/
│ ├── layout.html
│ └── home.html
├── test/ (optional)
│ ├── test_basic.py
│ └── conftest.py
├── venv/
├── README.md
├── run.py
├── requirements.txt
├── pyproject.toml
├── LICENSE
└── .gitignore
```
### 2. **Advanced Flask App**
```
{project_name}/
│
├── app/
│ ├── __init__.py
│ ├── routes.py
│ ├── models.py
│ ├── forms.py
│ ├── static/
│ │ ├── css/
│ │ │ └── style.css
│ │ ├── js/
│ │ └── images/
│ └── templates/
│ ├── layout.html
│ └── home.html
│
├── tests/ (optional)
│ ├── test_basic.py
│ └── conftest.py
├── config.py
├── README.md
├── run.py
├── requirements.txt
├── pyproject.toml
├── LICENSE
├── venv/
├── instance/
│ └── config.py
├── migrations/
└── .env or .flaskenv
```
### 3. **Flask App With Front-End Framework**
```
{project_name}/
│
├── client/
│ └── <framework>/
│
├── server/
│ ├── __init__.py
│ ├── routes.py
│ ├── models.py
│ ├── forms.py
│ ├── static/
│ │ ├── css/
│ │ │ └── style.css
│ │ ├── js/
│ │ └── images/
│ └── templates/
│ ├── layout.html
│ └── home.html
│
├── tests/ (optional)
│ ├── test_basic.py
│ └── conftest.py
├── venv/
├── config.py
├── README.md
├── run.py
├── requirements.txt
├── pyproject.toml
├── LICENSE
└── .gitignore
```
Framework options: **React**, **Next.js**, **Vite**. Custom frameworks can be installed with commands like `npx create-next-app`.
---
## Installation
1. Install the plugin: `pip install pipc-flask` else `pipc install pipc.flask-app --plugin` if you have pipCreator installed.
2. Run the script to create the Flask app:
```bash
pipc-flask create <project_name>
```
Raw data
{
"_id": null,
"home_page": null,
"name": "pipc-flask-app",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "plugin, flask, app, pipcreator",
"author": "Rakesh Kanna",
"author_email": "rakeshkanna0108@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b0/26/b808104863756b868fd21d6263a85338b8e15650b6bb4029a7248bf55db2/pipc_flask_app-0.1.0.tar.gz",
"platform": null,
"description": "# PIP CREATOR | FLASK\r\n\r\n## Overview\r\nThis PIP CREATOR Plugin automates the creation of all necessary files and folders to set up a Flask application. You can choose between three types of Flask apps: **Basic**, **Advanced**, and **With Framework**. The plugin also supports additional features like virtual environment creation, git initialization, and CDN framework integration for front-end development.\r\n\r\n## Features\r\n1. **App Types**:\r\n - **Basic**: Simple Flask structure with static files, templates, and virtual environment.\r\n - **Advanced**: More structured Flask project with Blueprints, models, forms, and configuration files.\r\n - **With Framework**: Flask integrated with front-end frameworks like React, Next.js, or Vite. Custom frameworks are also supported.\r\n\r\n2. **Virtual Environment**: Automatically creates a Python virtual environment (`venv`) for safe package management.\r\n\r\n3. **Git Initialization**: Optionally initialize a git repository with `.gitignore` and create a proper project structure.\r\n\r\n4. **Test Folder**: Creates a test folder if required by the user.\r\n\r\n5. **CDN Frameworks**: Easy integration with popular CSS frameworks via CDN:\r\n - Bootstrap (v5.3.2)\r\n - Foundation (v6.6.3)\r\n - Materialize (v1.0.0)\r\n - Bulma (v0.9.4)\r\n - Semantic UI (v2.4.2)\r\n - UIkit (v3.16.23)\r\n - Tailwind (v3.3.3)\r\n - Pure CSS (v2.1.0)\r\n - Spectre.css (v0.5.9)\r\n - Skeleton (v2.0.4)\r\n\r\n [CDN Frameworks](https://github.com/rakeshkanna-rk/pipc-flask-app/blob/master/docs/CDN%20FRAMEWORKS.MD)\r\n\r\n---\r\n\r\n## App Structures\r\n\r\n### 1. **Basic Flask App**\r\n```\r\n{project_name}/\r\n\u2502\r\n\u251c\u2500\u2500 static/\r\n\u2502 \u251c\u2500\u2500 css/\r\n\u2502 \u2502 \u2514\u2500\u2500 style.css\r\n\u2502 \u251c\u2500\u2500 js/\r\n\u2502 \u2514\u2500\u2500 images/\r\n\u251c\u2500\u2500 templates/\r\n\u2502 \u251c\u2500\u2500 layout.html\r\n\u2502 \u2514\u2500\u2500 home.html\r\n\u251c\u2500\u2500 test/ (optional)\r\n\u2502 \u251c\u2500\u2500 test_basic.py\r\n\u2502 \u2514\u2500\u2500 conftest.py\r\n\u251c\u2500\u2500 venv/\r\n\u251c\u2500\u2500 README.md\r\n\u251c\u2500\u2500 run.py\r\n\u251c\u2500\u2500 requirements.txt\r\n\u251c\u2500\u2500 pyproject.toml\r\n\u251c\u2500\u2500 LICENSE\r\n\u2514\u2500\u2500 .gitignore\r\n```\r\n\r\n### 2. **Advanced Flask App**\r\n```\r\n{project_name}/\r\n\u2502\r\n\u251c\u2500\u2500 app/\r\n\u2502 \u251c\u2500\u2500 __init__.py\r\n\u2502 \u251c\u2500\u2500 routes.py\r\n\u2502 \u251c\u2500\u2500 models.py\r\n\u2502 \u251c\u2500\u2500 forms.py\r\n\u2502 \u251c\u2500\u2500 static/\r\n\u2502 \u2502 \u251c\u2500\u2500 css/\r\n\u2502 \u2502 \u2502 \u2514\u2500\u2500 style.css\r\n\u2502 \u2502 \u251c\u2500\u2500 js/\r\n\u2502 \u2502 \u2514\u2500\u2500 images/\r\n\u2502 \u2514\u2500\u2500 templates/\r\n\u2502 \u251c\u2500\u2500 layout.html\r\n\u2502 \u2514\u2500\u2500 home.html\r\n\u2502\r\n\u251c\u2500\u2500 tests/ (optional)\r\n\u2502 \u251c\u2500\u2500 test_basic.py\r\n\u2502 \u2514\u2500\u2500 conftest.py\r\n\u251c\u2500\u2500 config.py\r\n\u251c\u2500\u2500 README.md\r\n\u251c\u2500\u2500 run.py\r\n\u251c\u2500\u2500 requirements.txt\r\n\u251c\u2500\u2500 pyproject.toml\r\n\u251c\u2500\u2500 LICENSE\r\n\u251c\u2500\u2500 venv/\r\n\u251c\u2500\u2500 instance/\r\n\u2502 \u2514\u2500\u2500 config.py\r\n\u251c\u2500\u2500 migrations/\r\n\u2514\u2500\u2500 .env or .flaskenv\r\n```\r\n\r\n### 3. **Flask App With Front-End Framework**\r\n```\r\n{project_name}/\r\n\u2502\r\n\u251c\u2500\u2500 client/\r\n\u2502 \u2514\u2500\u2500 <framework>/\r\n\u2502 \r\n\u251c\u2500\u2500 server/\r\n\u2502 \u251c\u2500\u2500 __init__.py\r\n\u2502 \u251c\u2500\u2500 routes.py\r\n\u2502 \u251c\u2500\u2500 models.py\r\n\u2502 \u251c\u2500\u2500 forms.py\r\n\u2502 \u251c\u2500\u2500 static/\r\n\u2502 \u2502 \u251c\u2500\u2500 css/\r\n\u2502 \u2502 \u2502 \u2514\u2500\u2500 style.css\r\n\u2502 \u2502 \u251c\u2500\u2500 js/\r\n\u2502 \u2502 \u2514\u2500\u2500 images/\r\n\u2502 \u2514\u2500\u2500 templates/\r\n\u2502 \u251c\u2500\u2500 layout.html\r\n\u2502 \u2514\u2500\u2500 home.html\r\n\u2502\r\n\u251c\u2500\u2500 tests/ (optional)\r\n\u2502 \u251c\u2500\u2500 test_basic.py\r\n\u2502 \u2514\u2500\u2500 conftest.py\r\n\u251c\u2500\u2500 venv/\r\n\u251c\u2500\u2500 config.py\r\n\u251c\u2500\u2500 README.md\r\n\u251c\u2500\u2500 run.py\r\n\u251c\u2500\u2500 requirements.txt\r\n\u251c\u2500\u2500 pyproject.toml\r\n\u251c\u2500\u2500 LICENSE\r\n\u2514\u2500\u2500 .gitignore\r\n```\r\nFramework options: **React**, **Next.js**, **Vite**. Custom frameworks can be installed with commands like `npx create-next-app`.\r\n\r\n---\r\n\r\n## Installation\r\n\r\n1. Install the plugin: `pip install pipc-flask` else `pipc install pipc.flask-app --plugin` if you have pipCreator installed.\r\n2. Run the script to create the Flask app:\r\n ```bash\r\n pipc-flask create <project_name>\r\n ```\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A plugin to create flask app for pipCreator.",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [
"plugin",
" flask",
" app",
" pipcreator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "063c7988cc3f712cb885205cb896ac9586e7635861fd8f870b133b68311c131f",
"md5": "03a6bc23d29f6cf0e45276ae0175f6b8",
"sha256": "22c70b7cec22816afe954115db633d25062fbb81fee258fddfa55a5eb05cf58d"
},
"downloads": -1,
"filename": "pipc_flask_app-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "03a6bc23d29f6cf0e45276ae0175f6b8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 26476,
"upload_time": "2024-10-24T18:29:52",
"upload_time_iso_8601": "2024-10-24T18:29:52.065156Z",
"url": "https://files.pythonhosted.org/packages/06/3c/7988cc3f712cb885205cb896ac9586e7635861fd8f870b133b68311c131f/pipc_flask_app-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b026b808104863756b868fd21d6263a85338b8e15650b6bb4029a7248bf55db2",
"md5": "a05cc3da7b05836a0e152c1d06aa01d8",
"sha256": "ba58d8bfa798178366102d5a14962cbae609e67f046f7e359cfd349d1f1f2b06"
},
"downloads": -1,
"filename": "pipc_flask_app-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "a05cc3da7b05836a0e152c1d06aa01d8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 26408,
"upload_time": "2024-10-24T18:29:56",
"upload_time_iso_8601": "2024-10-24T18:29:56.824445Z",
"url": "https://files.pythonhosted.org/packages/b0/26/b808104863756b868fd21d6263a85338b8e15650b6bb4029a7248bf55db2/pipc_flask_app-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-24 18:29:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pipc-flask-app"
}
JSON