klio-audio 21.3.0rc1
Library for audio-related Klio transforms and helpers
Requires Python: >=3.6, <3.9
Keywords: klio,apache,beam,audio

The ``klio-audio`` Library
==========================

.. image:: https://img.shields.io/pypi/v/klio-audio?color=%2300aa55&label=klio-audio
   :target: https://pypi.org/project/klio-audio
   :alt: Latest version of klio-audio on PyPI

.. image:: https://github.com/spotify/klio/workflows/klio-audio%20unit%20tests/badge.svg
   :target: https://github.com/spotify/klio/actions?query=workflow%3A%22klio-audio+unit+tests%22
   :alt: Status of klio-audio unit tests

.. start-klio-audio-intro

``klio-audio`` is an optional library with helper transforms related to processing audio, including downloading from `GCS`_ into memory, loading into `numpy`_ via `librosa`_, generate various spectrograms, among others.

.. end-klio-audio-intro

Installation
------------

To make use of ``klio-audio``, add ``klio[audio]`` in your ``job-requirements.txt`` file so that it is installed in your job's Docker image.

.. start-klio-audio-install

As the ``klio-audio`` library is **not** meant to be installed directly, check out the `installation
guide <https://docs.klio.io/en/latest/quickstart/installation.html>`_ for how to setup
installation.
There is also the `user guide <https://docs.klio.io/en/latest/userguide/index.html>`_ and the `API
documentation <https://docs.klio.io/en/latest/reference/audio/index.html>`_ for more information.


.. _GCS: https://cloud.google.com/storage/docs
.. _numpy: https://numpy.org/
.. _librosa: https://librosa.org/




.. role:: violetemph


What is Klio?
-------------

.. start-intro

Klio is an :violetemph:`ecosystem` that allows you to process audio files – or any binary files – easily and at scale.

Klio jobs are :violetemph:`opinionated` data pipelines in Python (streaming or batch) built upon `Apache Beam <https://beam.apache.org/>`_ and tuned for audio and binary file processing.

Klio was built by Spotify to run our large-scale :violetemph:`audio intelligence systems` and is used by teams of engineers and audio researchers to help develop and deploy next generation audio algorithms.

.. end-intro

Read more about Klio `here <https://docs.klio.io/en/latest/userguide/index.html>`_.

Get Started
-----------

Check out our `Quick Start <https://docs.klio.io/en/latest/userguide/quickstart/index.html>`_ guide on how to start using Klio.


Resources
---------

.. start-resources

* Have a look at our `complete documentation <https://docs.klio.io/en/latest/index.html>`_.
* Check out our `contributors' guide <https://docs.klio.io/en/latest/contributors.html>`_.
* Join the ``#klio`` channel in the `Spotify FOSS Slack organization <https://slackin.spotify.com>`_.
* Read up on some of our `FAQs <https://docs.klio.io/en/latest/faqs/index.html>`_.
* Review our `Code of Conduct <https://github.com/spotify/klio/blob/master/CODE_OF_CONDUCT.rst>`_ - this is how we roll.

.. end-resources

Release Information
===================

21.3.0rc1 (2021-03-24)
----------------------

* Bumping version for March 2021 release; no changes in this package.


`Full Changelog <https://docs.klio.io/en/latest/reference/audio/changelog.html>`_.