Skip to content

Commit

Permalink
livekit-plugins-minimal (livekit#407)
Browse files Browse the repository at this point in the history
  • Loading branch information
theomonnom authored Jul 5, 2024
1 parent b2d74ce commit d31100b
Show file tree
Hide file tree
Showing 5 changed files with 110 additions and 0 deletions.
4 changes: 4 additions & 0 deletions livekit-plugins/livekit-plugins-minimal/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# LiveKit Plugins Minimal

This is a minimal example of a LiveKit plugin for Agents.

Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Copyright 2023 LiveKit, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from .version import __version__
from livekit.agents import Plugin


class MinimalPlugin(Plugin):
def __init__(self):
super().__init__(__name__, __version__, __package__)

def download_files(self):
pass


Plugin.register_plugin(MinimalPlugin())
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Copyright 2023 LiveKit, Inc.

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

__version__ = "0.1.0"
3 changes: 3 additions & 0 deletions livekit-plugins/livekit-plugins-minimal/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"
61 changes: 61 additions & 0 deletions livekit-plugins/livekit-plugins-minimal/setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Copyright 2023 LiveKit, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import os
import pathlib

import setuptools
import setuptools.command.build_py

here = pathlib.Path(__file__).parent.resolve()
about = {}
with open(os.path.join(here, "livekit", "plugins", "minimal", "version.py"), "r") as f:
exec(f.read(), about)


setuptools.setup(
name="livekit-plugins-minimal",
version=about["__version__"],
description="Minimal plugin template for LiveKit Agents",
long_description=(here / "README.md").read_text(encoding="utf-8"),
long_description_content_type="text/markdown",
url="https://github.com/livekit/agents",
cmdclass={},
classifiers=[
"Intended Audience :: Developers",
"License :: OSI Approved :: Apache Software License",
"Topic :: Multimedia :: Sound/Audio",
"Topic :: Multimedia :: Video",
"Topic :: Scientific/Engineering :: Artificial Intelligence",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3 :: Only",
],
keywords=["webrtc", "realtime", "audio", "video", "livekit"],
license="Apache-2.0",
packages=setuptools.find_namespace_packages(include=["livekit.*"]),
python_requires=">=3.9.0",
install_requires=[
"livekit-agents~=0.7",
],
package_data={
"livekit.plugins.minimal": ["py.typed"],
},
project_urls={
"Documentation": "https://docs.livekit.io",
"Website": "https://livekit.io/",
"Source": "https://github.com/livekit/agents",
},
)

0 comments on commit d31100b

Please sign in to comment.