codecontextor 1.1.1
DEPRECATED: Please use 'contextor' package instead
Requires Python: >=3.8

# CodeContextor 🚀

Note: This package replaces the deprecated `codecontextor` package.

Ever needed to explain your codebase to ChatGPT or Claude? CodeContextor creates a perfect snapshot of your project in seconds:

```bash
# That's it! Just run:
codecontextor --directory ./my_project
```

## What You Get ✨

```text
my_project/
├── src/
│   └── main.py     # LLMs can request this file if needed!
└── config/
    └── settings.yaml

# Key files are included below the tree...
```

Just paste this into your AI chat and start coding! The AI can see your project structure and request any file it needs.

## Quick Start 🏃‍♂️

```bash
# Install
pip install codecontextor

# Run (will include all files)
codecontextor --directory ./my_project

# Or specify key files only
codecontextor --files main.py config.yaml
```

## Why CodeContextor? 🎯

- **Simple**: One command to create perfect context for AI conversations
- **Smart**: Respects .gitignore, handles large files, includes safety checks
- **Flexible**: Include specific files or let the AI see everything
- **Safe**: Warns you about size and skips files >10MB

## Features in Detail 🛠️

- 📁 Complete project tree generation
- 📄 Automatic or selective file inclusion
- 🔒 .gitignore pattern support
- ⚡ Large file protection
- 🎮 Custom file exclusions
- 📊 Size warnings and confirmations

## Advanced Usage 🔧

Need more control? We've got you covered:

```bash
# Include files listed in a text file
codecontextor --files-list important_files.txt

# Custom exclude patterns
codecontextor --exclude-file exclude_patterns.txt

# Ignore .gitignore
codecontextor --no-gitignore

# Include essential context and supplementary info
codecontextor --prefix-file project_overview.txt --appendix-file api_docs.txt

# Add schemas and deployment guides
codecontextor --prefix-file schemas.txt --appendix-file deployment.txt
```

## Command Line Options 🎛️

| Option | Description |
|--------|-------------|
| `--directory` | Project directory (default: current) |
| `--files` | Specific files to include |
| `--files-list` | File containing list of files |
| `--smart-select` | Automatically select important files like entry points, configs, and docs |
| `--prefix-file` | Essential context to add at start (schemas, overview) |
| `--appendix-file` | Supplementary info to add at end (docs, guides) |
| `--output` | Output filename (default: project_context.txt) |
| `--estimate-tokens` | Calculate and show estimated token count in the output file |
| `--no-gitignore` | Disable .gitignore patterns |
| `--exclude-file` | Additional exclude patterns file |

## Examples 📚

### Include specific files (files-list.txt):
```text
src/main.py
config/settings.yaml
README.md
```

### Exclude patterns (exclude-patterns.txt):
```text
*.pyc
__pycache__/
.env
*.log
```

## Safety First 🛡️

CodeContextor looks out for you:
- Calculates total file size
- Shows warning for large directories
- Asks for confirmation
- Skips files >10MB
- Respects .gitignore by default

## Installation Options 📦

```bash
# From PyPI (recommended)
pip install codecontextor

# From source
git clone https://github.com/ergut/codecontextor
pip install -r requirements.txt
```

## Contributing 🤝

We love contributions! Check out [README.test.md](README.test.md) for:
- Running tests
- Test coverage details
- Adding new features
- Contributing guidelines

## License 📜

MIT License - See [LICENSE](LICENSE) file

## Support 💬

- 🐛 [Report issues](https://github.com/ergut/codecontextor/issues)
- 💡 [Feature requests](https://github.com/ergut/codecontextor/issues)
- 📖 [Documentation](https://github.com/ergut/codecontextor)

## Author ✍️

Salih Ergüt

## Version 📋

Current version: 1.0.3

See [CHANGELOG.md](CHANGELOG.md) for version history and updates.