tree3


Nametree3 JSON
Version 0.1.1 PyPI version JSON
download
home_pageNone
SummaryA command line utility to display and create directory structures
upload_time2025-03-18 21:58:20
maintainerNone
docs_urlNone
authorNone
requires_python>=3.6
licenseMIT
keywords tree parsing python data structure
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # tree3
[![PyPI](https://img.shields.io/pypi/v/tree3)](https://pypi.org/project/tree3/) ![License](https://img.shields.io/pypi/l/tree3) [![GitHub Repo stars](https://img.shields.io/github/stars/amirmazinani/tree3?style=flat&label=github%20stars&color=%2357d9a3)](https://github.com/amirmazinani/tree3)

A command-line utility to display and create directory structures.

## Installation

```bash
pip install tree3
```

## Usage

tree3 provides various options for displaying and managing directory structures.

### Display directory structure

```bash
tree3 [path]
```
#### Example output:
```
/
├── tree3/
│   ├── core/
│   │   ├── __init__.py
│   │   ├── builder.py
│   │   ├── parser.py
│   │   └── tree.py
│   ├── utils/
│   │   ├── __init__.py
│   │   ├── clipboard.py
│   │   ├── file_utils.py
│   │   └── gitignore.py
│   ├── __init__.py
│   ├── __main__.py
│   ├── cli.py
│   ├── config.py
│   └── constants.py
├── LICENSE
├── pyproject.toml
├── README.md
└── setup.py
```

### Save directory structure to file

```bash
tree3 [path] -o output.txt
```

### Create directories from structure file

```bash
tree3 -i input.txt
```

### Respect .gitignore rules

```bash
tree3 -g
```

### Copy structure to clipboard

```bash
tree3 -c
```

### Get help

```bash
tree3 -h
```

## Examples

### Example 1: Display current directory structure

```bash
tree3
```

### Example 2: Save structure to file and copy to clipboard

```bash
tree3 myproject -o project-structure.txt -c
```

### Example 3: Create directory structure from file

```bash
tree3 -i project-structure.txt
```

## Contributing

Feel free to open issues and pull requests on the [GitHub repository](https://github.com/amirmazinani/tree3).

## License

This project is licensed under the MIT License.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "tree3",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "tree, parsing, python, data structure",
    "author": null,
    "author_email": "Amir Mazinani <info.mazinani@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/e2/fa/5eb70e83c6dd6e279fc66e59dcd72654bf484c17c7308e3585d3bc4cc916/tree3-0.1.1.tar.gz",
    "platform": null,
    "description": "# tree3\n[![PyPI](https://img.shields.io/pypi/v/tree3)](https://pypi.org/project/tree3/) ![License](https://img.shields.io/pypi/l/tree3) [![GitHub Repo stars](https://img.shields.io/github/stars/amirmazinani/tree3?style=flat&label=github%20stars&color=%2357d9a3)](https://github.com/amirmazinani/tree3)\n\nA command-line utility to display and create directory structures.\n\n## Installation\n\n```bash\npip install tree3\n```\n\n## Usage\n\ntree3 provides various options for displaying and managing directory structures.\n\n### Display directory structure\n\n```bash\ntree3 [path]\n```\n#### Example output:\n```\n/\n\u251c\u2500\u2500 tree3/\n\u2502   \u251c\u2500\u2500 core/\n\u2502   \u2502   \u251c\u2500\u2500 __init__.py\n\u2502   \u2502   \u251c\u2500\u2500 builder.py\n\u2502   \u2502   \u251c\u2500\u2500 parser.py\n\u2502   \u2502   \u2514\u2500\u2500 tree.py\n\u2502   \u251c\u2500\u2500 utils/\n\u2502   \u2502   \u251c\u2500\u2500 __init__.py\n\u2502   \u2502   \u251c\u2500\u2500 clipboard.py\n\u2502   \u2502   \u251c\u2500\u2500 file_utils.py\n\u2502   \u2502   \u2514\u2500\u2500 gitignore.py\n\u2502   \u251c\u2500\u2500 __init__.py\n\u2502   \u251c\u2500\u2500 __main__.py\n\u2502   \u251c\u2500\u2500 cli.py\n\u2502   \u251c\u2500\u2500 config.py\n\u2502   \u2514\u2500\u2500 constants.py\n\u251c\u2500\u2500 LICENSE\n\u251c\u2500\u2500 pyproject.toml\n\u251c\u2500\u2500 README.md\n\u2514\u2500\u2500 setup.py\n```\n\n### Save directory structure to file\n\n```bash\ntree3 [path] -o output.txt\n```\n\n### Create directories from structure file\n\n```bash\ntree3 -i input.txt\n```\n\n### Respect .gitignore rules\n\n```bash\ntree3 -g\n```\n\n### Copy structure to clipboard\n\n```bash\ntree3 -c\n```\n\n### Get help\n\n```bash\ntree3 -h\n```\n\n## Examples\n\n### Example 1: Display current directory structure\n\n```bash\ntree3\n```\n\n### Example 2: Save structure to file and copy to clipboard\n\n```bash\ntree3 myproject -o project-structure.txt -c\n```\n\n### Example 3: Create directory structure from file\n\n```bash\ntree3 -i project-structure.txt\n```\n\n## Contributing\n\nFeel free to open issues and pull requests on the [GitHub repository](https://github.com/amirmazinani/tree3).\n\n## License\n\nThis project is licensed under the MIT License.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A command line utility to display and create directory structures",
    "version": "0.1.1",
    "project_urls": {
        "Bug Tracker": "https://github.com/amirmazinani/tree3/issues",
        "Homepage": "https://github.com/amirmazinani/tree3"
    },
    "split_keywords": [
        "tree",
        " parsing",
        " python",
        " data structure"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ca120573b979e8a96c69a6e28f161c9b5a2105949d87c75d0c0d63972d811c59",
                "md5": "8de088b0bb7b5ec9a281dbb34d80854a",
                "sha256": "0e35b7a33d0e200a613c9a48988906a5994b2bbf60bada33dbb4631bf1aeb21d"
            },
            "downloads": -1,
            "filename": "tree3-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8de088b0bb7b5ec9a281dbb34d80854a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 11278,
            "upload_time": "2025-03-18T21:58:19",
            "upload_time_iso_8601": "2025-03-18T21:58:19.387425Z",
            "url": "https://files.pythonhosted.org/packages/ca/12/0573b979e8a96c69a6e28f161c9b5a2105949d87c75d0c0d63972d811c59/tree3-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e2fa5eb70e83c6dd6e279fc66e59dcd72654bf484c17c7308e3585d3bc4cc916",
                "md5": "3fb642a33f28916b6a22b7f53da1fdb8",
                "sha256": "e7e2c6570ecdc7f915e9e1d594574f03ddbb96cd880ce14e517292a7fc3c4552"
            },
            "downloads": -1,
            "filename": "tree3-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "3fb642a33f28916b6a22b7f53da1fdb8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 9526,
            "upload_time": "2025-03-18T21:58:20",
            "upload_time_iso_8601": "2025-03-18T21:58:20.848436Z",
            "url": "https://files.pythonhosted.org/packages/e2/fa/5eb70e83c6dd6e279fc66e59dcd72654bf484c17c7308e3585d3bc4cc916/tree3-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-03-18 21:58:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "amirmazinani",
    "github_project": "tree3",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "tree3"
}
        
Elapsed time: 1.16433s