| Name | wikibee JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Extract Wikipedia articles and convert them to TTS-friendly text and audio |
| upload_time | 2025-08-25 02:40:50 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
audio
extraction
text-to-speech
tts
wikipedia
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# wikibee
[](https://github.com/patrickdeanbrown/wikibee/actions/workflows/python-tests.yml)
[](https://badge.fury.io/py/wikibee)
[](https://www.python.org/downloads/)
[](https://opensource.org/licenses/MIT)
Extract Wikipedia articles and convert them to TTS-friendly text and audio. Search by URL or keywords, get clean markdown and audio-optimized output.
## What is wikibee?
wikibee transforms Wikipedia articles into clean, accessible content perfect for:
- **Accessibility**: Convert text to speech for visually impaired users
- **Podcast creation**: Research and content preparation
- **Educational materials**: Clean text for study guides
- **Offline reading**: Save articles in markdown format
- **Audio content**: Generate TTS-ready text and audio files
## Quick Start
Install wikibee and create your first audio file in under 30 seconds:
```bash
# Install (recommended method)
pipx install wikibee
# Search and convert an article
wikibee "Albert Einstein" --tts --output my-audio/
# Or use a direct URL
wikibee "https://en.wikipedia.org/wiki/Artificial_intelligence" --tts
```
That's it! You now have clean markdown and TTS-optimized text files ready for audio conversion.
## Installation
### Option 1: pipx (Recommended)
```bash
pipx install wikibee
```
### Option 2: pip
```bash
pip install wikibee
```
### Option 3: Standalone Binaries
**Windows/Linux**: Download from [releases](https://github.com/patrickdeanbrown/wikibee/releases)
**macOS**: Use pipx installation (binaries not provided for macOS)
### System Requirements
- Python 3.8 or higher
- Internet connection for Wikipedia access
- Optional: TTS server for audio generation
## Basic Usage
### Search by Keywords
```bash
# Simple search with fuzzy matching
wikibee "war of the roses"
# Auto-select first result (no interactive menu)
wikibee "napoleon bonaparte" --yolo
# Save to specific directory
wikibee "quantum computing" --output research/
```
### Use Direct URLs
```bash
# Process specific Wikipedia page
wikibee "https://en.wikipedia.org/wiki/Machine_learning"
# Get only the introduction section
wikibee "https://en.wikipedia.org/wiki/Python" --lead-only
```
### Generate Audio-Ready Content
```bash
# Create TTS-optimized text
wikibee "Ancient Rome" --tts
# Customize heading format for TTS
wikibee "World War II" --tts --heading-prefix "Section:"
# Specify output filename
wikibee "Mozart" --tts --output music/ --filename mozart_biography
```
## Common Use Cases
### For Accessibility
```bash
# Create clean, readable text files
wikibee "Marie Curie" --tts --output biographies/
# Output: marie_curie.md and marie_curie.txt (TTS-ready)
```
### For Podcast Research
```bash
# Quick research with minimal processing
wikibee "blockchain technology" --lead-only --output research/
```
### For Educational Content
```bash
# Batch process multiple topics
wikibee "photosynthesis" --tts --output biology/
wikibee "mitosis" --tts --output biology/
wikibee "evolution" --tts --output biology/
```
## Key Features
- **Smart Search**: Fuzzy matching handles typos and partial queries
- **Interactive Selection**: Choose from multiple search results with a numbered menu
- **Clean Output**: Removes Wikipedia markup, leaving clean markdown
- **TTS Optimization**: Strips formatting markers that confuse text-to-speech engines
- **Flexible Output**: Save to custom directories with custom filenames
- **Error Handling**: Graceful handling of network issues and missing pages
- **Cross-Platform**: Works on Windows, macOS, and Linux
## Documentation
- **[Quick Start Guide](docs/quickstart.md)** - Get up and running in 5 minutes
- **[Complete Tutorial](docs/tutorial/)** - Comprehensive usage guide
- **[CLI Reference](docs/reference/cli-reference.md)** - All commands and options
- **[API Reference](docs/reference/api-reference.md)** - Python API documentation
- **[Troubleshooting](docs/reference/troubleshooting.md)** - Common issues and solutions
## Development
wikibee is built with modern Python practices:
```bash
# Set up development environment
uv venv --python 3.12
source .venv/bin/activate
uv pip install -e ".[dev]"
# Run tests
pytest -q
# Check code style
ruff check .
```
See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed development guidelines.
## Examples and Scripts
The `scripts/` directory contains working examples:
- `smoke_extract.py` - Basic extraction example
- See `docs/guides/examples.md` for more real-world scenarios
## Getting Help
- **Documentation**: Check the `docs/` directory for comprehensive guides
- **Issues**: [Report bugs or request features](https://github.com/patrickdeanbrown/wikibee/issues)
- **Discussions**: Ask questions in GitHub discussions
## License
MIT License - see [LICENSE](LICENSE) for details.
## Contributing
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on:
- Setting up your development environment
- Code style and testing requirements
- Submitting pull requests
- Reporting bugs and requesting features
---
**Made with care for the Wikipedia community and accessibility advocates everywhere.**
Raw data
{
"_id": null,
"home_page": null,
"name": "wikibee",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "audio, extraction, text-to-speech, tts, wikipedia",
"author": null,
"author_email": "Patrick Brown <patrickdeanbrown@icloud.com>",
"download_url": "https://files.pythonhosted.org/packages/fb/70/25c380c90e2aacb4973904923ed284f9caf334985b42049e86678ceefc34/wikibee-0.1.0.tar.gz",
"platform": null,
"description": "# wikibee\n\n[](https://github.com/patrickdeanbrown/wikibee/actions/workflows/python-tests.yml)\n[](https://badge.fury.io/py/wikibee)\n[](https://www.python.org/downloads/)\n[](https://opensource.org/licenses/MIT)\n\nExtract Wikipedia articles and convert them to TTS-friendly text and audio. Search by URL or keywords, get clean markdown and audio-optimized output.\n\n## What is wikibee?\n\nwikibee transforms Wikipedia articles into clean, accessible content perfect for:\n- **Accessibility**: Convert text to speech for visually impaired users\n- **Podcast creation**: Research and content preparation\n- **Educational materials**: Clean text for study guides\n- **Offline reading**: Save articles in markdown format\n- **Audio content**: Generate TTS-ready text and audio files\n\n## Quick Start\n\nInstall wikibee and create your first audio file in under 30 seconds:\n\n```bash\n# Install (recommended method)\npipx install wikibee\n\n# Search and convert an article\nwikibee \"Albert Einstein\" --tts --output my-audio/\n\n# Or use a direct URL \nwikibee \"https://en.wikipedia.org/wiki/Artificial_intelligence\" --tts\n```\n\nThat's it! You now have clean markdown and TTS-optimized text files ready for audio conversion.\n\n## Installation\n\n### Option 1: pipx (Recommended)\n```bash\npipx install wikibee\n```\n\n### Option 2: pip\n```bash\npip install wikibee\n```\n\n### Option 3: Standalone Binaries\n\n**Windows/Linux**: Download from [releases](https://github.com/patrickdeanbrown/wikibee/releases)\n\n**macOS**: Use pipx installation (binaries not provided for macOS)\n\n### System Requirements\n- Python 3.8 or higher\n- Internet connection for Wikipedia access\n- Optional: TTS server for audio generation\n\n## Basic Usage\n\n### Search by Keywords\n```bash\n# Simple search with fuzzy matching\nwikibee \"war of the roses\"\n\n# Auto-select first result (no interactive menu)\nwikibee \"napoleon bonaparte\" --yolo\n\n# Save to specific directory\nwikibee \"quantum computing\" --output research/\n```\n\n### Use Direct URLs\n```bash\n# Process specific Wikipedia page\nwikibee \"https://en.wikipedia.org/wiki/Machine_learning\"\n\n# Get only the introduction section\nwikibee \"https://en.wikipedia.org/wiki/Python\" --lead-only\n```\n\n### Generate Audio-Ready Content\n```bash\n# Create TTS-optimized text\nwikibee \"Ancient Rome\" --tts\n\n# Customize heading format for TTS\nwikibee \"World War II\" --tts --heading-prefix \"Section:\"\n\n# Specify output filename\nwikibee \"Mozart\" --tts --output music/ --filename mozart_biography\n```\n\n## Common Use Cases\n\n### For Accessibility\n```bash\n# Create clean, readable text files\nwikibee \"Marie Curie\" --tts --output biographies/\n# Output: marie_curie.md and marie_curie.txt (TTS-ready)\n```\n\n### For Podcast Research\n```bash\n# Quick research with minimal processing\nwikibee \"blockchain technology\" --lead-only --output research/\n```\n\n### For Educational Content\n```bash\n# Batch process multiple topics\nwikibee \"photosynthesis\" --tts --output biology/\nwikibee \"mitosis\" --tts --output biology/\nwikibee \"evolution\" --tts --output biology/\n```\n\n## Key Features\n\n- **Smart Search**: Fuzzy matching handles typos and partial queries\n- **Interactive Selection**: Choose from multiple search results with a numbered menu\n- **Clean Output**: Removes Wikipedia markup, leaving clean markdown\n- **TTS Optimization**: Strips formatting markers that confuse text-to-speech engines\n- **Flexible Output**: Save to custom directories with custom filenames\n- **Error Handling**: Graceful handling of network issues and missing pages\n- **Cross-Platform**: Works on Windows, macOS, and Linux\n\n## Documentation\n\n- **[Quick Start Guide](docs/quickstart.md)** - Get up and running in 5 minutes\n- **[Complete Tutorial](docs/tutorial/)** - Comprehensive usage guide\n- **[CLI Reference](docs/reference/cli-reference.md)** - All commands and options\n- **[API Reference](docs/reference/api-reference.md)** - Python API documentation\n- **[Troubleshooting](docs/reference/troubleshooting.md)** - Common issues and solutions\n\n## Development\n\nwikibee is built with modern Python practices:\n\n```bash\n# Set up development environment\nuv venv --python 3.12\nsource .venv/bin/activate\nuv pip install -e \".[dev]\"\n\n# Run tests\npytest -q\n\n# Check code style\nruff check .\n```\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for detailed development guidelines.\n\n## Examples and Scripts\n\nThe `scripts/` directory contains working examples:\n- `smoke_extract.py` - Basic extraction example\n- See `docs/guides/examples.md` for more real-world scenarios\n\n## Getting Help\n\n- **Documentation**: Check the `docs/` directory for comprehensive guides\n- **Issues**: [Report bugs or request features](https://github.com/patrickdeanbrown/wikibee/issues)\n- **Discussions**: Ask questions in GitHub discussions\n\n## License\n\nMIT License - see [LICENSE](LICENSE) for details.\n\n## Contributing\n\nWe welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on:\n- Setting up your development environment\n- Code style and testing requirements\n- Submitting pull requests\n- Reporting bugs and requesting features\n\n---\n\n**Made with care for the Wikipedia community and accessibility advocates everywhere.**\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Extract Wikipedia articles and convert them to TTS-friendly text and audio",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/patrickdeanbrown/wikibee",
"Issues": "https://github.com/patrickdeanbrown/wikibee/issues",
"Repository": "https://github.com/patrickdeanbrown/wikibee"
},
"split_keywords": [
"audio",
" extraction",
" text-to-speech",
" tts",
" wikipedia"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "682c0fcd6417bb6630499f93a824e53211860466fb20e5d6e4178ca597e7072a",
"md5": "0c856db76f94870786c0a34ec4fc8ee6",
"sha256": "03ee219e7f8084b3431262107b28f5d5d70513d52a1ca53852867a53065a3e80"
},
"downloads": -1,
"filename": "wikibee-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0c856db76f94870786c0a34ec4fc8ee6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 16485,
"upload_time": "2025-08-25T02:40:49",
"upload_time_iso_8601": "2025-08-25T02:40:49.634314Z",
"url": "https://files.pythonhosted.org/packages/68/2c/0fcd6417bb6630499f93a824e53211860466fb20e5d6e4178ca597e7072a/wikibee-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "fb7025c380c90e2aacb4973904923ed284f9caf334985b42049e86678ceefc34",
"md5": "b704bab5067342653b279331e809339b",
"sha256": "ddc52e7d91631441d7c992cb11c34063cb25e6f441576f4e25f2ddacae015249"
},
"downloads": -1,
"filename": "wikibee-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "b704bab5067342653b279331e809339b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 20488,
"upload_time": "2025-08-25T02:40:50",
"upload_time_iso_8601": "2025-08-25T02:40:50.995153Z",
"url": "https://files.pythonhosted.org/packages/fb/70/25c380c90e2aacb4973904923ed284f9caf334985b42049e86678ceefc34/wikibee-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-25 02:40:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "patrickdeanbrown",
"github_project": "wikibee",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "wikibee"
}
