# project_master : Project Structure Generator
This Python script generates a standardized project structure for your Python projects. It creates the necessary folders and files based on your specifications.
---
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Usage](#usage)
- [Parameters](#parameters)
- [Example](#example)
- [Contributing](#contributing)
- [License](#license)
---
## Introduction
The Project Structure Generator is a handy tool for Python developers to quickly set up the directory structure for their projects. It automates the creation of common directories and files, saving time and ensuring consistency across projects.
---
## Features
- Supports two modes: standard mode and pro mode.
- Standard mode creates basic project structure with essential folders and files.
- Pro mode includes additional folders and files for more comprehensive projects.
- Customizable project name and directory structure.
---
## Usage
```bash
pip install project_master
```
Let's say you want to create a new project called "MyAwesomeProject" in pro mode. You would run the following command:
```python
from project_master import Cat
Cat.build_structure(project_name="MyAwesomeProject", developer_name="Hardy21", pro_mode=True)
```
- `project_name`: Name of the project (root directory name).
- `pro_mode`: (Optional) If set to `True`, creates a more comprehensive project structure. Default is `False`.
This will create the following directory structure:
```
MyAwesomeProject/
│
├── dev/
├── src/
├── tests/
├── utils/
├── docs/
├── data/
├── config/
├── logs/
│
├── requirements.txt
├── README.md
├── LICENSE
├── .gitignore
├── requirements-dev.txt
├── setup.py
├── CHANGELOG.md
├── CONTRIBUTING.md
├── CODE_OF_CONDUCT.md
├── MANIFEST.in
└── pyproject.toml
```
---
## Contributing
Contributions are welcome! If you have any ideas, suggestions, or improvements, feel free to open an issue or submit a pull request.
---
## License
This project is provided under the BSD License.
For more information, please see the [LICENSE](LICENSE) file.
---
Raw data
{
"_id": null,
"home_page": "https://github.com/Armen-Jean-Andreasian",
"name": "project-master",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "project, directory, python",
"author": "Armen-Jean Andreasian",
"author_email": "armen_andreasian@proton.me",
"download_url": "https://files.pythonhosted.org/packages/f3/d7/589a7a8b46baeebd1a1697ba2c078406e0ff484e64806dda2bccd6a13f10/project_master-1.3.tar.gz",
"platform": null,
"description": "# project_master : Project Structure Generator\r\n\r\nThis Python script generates a standardized project structure for your Python projects. It creates the necessary folders and files based on your specifications.\r\n\r\n---\r\n\r\n## Table of Contents\r\n\r\n- [Introduction](#introduction)\r\n- [Features](#features)\r\n- [Usage](#usage)\r\n- [Parameters](#parameters)\r\n- [Example](#example)\r\n- [Contributing](#contributing)\r\n- [License](#license)\r\n\r\n---\r\n\r\n## Introduction\r\n\r\nThe Project Structure Generator is a handy tool for Python developers to quickly set up the directory structure for their projects. It automates the creation of common directories and files, saving time and ensuring consistency across projects.\r\n\r\n---\r\n\r\n## Features\r\n\r\n- Supports two modes: standard mode and pro mode.\r\n- Standard mode creates basic project structure with essential folders and files.\r\n- Pro mode includes additional folders and files for more comprehensive projects.\r\n- Customizable project name and directory structure.\r\n\r\n---\r\n\r\n## Usage\r\n\r\n```bash\r\npip install project_master\r\n```\r\n\r\nLet's say you want to create a new project called \"MyAwesomeProject\" in pro mode. You would run the following command:\r\n\r\n\r\n```python\r\nfrom project_master import Cat\r\n\r\nCat.build_structure(project_name=\"MyAwesomeProject\", developer_name=\"Hardy21\", pro_mode=True)\r\n```\r\n\r\n\r\n- `project_name`: Name of the project (root directory name).\r\n- `pro_mode`: (Optional) If set to `True`, creates a more comprehensive project structure. Default is `False`.\r\n\r\n\r\nThis will create the following directory structure:\r\n\r\n```\r\nMyAwesomeProject/\r\n\u2502\r\n\u251c\u2500\u2500 dev/\r\n\u251c\u2500\u2500 src/\r\n\u251c\u2500\u2500 tests/\r\n\u251c\u2500\u2500 utils/\r\n\u251c\u2500\u2500 docs/\r\n\u251c\u2500\u2500 data/\r\n\u251c\u2500\u2500 config/\r\n\u251c\u2500\u2500 logs/\r\n\u2502\r\n\u251c\u2500\u2500 requirements.txt\r\n\u251c\u2500\u2500 README.md\r\n\u251c\u2500\u2500 LICENSE\r\n\u251c\u2500\u2500 .gitignore\r\n\u251c\u2500\u2500 requirements-dev.txt\r\n\u251c\u2500\u2500 setup.py\r\n\u251c\u2500\u2500 CHANGELOG.md\r\n\u251c\u2500\u2500 CONTRIBUTING.md\r\n\u251c\u2500\u2500 CODE_OF_CONDUCT.md\r\n\u251c\u2500\u2500 MANIFEST.in\r\n\u2514\u2500\u2500 pyproject.toml\r\n```\r\n\r\n\r\n---\r\n\r\n\r\n## Contributing\r\n\r\nContributions are welcome! If you have any ideas, suggestions, or improvements, feel free to open an issue or submit a pull request.\r\n\r\n\r\n---\r\n\r\n## License\r\n\r\nThis project is provided under the BSD License.\r\n\r\nFor more information, please see the [LICENSE](LICENSE) file.\r\n\r\n---\r\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "This Python script generates a standardized project structure for your Python projects. It creates the necessary folders and files based on your specifications.",
"version": "1.3",
"project_urls": {
"Homepage": "https://github.com/Armen-Jean-Andreasian"
},
"split_keywords": [
"project",
" directory",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f3d7589a7a8b46baeebd1a1697ba2c078406e0ff484e64806dda2bccd6a13f10",
"md5": "50b2f08993b7cb39bb26a4bb41360f9d",
"sha256": "3848e3723ce51aa281930797662d536e204707f184d91450a5158a1441500645"
},
"downloads": -1,
"filename": "project_master-1.3.tar.gz",
"has_sig": false,
"md5_digest": "50b2f08993b7cb39bb26a4bb41360f9d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4541,
"upload_time": "2024-04-22T09:30:55",
"upload_time_iso_8601": "2024-04-22T09:30:55.137186Z",
"url": "https://files.pythonhosted.org/packages/f3/d7/589a7a8b46baeebd1a1697ba2c078406e0ff484e64806dda2bccd6a13f10/project_master-1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-22 09:30:55",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "project-master"
}
JSON