| Name | flask-make JSON |
| Version |
1.0.6
JSON |
| download |
| home_page | None |
| Summary | A custom CLI command to create a new Flask app with a basic structure, creates virtual environment and installs requirements |
| upload_time | 2024-11-12 17:17:38 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
app
flask
template
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# flask-make
`flask-make` is a Python package that helps you quickly set up a new Flask project with a predefined directory structure. This CLI tool creates the app folder, a virtual environment, installs Flask, and generates an organized directory structure for you, including templates, static files, and configuration files.
## Features
- **Automated Project Setup**: Sets up a new Flask app with a standard directory structure.
- **Virtual Environment Creation**: Automatically creates and activates a virtual environment in the project directory.
- **Dependency Installation**: Installs Flask and generates a `requirements.txt` file with installed dependencies.
- **Structured Template**: Comes with organized folders for static files, templates, configuration, and the main app file, ready for development.
## Installation
To install `flask-make`, simply use pip:
```bash
pip install flask-make
```
## Usage
Once installed, you can create a new Flask app by running the `flask-make` command in your terminal:
```bash
flask-make <app-name>
```
Replace `<app-name>` with the desired name of your new Flask project folder.
### Example
```bash
flask-make my_flask_app
```
This will:
1. Create a folder named `my_flask_app`.
2. Set up a virtual environment within `my_flask_app/venv`.
3. Install Flask in the virtual environment.
4. Generate a `requirements.txt` file listing installed packages.
5. Create a structured directory layout:
```
my_flask_app/
├── app.py
├── config.py
├── requirements.txt
├── static/
│ ├── css/
│ ├── js/
│ └── img/
├── templates/
│ └── index.html
└── venv/
```
6. Display instructions to activate the virtual environment.
### Activating the Virtual Environment
After creating the project, activate the virtual environment:
#### On Windows
```bash
cd my_flask_app
venv\Scripts\activate
```
#### On macOS/Linux
```bash
cd my_flask_app
source venv/bin/activate
```
## License
This project is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": null,
"name": "flask-make",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "app, flask, template",
"author": null,
"author_email": "Dilraj Singh <dilraj082@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/b9/42/33f7142b542c3260d1bae092f2004ea90d877f8704722265d4ec742fbf93/flask_make-1.0.6.tar.gz",
"platform": null,
"description": "# flask-make\n\n`flask-make` is a Python package that helps you quickly set up a new Flask project with a predefined directory structure. This CLI tool creates the app folder, a virtual environment, installs Flask, and generates an organized directory structure for you, including templates, static files, and configuration files.\n\n## Features\n- **Automated Project Setup**: Sets up a new Flask app with a standard directory structure.\n- **Virtual Environment Creation**: Automatically creates and activates a virtual environment in the project directory.\n- **Dependency Installation**: Installs Flask and generates a `requirements.txt` file with installed dependencies.\n- **Structured Template**: Comes with organized folders for static files, templates, configuration, and the main app file, ready for development.\n\n## Installation\n\nTo install `flask-make`, simply use pip:\n\n```bash\npip install flask-make\n```\n\n## Usage\n\nOnce installed, you can create a new Flask app by running the `flask-make` command in your terminal:\n\n```bash\nflask-make <app-name>\n```\n\nReplace `<app-name>` with the desired name of your new Flask project folder.\n\n### Example\n```bash\nflask-make my_flask_app\n```\n\nThis will:\n1. Create a folder named `my_flask_app`.\n2. Set up a virtual environment within `my_flask_app/venv`.\n3. Install Flask in the virtual environment.\n4. Generate a `requirements.txt` file listing installed packages.\n5. Create a structured directory layout:\n ```\n my_flask_app/\n \u251c\u2500\u2500 app.py\n \u251c\u2500\u2500 config.py\n \u251c\u2500\u2500 requirements.txt\n \u251c\u2500\u2500 static/\n \u2502 \u251c\u2500\u2500 css/\n \u2502 \u251c\u2500\u2500 js/\n \u2502 \u2514\u2500\u2500 img/\n \u251c\u2500\u2500 templates/\n \u2502 \u2514\u2500\u2500 index.html\n \u2514\u2500\u2500 venv/\n ```\n\n6. Display instructions to activate the virtual environment.\n\n### Activating the Virtual Environment\n\nAfter creating the project, activate the virtual environment:\n\n#### On Windows\n```bash\ncd my_flask_app\nvenv\\Scripts\\activate\n```\n\n#### On macOS/Linux\n```bash\ncd my_flask_app\nsource venv/bin/activate\n```\n\n## License\nThis project is licensed under the MIT License.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A custom CLI command to create a new Flask app with a basic structure, creates virtual environment and installs requirements",
"version": "1.0.6",
"project_urls": {
"Homepage": "https://github.com/dilrajs616/flask-make",
"Issues": "https://github.com/dilrajs616/flask-make/discussions"
},
"split_keywords": [
"app",
" flask",
" template"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d184207027b6928abb280af7cf3f8f7683ffe415d17ef99208c2e343eedee808",
"md5": "99507f4d71e87c6d3f48eb21982887b7",
"sha256": "2755bf222500a70b5cfc1bd4d46ab1333bb592beabb7c487e27ad0c14a2229f8"
},
"downloads": -1,
"filename": "flask_make-1.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "99507f4d71e87c6d3f48eb21982887b7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6676,
"upload_time": "2024-11-12T17:17:37",
"upload_time_iso_8601": "2024-11-12T17:17:37.094637Z",
"url": "https://files.pythonhosted.org/packages/d1/84/207027b6928abb280af7cf3f8f7683ffe415d17ef99208c2e343eedee808/flask_make-1.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b94233f7142b542c3260d1bae092f2004ea90d877f8704722265d4ec742fbf93",
"md5": "6e8ea0307a265f4c09b0a0b2231ded68",
"sha256": "363411c42653bf1a0e01672eac017c0d037978c45e22cc89a4402e376e11ef6f"
},
"downloads": -1,
"filename": "flask_make-1.0.6.tar.gz",
"has_sig": false,
"md5_digest": "6e8ea0307a265f4c09b0a0b2231ded68",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7083,
"upload_time": "2024-11-12T17:17:38",
"upload_time_iso_8601": "2024-11-12T17:17:38.665655Z",
"url": "https://files.pythonhosted.org/packages/b9/42/33f7142b542c3260d1bae092f2004ea90d877f8704722265d4ec742fbf93/flask_make-1.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-12 17:17:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dilrajs616",
"github_project": "flask-make",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "flask-make"
}
