# PodangelEX: PyPI Package Files

This folder contains the **publishable Python package** for PodangelEX.

## Structure

```
package/
├── src/
│   └── podangelex_JustAnotherCoderTheThird/
│       ├── __init__.py          # Package initialization
│       ├── cli.py               # CLI entry point (podangel command)
│       ├── functions.py         # Core audio processing logic
│       └── swears.json          # Packaged profanity word list
├── pyproject.toml               # Modern Python packaging config
├── MANIFEST.in                  # Include non-Python files  
├── PROJECT_STRUCTURE.md         # Detailed structure documentation
└── README.md                    # Package README (for distribution)
```

## Publishing to PyPI

This directory contains everything needed to publish to PyPI:

```bash
cd package/
python -m build              # Build wheels and source distributions
python -m twine upload dist/ # Upload to PyPI
```

## Package Features

When installed via `pip install podangelex_JustAnotherCoderTheThird`:

1. **Auto-initialization**: First run creates all necessary files and directories
2. **Global CLI**: `podangel` command available system-wide
3. **Default workspace**: Creates `~/podangelex_data/` with:
   - `Input/` - Place audio files here
   - `Output/` - Receives cleaned audio
   - `.bridge/` - Temporary processing files
4. **Configuration**: Auto-created in `~/.podangelex/config.json`
5. **Profanity data**: swears.json bundled with package

## Development Usage

For local development:

```bash
cd package/
pip install -e .                              # Editable install
podangel                                      # Run

# Or from project root:
source PodAngelVenv/bin/activate
podangel
```

##Environment Variables

- `PODANGELEX_HOME` - Override config directory
- `PODANGELEX_WORKSPACE` - Override workspace location

## For Users

See [PROJECT_STRUCTURE.md](PROJECT_STRUCTURE.md) for end-user documentation about how the package works.
