folder-structure-generator

Name	folder-structure-generator JSON
Version	0.0.2 JSON
	download
home_page
Summary	The "Folder Structure Generator" simplifies the generation of project directory structures. Easily create a predefined directory tree, copy it to project documentation or README files, and save time when setting up new projects. Eliminate manual directory creation, ensure consistency across projects, and enhance project organization.
upload_time	2023-07-03 02:45:33
maintainer
docs_url	None
author	Ujjawal Poudel
requires_python	>=3.7
license
keywords	python documentation structure
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Folder Structure Generator
Folder Structure Generator is a Python package that simplifies the generation of project directory structures. It provides an easy way to create a predefined directory tree that can be copied and pasted into project documentation or README files.

# Installation
You can install Folder Structure Generator using pip:
```
pip install folder-structure-generator
```

# Usage
To generate a project directory structure, simply run the following command:
```
from folder-structure-generator import FolderStructureGenerator
print(FolderStructureGenerator().generate_folder_structure_md())
```
This will generate a predefined directory tree in the current working directory. You can then copy and paste the generated structure into your project documentation or README file.

# Features
- Automated generation of project directory structures
- Saves time and effort when setting up new projects
- Ensures consistency across projects
- User-friendly interface for easy usage
- Enhances project organization and collaboration

# Contributing
Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue on the [GitHub repository](https://github.com/ujjawalpoudel/project-tree). We appreciate your feedback.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "folder-structure-generator",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "python,documentation,structure",
    "author": "Ujjawal Poudel",
    "author_email": "Ujjawal Poudel <ujjawalpoudel@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/59/7a/a5f68f474f1018a6505e965f7742c09f1fce5101139f78debac277a4ba60/folder-structure-generator-0.0.2.tar.gz",
    "platform": null,
    "description": "# Folder Structure Generator\nFolder Structure Generator is a Python package that simplifies the generation of project directory structures. It provides an easy way to create a predefined directory tree that can be copied and pasted into project documentation or README files.\n\n# Installation\nYou can install Folder Structure Generator using pip:\n```\npip install folder-structure-generator\n```\n\n# Usage\nTo generate a project directory structure, simply run the following command:\n```\nfrom folder-structure-generator import FolderStructureGenerator\nprint(FolderStructureGenerator().generate_folder_structure_md())\n```\nThis will generate a predefined directory tree in the current working directory. You can then copy and paste the generated structure into your project documentation or README file.\n\n# Features\n- Automated generation of project directory structures\n- Saves time and effort when setting up new projects\n- Ensures consistency across projects\n- User-friendly interface for easy usage\n- Enhances project organization and collaboration\n\n# Contributing\nContributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue on the [GitHub repository](https://github.com/ujjawalpoudel/project-tree). We appreciate your feedback.\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "The \"Folder Structure Generator\" simplifies the generation of project directory structures. Easily create a predefined directory tree, copy it to project documentation or README files, and save time when setting up new projects. Eliminate manual directory creation, ensure consistency across projects, and enhance project organization.",
    "version": "0.0.2",
    "project_urls": {
        "Bug Tracker": "https://github.com/ujjawalpoudel/folder-structure-generator/issues",
        "Repository": "https://github.com/ujjawalpoudel/folder-structure-generator"
    },
    "split_keywords": [
        "python",
        "documentation",
        "structure"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "28c5c27f871299c1c4041ad52c67c30f03be3832e8254ec8c07970debe1cf1d3",
                "md5": "b1857fda88370f181a8951f37ac843bb",
                "sha256": "2ecce061861fceab535584226b62763759f996ab0e837ab46e407a251ed023a9"
            },
            "downloads": -1,
            "filename": "folder_structure_generator-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b1857fda88370f181a8951f37ac843bb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 7134,
            "upload_time": "2023-07-03T02:45:32",
            "upload_time_iso_8601": "2023-07-03T02:45:32.540076Z",
            "url": "https://files.pythonhosted.org/packages/28/c5/c27f871299c1c4041ad52c67c30f03be3832e8254ec8c07970debe1cf1d3/folder_structure_generator-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "597aa5f68f474f1018a6505e965f7742c09f1fce5101139f78debac277a4ba60",
                "md5": "402d152a6cea5d53b1d4d8a7a398898f",
                "sha256": "b72bfc89e8043c16ee247054fc0716f1e07b13385b7111e889565aa3b48a99a2"
            },
            "downloads": -1,
            "filename": "folder-structure-generator-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "402d152a6cea5d53b1d4d8a7a398898f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 6806,
            "upload_time": "2023-07-03T02:45:33",
            "upload_time_iso_8601": "2023-07-03T02:45:33.918552Z",
            "url": "https://files.pythonhosted.org/packages/59/7a/a5f68f474f1018a6505e965f7742c09f1fce5101139f78debac277a4ba60/folder-structure-generator-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-03 02:45:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ujjawalpoudel",
    "github_project": "folder-structure-generator",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "folder-structure-generator"
}