From f17226f4cce5341b6924faf93227c7af2d71bb41 Mon Sep 17 00:00:00 2001 From: Mark Backman Date: Fri, 13 Dec 2024 11:54:29 -0500 Subject: [PATCH] Updating README, adding LICENSE, CONTRIBUTING --- CONTRIBUTING.md | 164 ++++++++++++++++++++++++++++++++++++++++++++++++ LICENSE.md | 24 +++++++ README.md | 53 ++++++++++++---- 3 files changed, 230 insertions(+), 11 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9129025 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,164 @@ +## Contributing to Pipecat Client iOS + +We welcome contributions of all kinds! Your help is appreciated. Follow these steps to get involved: + +1. **Fork this repository**: Start by forking the Pipecat Client iOS repository to your GitHub account. + +2. **Clone the repository**: Clone your forked repository to your local machine. + ```bash + git clone https://github.com/your-username/pipecat-client-ios + ``` +3. **Create a branch**: For your contribution, create a new branch. + ```bash + git checkout -b your-branch-name + ``` +4. **Make your changes**: Edit or add files as necessary. +5. **Test your changes**: Ensure that your changes look correct and follow the style set in the codebase. +6. **Commit your changes**: Once you're satisfied with your changes, commit them with a meaningful message. + +```bash +git commit -m "Description of your changes" +``` + +7. **Push your changes**: Push your branch to your forked repository. + +```bash +git push origin your-branch-name +``` + +9. **Submit a Pull Request (PR)**: Open a PR from your forked repository to the main branch of this repo. + > Important: Describe the changes you've made clearly! + +Our maintainers will review your PR, and once everything is good, your contributions will be merged! + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +- Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery, and sexual attention or advances of + any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, + without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official email address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at pipecat-ai@daily.co. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..cd6220d --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,24 @@ +BSD 2-Clause License + +Copyright (c) 2024, Daily + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md index 261f004..e526db5 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,34 @@  pipecat -The [Pipecat](https://github.com/pipecat-ai/) project uses [RTVI-AI](https://github.com/rtvi-ai/), an open standard for Real-Time Voice [and Video] Inference. +[![Docs](https://img.shields.io/badge/Documentation-blue)](https://docs.pipecat.ai/client/reference/ios/introduction) [![Discord](https://img.shields.io/discord/1239284677165056021)](https://discord.gg/pipecat) -This iOS core library exports a VoiceClient that has no associated transport. +The official iOS client SDK for [Pipecat](https://github.com/pipecat-ai/pipecat), an open source Python framework for building voice and multimodal AI applications. -When building an RTVI application, you should use your transport-specific export (see [here](https://rtvi.mintlify.app/api-reference/transports/introduction) for available first-party packages.) -The base class has no out-of-the-box bindings included. +## Overview + +The Pipecat iOS SDK provides a Swift implementation for building voice and multimodal AI applications on iOS. + +The SDK handles: + +- Device and media stream management +- Managing bot configuration +- Sending generic actions to the bot +- Handling bot messages and responses +- Managing session state and errors + +To connect to a bot, you will need both this SDK and a transport implementation. + +**Transport packages:** + +For connected use-cases, you must pass a transport instance to the constructor for your chosen protocol or provider. + +For example, if you were looking to use WebRTC as a transport layer, you may use a provider like [Daily](https://daily.co). In this scenario, you’d construct a transport instance and pass it to the client accordingly: + +```swift +let client = VoiceClient(baseUrl: "your-api-url", transport: YOUR_TRANSPORT, options: options) +try await client.connect() +``` ## Install @@ -25,12 +47,21 @@ and add `"PipecatClientIOS"` to your application/library target, `dependencies`, ], ``` -## References -- [RTVI-AI overview](https://github.com/rtvi-ai/). -- [RTVI-AI reference docs](https://rtvi.mintlify.app/api-reference/introduction). -- [rtvi-client-ios SDK docs](https://rtvi-client-ios-docs.vercel.app/RTVIClientIOS/documentation/rtviclientios). -- [rtvi-client-ios-daily SDK docs](https://rtvi-client-ios-docs.vercel.app/RTVIClientIOSDaily/documentation/rtviclientiosdaily). - ## Contributing -We are welcoming contributions to this project in form of issues and pull request. For questions about RTVI head over to the [Pipecat discord server](https://discord.gg/pipecat) and check the [#rtvi](https://discord.com/channels/1239284677165056021/1265086477964935218) channel. +We welcome contributions from the community! Whether you're fixing bugs, improving documentation, or adding new features, here's how you can help: + +- **Found a bug?** Open an [issue](https://github.com/pipecat-ai/pipecat-client-ios/issues) +- **Have a feature idea?** Start a [discussion](https://discord.gg/pipecat) +- **Want to contribute code?** Check our [CONTRIBUTING.md](CONTRIBUTING.md) guide +- **Documentation improvements?** [Docs](https://github.com/pipecat-ai/docs) PRs are always welcome + +Before submitting a pull request, please check existing issues and PRs to avoid duplicates. + +We aim to review all contributions promptly and provide constructive feedback to help get your changes merged. + +## Getting help + +➡️ [Join our Discord](https://discord.gg/pipecat) + +➡️ [Read the docs](https://docs.pipecat.ai)