semvec/pypi-packages huggingface dataset:
repodocify 1.0.0
A tool for generating repository structure documentation
License: MIT
Requires Python: <4.0.0,>=3.8.1
Keywords: repository, documentation, structure, tree, git

# 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