Skip to main content

Listen, monitor and archive your streams!

Project description

earhorn

Listen, monitor and archive your streams!

Install

sudo apt install ffmpeg
pip install earhorn
earhorn --archive-path=/to/my/archive https://stream.example.org/live.ogg

Docker

docker pull ghcr.io/jooola/earhorn

Usage

Usage: earhorn [OPTIONS] URL

  URL of the `stream`.

  See the ffmpeg documentation for details about the `--archive-segment-*` options:
  https://ffmpeg.org/ffmpeg-formats.html#segment_002c-stream_005fsegment_002c-ssegment

Options:
  --hook PATH                     Path to a custom script executed to handle stream state `events`.
  --prometheus                    Enable the prometheus metrics endpoint. The endpoint expose the state of the
                                  `stream`
  --prometheus-listen-port INTEGER
                                  Listen port for the prometheus metrics endpoint.  [default: 9950]
  --archive-path PATH             Path to the archive storage directory. If defined, the archiver will save the
                                  `stream` in segments in the storage path.
  --archive-segment-size INTEGER  Archive segment size in seconds.  [default: 3600]
  --archive-segment-filename TEXT
                                  Archive segment filename (without extension).  [default: archive-%Y%m%d_%H%M%S]
  --archive-segment-format TEXT   Archive segment format.  [default: ogg]
  --archive-segment-format-options TEXT
                                  Archive segment format options.
  --archive-copy-stream           Copy the `stream` without transcoding (reduce CPU usage). WARNING: The stream has to
                                  be in the same format as the `--archive-segment-format`.
  --help                          Show this message and exit.

Releases

To release a new version, first bump the version number in pyproject.toml by hand or by using:

# poetry version --help
poetry version <patch|minor|major>

Run the release target:

make release

Finally, push the release commit and tag to publish them to Pypi:

git push --follow-tags

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

earhorn-0.8.2.tar.gz (20.4 kB view hashes)

Uploaded Source

Built Distribution

earhorn-0.8.2-py3-none-any.whl (21.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page