# Repodocify
A powerful Python tool for generating repository structure documentation in multiple formats.
## ✨ Features
- 📝 **Multiple Output Formats**
- Markdown for clean documentation
- ASCII tree with file sizes
- JSON structure with metadata
- HTML with collapsible trees (coming soon!)
- 🎯 **Smart Filtering**
- Respects .gitignore patterns
- Intelligent directory filtering
- Configurable depth control
- Cross-platform compatibility
- 📊 **Repository Statistics**
- File and directory counts
- Size analysis
- Last modified tracking
## 🚀 Installation
```bash
pip install repodocify
```
## 📖 Usage
Basic usage:
```bash
repodocify
```
With options:
```bash
# Generate markdown output (default)
repodocify --path /path/to/repo --max-depth 3
# Generate ASCII tree with file sizes
repodocify --format ascii --stats
# Generate JSON output
repodocify --format json --output repo-structure.json
# Generate interactive HTML tree
repodocify --format html
```
## 🛠️ Development
This project uses Poetry for dependency management. To set up the development environment:
1. Install Poetry (if not already installed):
```bash
pip install poetry
```
2. Clone the repository:
```bash
git clone https://github.com/yourusername/repodocify.git
cd repodocify
```
3. Install dependencies:
```bash
poetry install
```
4. Run tests:
```bash
poetry run pytest
```
## 📋 Requirements
- Python >=3.8.1
- Click for CLI
- Rich for terminal formatting
- PyYAML for configuration (coming soon)
## 🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## 📄 License
MIT License
Raw data
{
"_id": null,
"home_page": "https://github.com/Davtan00/repomap",
"name": "repodocify",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.8.1",
"maintainer_email": null,
"keywords": "repository, documentation, structure, tree, git",
"author": "David Tanner",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d4/66/25cc7e1b6635e6ff3d0d8e31eb9ef16ffb616cec9e36485f4a8234a58069/repodocify-1.0.0.tar.gz",
"platform": null,
"description": "# Repodocify\n\nA powerful Python tool for generating repository structure documentation in multiple formats.\n\n## \u2728 Features\n\n- \ud83d\udcdd **Multiple Output Formats**\n - Markdown for clean documentation\n - ASCII tree with file sizes\n - JSON structure with metadata\n - HTML with collapsible trees (coming soon!)\n\n- \ud83c\udfaf **Smart Filtering**\n - Respects .gitignore patterns\n - Intelligent directory filtering\n - Configurable depth control\n - Cross-platform compatibility\n\n- \ud83d\udcca **Repository Statistics**\n - File and directory counts\n - Size analysis\n - Last modified tracking\n\n## \ud83d\ude80 Installation\n\n```bash\npip install repodocify\n```\n\n## \ud83d\udcd6 Usage\n\nBasic usage:\n```bash\nrepodocify\n```\n\nWith options:\n```bash\n# Generate markdown output (default)\nrepodocify --path /path/to/repo --max-depth 3\n\n# Generate ASCII tree with file sizes\nrepodocify --format ascii --stats\n\n# Generate JSON output\nrepodocify --format json --output repo-structure.json\n\n# Generate interactive HTML tree\nrepodocify --format html\n```\n\n## \ud83d\udee0\ufe0f Development\n\nThis project uses Poetry for dependency management. To set up the development environment:\n\n1. Install Poetry (if not already installed):\n ```bash\n pip install poetry\n ```\n\n2. Clone the repository:\n ```bash\n git clone https://github.com/yourusername/repodocify.git\n cd repodocify\n ```\n\n3. Install dependencies:\n ```bash\n poetry install\n ```\n\n4. Run tests:\n ```bash\n poetry run pytest\n ```\n\n## \ud83d\udccb Requirements\n\n- Python >=3.8.1\n- Click for CLI\n- Rich for terminal formatting\n- PyYAML for configuration (coming soon)\n\n## \ud83e\udd1d Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## \ud83d\udcc4 License\n\nMIT License\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A tool for generating repository structure documentation",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/Davtan00/repomap",
"Repository": "https://github.com/Davtan00/repomap"
},
"split_keywords": [
"repository",
" documentation",
" structure",
" tree",
" git"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f693532ae1646384d43d72d2aef35573a0abdd3d34a77ca3e27399bb54c1cf6b",
"md5": "6b719f4a8e972f0c503f6c049a9b5875",
"sha256": "942a9562af27532260f48d1b3a57f6658d267a1ca6a4ed7b93eca5da0e79731c"
},
"downloads": -1,
"filename": "repodocify-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6b719f4a8e972f0c503f6c049a9b5875",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.8.1",
"size": 10153,
"upload_time": "2025-01-04T12:37:30",
"upload_time_iso_8601": "2025-01-04T12:37:30.352895Z",
"url": "https://files.pythonhosted.org/packages/f6/93/532ae1646384d43d72d2aef35573a0abdd3d34a77ca3e27399bb54c1cf6b/repodocify-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d46625cc7e1b6635e6ff3d0d8e31eb9ef16ffb616cec9e36485f4a8234a58069",
"md5": "b217f8274ec180da6111199cdd5a1b84",
"sha256": "33afc1e717352ceae0fdb94eda581019def76b931ec950e61c56144682a40d94"
},
"downloads": -1,
"filename": "repodocify-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "b217f8274ec180da6111199cdd5a1b84",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.8.1",
"size": 8435,
"upload_time": "2025-01-04T12:37:32",
"upload_time_iso_8601": "2025-01-04T12:37:32.519451Z",
"url": "https://files.pythonhosted.org/packages/d4/66/25cc7e1b6635e6ff3d0d8e31eb9ef16ffb616cec9e36485f4a8234a58069/repodocify-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-04 12:37:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Davtan00",
"github_project": "repomap",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "repodocify"
}
JSON
