Metadata-Version: 2.1
Name: klio-exec
Version: 21.8.0rc1
Summary: Component of klio project that reduces boilerplate while \                    writing YAML-config-driven, Dockerized python Beam pipelines\                     - probably for audio processing.
Home-page: https://github.com/spotify/klio
Author: The klio developers
Author-email: opensource+klio@spotify.com
Maintainer: The klio developers
Maintainer-email: opensource+klio@spotify.com
License: UNKNOWN
Project-URL: Documentation, https://docs.klio.io
Project-URL: Bug Tracker, https://github.com/spotify/klio/issues
Project-URL: Source Code, https://github.com/spotify/klio
Keywords: klio,apache,beam,audio
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Multimedia
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Multimedia :: Sound/Audio
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Image Processing
Requires-Python: >=3.6, <3.9
Description-Content-Type: text/x-rst
Provides-Extra: docs
Provides-Extra: tests
Provides-Extra: debug
Provides-Extra: dev

The ``klio-exec`` Package
=========================


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

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

.. start-klio-exec-intro

The executor – **not** meant to be used directly by the user – is a CLI that launches a pipeline from within a job's Docker container (a.k.a. an Apache Beam's `"driver"`_).
Many commands from the ``klio-cli`` directly wrap to commands in the executor: a ``klio-cli`` command will set up the Docker context needed to correctly run the pipeline via the associated command with ``klio-exec``.
The Docker context includes mounting the job directory, sets up environment variables, mounting credentials, etc.

As the ``klio-exec`` package 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/executor/index.html>`_ for more information.


.. _"driver": https://beam.apache.org/documentation/programming-guide/#overview



.. 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.8.0 (UNRELEASED)
-------------------

.. start-21.8.0

Added
*****

* Add support for calling ``DirectGKERunner`` when set in job configuration.


Changed
*******

* Use newly-added ``KlioReadFromPubSub`` and ``KlioWriteToPubSub`` transforms instead of native Beam's transforms.

Fixed
*****

* Limit version of ``line_profiler`` as the latest introduced breaking API changes.
* Limit google-cloud-pubsub dependency


.. end-21.8.0

.. _exec-21.2.0:


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



