# Struct-Maker
**Struct=Maker** is a command-line tool that automates the creation of folder structures for new projects. It allows you to quickly set up the basic folder and file structure for software projects, ensuring organization and consistency from the start.
## Features
- Automatically creates folders and subfolders commonly used in projects.
- Flexible configuration for different types of projects (web, API, scripts, etc.).
- Generates base files like `.gitignore` and `README.md`.
- Easy to use and configure.
## Installation
You can install* **Struct-Maker* via `pip`:
```bash
pip install structmaker
Usage
After installation, you can create the folder structure for your new project with the following command:
bash
structmaker create my_new_project
This will create the following folder structure inside the my_new_project directory:
plaintext
my_new_project/
│
├── src/
│ ├── assets/
│ ├── components/
│ ├── services/
│ ├── utils/
│ ├── styles/
│ ├── config/
│ ├── models/
│ ├── views/
│ └── main.*
│
├── public/
│ ├── index.html
│ └── ...
│
├── tests/
│ ├── unit/
│ ├── integration/
│ └── ...
│
├── build/
│ └── ...
│
├── docs/
│ └── ...
│
├── scripts/
│ └── ...
│
├── .gitignore
├── README.md
└── ...
Contributing
Contributions are welcome! Feel free to open issues or submit pull requests on the GitHub repository.
License
This project is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": "https://github.com/LucasAmerico0101/Struct-Maker",
"name": "struct-maker",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Lucas Americo",
"author_email": "lucasamerico695@tutamail.com",
"download_url": "https://files.pythonhosted.org/packages/6d/ff/10bf88329c9e8618e07fb1335616e77cd696f7ed4e388035f34906003101/struct_maker-0.1.0.tar.gz",
"platform": null,
"description": "# Struct-Maker\r\n\r\n**Struct=Maker** is a command-line tool that automates the creation of folder structures for new projects. It allows you to quickly set up the basic folder and file structure for software projects, ensuring organization and consistency from the start.\r\n\r\n## Features\r\n\r\n- Automatically creates folders and subfolders commonly used in projects.\r\n- Flexible configuration for different types of projects (web, API, scripts, etc.).\r\n- Generates base files like `.gitignore` and `README.md`.\r\n- Easy to use and configure.\r\n\r\n## Installation\r\n\r\nYou can install* **Struct-Maker* via `pip`:\r\n\r\n```bash\r\npip install structmaker\r\n\r\nUsage\r\n\r\nAfter installation, you can create the folder structure for your new project with the following command:\r\n\r\nbash\r\n\r\nstructmaker create my_new_project\r\n\r\nThis will create the following folder structure inside the my_new_project directory:\r\n\r\nplaintext\r\n\r\nmy_new_project/\r\n\u00e2\u201d\u201a\r\n\u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac src/\r\n\u00e2\u201d\u201a \u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac assets/\r\n\u00e2\u201d\u201a \u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac components/\r\n\u00e2\u201d\u201a \u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac services/\r\n\u00e2\u201d\u201a \u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac utils/\r\n\u00e2\u201d\u201a \u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac styles/\r\n\u00e2\u201d\u201a \u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac config/\r\n\u00e2\u201d\u201a \u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac models/\r\n\u00e2\u201d\u201a \u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac views/\r\n\u00e2\u201d\u201a \u00e2\u201d\u201d\u00e2\u201d\u20ac\u00e2\u201d\u20ac main.*\r\n\u00e2\u201d\u201a\r\n\u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac public/\r\n\u00e2\u201d\u201a \u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac index.html\r\n\u00e2\u201d\u201a \u00e2\u201d\u201d\u00e2\u201d\u20ac\u00e2\u201d\u20ac ...\r\n\u00e2\u201d\u201a\r\n\u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac tests/\r\n\u00e2\u201d\u201a \u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac unit/\r\n\u00e2\u201d\u201a \u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac integration/\r\n\u00e2\u201d\u201a \u00e2\u201d\u201d\u00e2\u201d\u20ac\u00e2\u201d\u20ac ...\r\n\u00e2\u201d\u201a\r\n\u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac build/\r\n\u00e2\u201d\u201a \u00e2\u201d\u201d\u00e2\u201d\u20ac\u00e2\u201d\u20ac ...\r\n\u00e2\u201d\u201a\r\n\u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac docs/\r\n\u00e2\u201d\u201a \u00e2\u201d\u201d\u00e2\u201d\u20ac\u00e2\u201d\u20ac ...\r\n\u00e2\u201d\u201a\r\n\u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac scripts/\r\n\u00e2\u201d\u201a \u00e2\u201d\u201d\u00e2\u201d\u20ac\u00e2\u201d\u20ac ...\r\n\u00e2\u201d\u201a\r\n\u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac .gitignore\r\n\u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac README.md\r\n\u00e2\u201d\u201d\u00e2\u201d\u20ac\u00e2\u201d\u20ac ...\r\n\r\nContributing\r\n\r\nContributions are welcome! Feel free to open issues or submit pull requests on the GitHub repository.\r\nLicense\r\n\r\nThis project is licensed under the MIT License.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A command-line tool for automating project folder structure creation.",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://github.com/LucasAmerico0101/Struct-Maker#readme",
"Homepage": "https://github.com/LucasAmerico0101/Struct-Maker",
"Source": "https://github.com/LucasAmerico0101/Struct-Maker"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6dff10bf88329c9e8618e07fb1335616e77cd696f7ed4e388035f34906003101",
"md5": "60ac12d9b32bb1c93a413fab4471c4e0",
"sha256": "b917c080085b49a2bf787579af0fd843d705eacf2fe2da0f4f97143bfc406428"
},
"downloads": -1,
"filename": "struct_maker-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "60ac12d9b32bb1c93a413fab4471c4e0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 2514,
"upload_time": "2024-08-20T04:36:30",
"upload_time_iso_8601": "2024-08-20T04:36:30.558318Z",
"url": "https://files.pythonhosted.org/packages/6d/ff/10bf88329c9e8618e07fb1335616e77cd696f7ed4e388035f34906003101/struct_maker-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-20 04:36:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "LucasAmerico0101",
"github_project": "Struct-Maker",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "struct-maker"
}
JSON
