[](https://badge.fury.io/py/CodebaseLister)
[](https://opensource.org/licenses/MIT)
[](https://pepy.tech/project/codebaselister)
# CodebaseLister
`CodebaseLister` is a Python package designed to document the contents of codebases. It lists all files and their contents, taking into account `.gitignore` rules if required. This tool is useful for developers who need a comprehensive overview of their project's structure and files.
## Installation
To install `CodebaseLister`, you can use pip:
```bash
pip install CodebaseLister
```
## Usage
### As a Python Module
You can use `CodebaseLister` as a module in your Python scripts.
Example:
```python
from codebaselister import CodebaseLister
# Initialize CodebaseLister with optional parameters
lister = CodebaseLister(base_path='path_to_your_project', use_gitignore=True)
# Generate the listing file
listing_details = lister.generate_listing_file()
print(listing_details)
```
### Customizing Your Listing
You can customize the listing by adjusting the initialization parameters of the `CodebaseLister` class, such as `base_path`, `use_gitignore`, and `output_filename`, to fit the specific needs of your project.
## Output Example
When you run `CodebaseLister`, it creates a text file listing all the files in the specified path (excluding those ignored by `.gitignore` if enabled) along with their contents. Here's an example of the output details:
```
{
"output_filename": "listing_20240113_150223.txt",
"chars_count": 12345,
"file_size": 0.5, # Size in MB
"files_count": 100
}
```
## Contributing
Contributions, issues, and feature requests are welcome! Feel free to check [issues page](https://github.com/chigwell/CodebaseLister/issues).
## License
[MIT](https://choosealicense.com/licenses/mit/)
Raw data
{
"_id": null,
"home_page": "https://github.com/chigwell/CodebaseLister",
"name": "CodebaseLister",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Eugene Evstafev",
"author_email": "chigwel@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/9e/ec/5349297c3090db366c3aad5e7d7023cca1a7e4e4f381d7089c822a67b7ab/CodebaseLister-0.0.2.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/py/CodebaseLister)\n[](https://opensource.org/licenses/MIT)\n[](https://pepy.tech/project/codebaselister)\n\n# CodebaseLister\n\n`CodebaseLister` is a Python package designed to document the contents of codebases. It lists all files and their contents, taking into account `.gitignore` rules if required. This tool is useful for developers who need a comprehensive overview of their project's structure and files.\n\n## Installation\n\nTo install `CodebaseLister`, you can use pip:\n\n```bash\npip install CodebaseLister\n```\n\n## Usage\n\n### As a Python Module\n\nYou can use `CodebaseLister` as a module in your Python scripts.\n\nExample:\n\n```python\nfrom codebaselister import CodebaseLister\n\n# Initialize CodebaseLister with optional parameters\nlister = CodebaseLister(base_path='path_to_your_project', use_gitignore=True)\n\n# Generate the listing file\nlisting_details = lister.generate_listing_file()\nprint(listing_details)\n```\n\n### Customizing Your Listing\n\nYou can customize the listing by adjusting the initialization parameters of the `CodebaseLister` class, such as `base_path`, `use_gitignore`, and `output_filename`, to fit the specific needs of your project.\n\n## Output Example\n\nWhen you run `CodebaseLister`, it creates a text file listing all the files in the specified path (excluding those ignored by `.gitignore` if enabled) along with their contents. Here's an example of the output details:\n\n```\n{\n \"output_filename\": \"listing_20240113_150223.txt\",\n \"chars_count\": 12345,\n \"file_size\": 0.5, # Size in MB\n \"files_count\": 100\n}\n```\n\n## Contributing\n\nContributions, issues, and feature requests are welcome! Feel free to check [issues page](https://github.com/chigwell/CodebaseLister/issues).\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A package to list and document the contents of codebases, optionally using .gitignore rules.",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/chigwell/CodebaseLister"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b483b864a07aaf4b245a7a32d6e74e8aa76e2a0a4f45052cafa6a1f2a630f0f2",
"md5": "864d9b96caf349462053562cc9728036",
"sha256": "6c0b6feccf21a5a66f71365dc21c87f348e440784a1f454ce5d972388b8171a8"
},
"downloads": -1,
"filename": "CodebaseLister-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "864d9b96caf349462053562cc9728036",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4129,
"upload_time": "2024-01-13T17:52:02",
"upload_time_iso_8601": "2024-01-13T17:52:02.803492Z",
"url": "https://files.pythonhosted.org/packages/b4/83/b864a07aaf4b245a7a32d6e74e8aa76e2a0a4f45052cafa6a1f2a630f0f2/CodebaseLister-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9eec5349297c3090db366c3aad5e7d7023cca1a7e4e4f381d7089c822a67b7ab",
"md5": "4723c347c82be77a56d0943b69619ef0",
"sha256": "77e29f88ea4af59f1168fb0c38936b2ddd548176547cd40a03c54cd7052afe58"
},
"downloads": -1,
"filename": "CodebaseLister-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "4723c347c82be77a56d0943b69619ef0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3117,
"upload_time": "2024-01-13T17:52:05",
"upload_time_iso_8601": "2024-01-13T17:52:05.040168Z",
"url": "https://files.pythonhosted.org/packages/9e/ec/5349297c3090db366c3aad5e7d7023cca1a7e4e4f381d7089c822a67b7ab/CodebaseLister-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-13 17:52:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chigwell",
"github_project": "CodebaseLister",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "codebaselister"
}
JSON
