# Nimblex
**Nimblex** is a Python CLI tool designed to analyze, extract, and display the structure of directories and Python projects. With Nimblex, you can view directory hierarchies, extract classes and methods, and save the results to files—all with a simple command-line interface.
---
## Features
- **Display Directory Structures**: Quickly view the hierarchy of files and folders in any directory.
- **Extract Python Classes and Methods**: Parse Python files to identify and display classes and methods.
- **Save Results**: Export directory structures and extracted information to files for documentation or sharing.
- **Customizable Ignored Directories**: Automatically exclude unnecessary directories like `__pycache__` and `.git`.
---
## Installation
You can install Nimblex directly from PyPI:
```bash
pip install nimblex
```
## Features
- **Display Directory Structures**: Quickly view the hierarchy of files and folders in any directory.
- **Extract Python Classes and Methods**: Parse Python files to identify and display classes and methods.
- **Save Results**: Export directory structures and extracted information to files for documentation or sharing.
- **Customizable Ignored Directories**: Automatically exclude unnecessary directories like `__pycache__` and `.git`.
---
## Installation
You can install Nimblex directly from PyPI:
```bash
pip install nimblex
```
## Usage
Run the `nimblex` command from your terminal. If no path is specified, the tool operates on the current directory by default.
### Commands and Options
|Command/Option |Description |
|--|--|
| `nimblex -m` | Save the structure of a single directory or file to a file. |
|`nimblex -x`|Extract the directory structure and classes/methods for an entire project and save to a file.|
|`nimblex -d` | Display the directory structure and classes/methods for an entire project directly in the terminal. |
### Examples
#### Display the directory structure in the terminal:
```bash
nimblex -d
```
Extract and save the project structure to a file:
```bash
nimblex -x /path/to/your/project
```
Save the structure of a single directory:
```bash
nimblex -m /path/to/directory
```
## Configuration
### Ignored Directories and Files
By default, Nimblex excludes the following directories and files during analysis:
- `__pycache__`
- `.git`
- `.svn`
- `.hg`
- `.idea`
- `node_modules`
- `bin`, `obj`
- `dist`, `build`
- `.vscode`
- `*.egg-info`
- `target`
- `venv`
Other items may be added to this list in future updates.
## Contributing
Contributions are welcome! Please open an issue or submit a pull request.
----------
## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/pezhvak98/Nimblex/blob/main/LICENSE) file for more details.
Raw data
{
"_id": null,
"home_page": "https://github.com/pezhvak98/Nimblex",
"name": "nimblex",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "CLI, project-structure, code-exploration",
"author": "Pezhvak",
"author_email": "m.8562.m@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6a/47/29791189c2c3fb60e54f82a3d4330fca7cb77f582b9e01945b1ddaab3b04/nimblex-1.0.0.tar.gz",
"platform": null,
"description": "\n# Nimblex\n\n**Nimblex** is a Python CLI tool designed to analyze, extract, and display the structure of directories and Python projects. With Nimblex, you can view directory hierarchies, extract classes and methods, and save the results to files\u2014all with a simple command-line interface.\n\n---\n\n## Features\n\n- **Display Directory Structures**: Quickly view the hierarchy of files and folders in any directory.\n- **Extract Python Classes and Methods**: Parse Python files to identify and display classes and methods.\n- **Save Results**: Export directory structures and extracted information to files for documentation or sharing.\n- **Customizable Ignored Directories**: Automatically exclude unnecessary directories like `__pycache__` and `.git`.\n\n---\n\n## Installation\n\nYou can install Nimblex directly from PyPI:\n\n```bash\npip install nimblex\n```\n\n\n## Features\n\n- **Display Directory Structures**: Quickly view the hierarchy of files and folders in any directory.\n- **Extract Python Classes and Methods**: Parse Python files to identify and display classes and methods.\n- **Save Results**: Export directory structures and extracted information to files for documentation or sharing.\n- **Customizable Ignored Directories**: Automatically exclude unnecessary directories like `__pycache__` and `.git`.\n\n---\n\n## Installation\n\nYou can install Nimblex directly from PyPI:\n\n```bash\npip install nimblex\n```\n\n\n## Usage\n\nRun the `nimblex` command from your terminal. If no path is specified, the tool operates on the current directory by default.\n\n### Commands and Options\n|Command/Option |Description |\t \n|--|--|\n| \u200d\u200d`nimblex -m` | Save the structure of a single directory or file to a file. |\n|`nimblex -x`|Extract the directory structure and classes/methods for an entire project and save to a file.|\n|`nimblex -d` | Display the directory structure and classes/methods for an entire project directly in the terminal. |\n\n### Examples\n\n#### Display the directory structure in the terminal:\n```bash\nnimblex -d\n```\nExtract and save the project structure to a file:\n```bash\nnimblex -x /path/to/your/project\n```\nSave the structure of a single directory:\n```bash\nnimblex -m /path/to/directory\n```\n## Configuration\n\n### Ignored Directories and Files\n\nBy default, Nimblex excludes the following directories and files during analysis:\n\n- `__pycache__`\n- `.git`\n- `.svn`\n- `.hg`\n- `.idea`\n- `node_modules`\n- `bin`, `obj`\n- `dist`, `build`\n- `.vscode`\n- `*.egg-info`\n- `target`\n- `venv`\n\nOther items may be added to this list in future updates.\n\n## Contributing\n\nContributions are welcome! Please open an issue or submit a pull request.\n\n----------\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](https://github.com/pezhvak98/Nimblex/blob/main/LICENSE) file for more details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "nimblex: A CLI tool to explore and extract project structures.",
"version": "1.0.0",
"project_urls": {
"Bug Reports": "https://github.com/pezhvak98/Nimblex/issues",
"Homepage": "https://github.com/pezhvak98/Nimblex",
"Source": "https://github.com/pezhvak98/Nimblex"
},
"split_keywords": [
"cli",
" project-structure",
" code-exploration"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0b859b0f1daa4093c5611ba3beb5a7b53582e4934af4fc634d9f5c8b55b60e56",
"md5": "f45e5bae6c651e7899a347885201954f",
"sha256": "75955adb9cda82bc20dd97e98eeaaba326f383910c9a853ba3270e60c6cefb45"
},
"downloads": -1,
"filename": "nimblex-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f45e5bae6c651e7899a347885201954f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 8706,
"upload_time": "2024-12-06T17:51:21",
"upload_time_iso_8601": "2024-12-06T17:51:21.282364Z",
"url": "https://files.pythonhosted.org/packages/0b/85/9b0f1daa4093c5611ba3beb5a7b53582e4934af4fc634d9f5c8b55b60e56/nimblex-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6a4729791189c2c3fb60e54f82a3d4330fca7cb77f582b9e01945b1ddaab3b04",
"md5": "52e36ddb56fc6b34e9d037734470af31",
"sha256": "7e19c470151572841090c2f6067709baee8289b15aea1d9629d22449cba4e31a"
},
"downloads": -1,
"filename": "nimblex-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "52e36ddb56fc6b34e9d037734470af31",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 8617,
"upload_time": "2024-12-06T17:51:24",
"upload_time_iso_8601": "2024-12-06T17:51:24.706776Z",
"url": "https://files.pythonhosted.org/packages/6a/47/29791189c2c3fb60e54f82a3d4330fca7cb77f582b9e01945b1ddaab3b04/nimblex-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-06 17:51:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pezhvak98",
"github_project": "Nimblex",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "termcolor",
"specs": []
},
{
"name": "argparse",
"specs": []
},
{
"name": "rich",
"specs": []
}
],
"lcname": "nimblex"
}
JSON
