Metadata-Version: 2.4
Name: media_archivist
Version: 0.29.0a2
Summary: Media indexer for YouTube, YouTube Music, Internet Archive, Bandcamp and SoundCloud — index streams, download on demand
Author-email: JarbasAi <jarbasai@mailfence.com>
License: Apache-2.0
Project-URL: Homepage, https://github.com/LeMetadatarr/media-archivist
Project-URL: Repository, https://github.com/LeMetadatarr/media-archivist
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: json_database>=0.3.0
Requires-Dist: mediavocab>=2.0.0a0
Requires-Dist: metadatarr>=0.5.0a0
Requires-Dist: tutubo>=4.5.0a1
Requires-Dist: internetarchive
Requires-Dist: requests
Requires-Dist: pydantic>=2
Requires-Dist: tqdm
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: httpx<1,>=0.28; extra == "test"
Requires-Dist: fastapi; extra == "test"
Requires-Dist: uvicorn[standard]; extra == "test"
Requires-Dist: jinja2; extra == "test"
Requires-Dist: python-multipart; extra == "test"
Requires-Dist: yt-dlp>=2024.1.0; extra == "test"
Provides-Extra: hub
Requires-Dist: huggingface_hub; extra == "hub"
Provides-Extra: server
Requires-Dist: fastapi; extra == "server"
Requires-Dist: uvicorn[standard]; extra == "server"
Requires-Dist: jinja2; extra == "server"
Requires-Dist: python-multipart; extra == "server"
Provides-Extra: ytdlp
Requires-Dist: yt-dlp>=2024.1.0; extra == "ytdlp"
Provides-Extra: all
Requires-Dist: huggingface_hub; extra == "all"
Requires-Dist: fastapi; extra == "all"
Requires-Dist: uvicorn[standard]; extra == "all"
Requires-Dist: jinja2; extra == "all"
Requires-Dist: python-multipart; extra == "all"
Requires-Dist: yt-dlp>=2024.1.0; extra == "all"
Dynamic: license-file

# media_archivist

media_archivist adds remote media as **streams** to your library. It follows
YouTube channels and playlists and indexes YouTube Music, Internet Archive,
Bandcamp and SoundCloud, resolves a fresh playable URL for any entry at play
time, and writes `.strm` files for Jellyfin and Kodi when you ask. It downloads
a file only on request. Apps use it through a JSON API; people use it through a
`media-archivist` CLI and a build-free Web UI.

| Backend | Library |
| --- | --- |
| YouTube, YouTube Music | [`tutubo`](https://github.com/LeMetadatarr/tutubo) |
| Internet Archive | `internetarchive` |
| Bandcamp | [`py_bandcamp`](https://github.com/LeMetadatarr/py_bandcamp) |
| SoundCloud | [`nuvem_de_som`](https://github.com/LeMetadatarr/nuvem_de_som) |

Further providers install as Python packages; see
[provider plugins](docs/plugins.md).

## Install and run

```bash
git clone https://github.com/LeMetadatarr/media-archivist
cd media-archivist && pip install ".[all]"
media-archivist add --db-file talks.json https://www.youtube.com/@SomeChannel
media-archivist serve --db-file talks.json   # http://localhost:8000/
```

Or with Docker: `docker compose -f deploy/docker-compose.yml up -d`. The
service is single-tenant; run it on your LAN or behind a reverse proxy and set
`MEDIA_ARCHIVIST_API_KEY` for anything outside it.

## Documentation

Start at the [documentation index](docs/index.md).

- [Getting started](docs/getting-started.md) and the [Web UI](docs/webui.md)
- [App API](docs/app-api.md): subscriptions, queries, signed links, exports, downloads
- [Running as a service](docs/deploy.md) and [Jellyfin and Kodi](docs/jellyfin.md)
- [CLI](docs/cli.md), [notifications](docs/notifications.md), [datasets](docs/datasets.md)
- [Provider plugins](docs/plugins.md) and [metadata providers](docs/metadatarr.md)

## Related projects

- [`metadatarr`](https://github.com/LeMetadatarr/metadatarr), the cross-source
  metadata resolver used by `canonicalize`
- [`tutubo`](https://github.com/LeMetadatarr/tutubo), the YouTube client

## License

Apache-2.0
