Skip to content

Commit 9d0b0b5

Browse files
authored
Merge pull request #4 from GooeyAI/doc-fixes
updated sdk readme with banner and other details
2 parents 9ba8557 + a4cdaa7 commit 9d0b0b5

File tree

1 file changed

+60
-20
lines changed

1 file changed

+60
-20
lines changed

README.md

Lines changed: 60 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,59 @@
1+
<h3 align="center">
2+
<img src="https://storage.googleapis.com/dara-c1b52.appspot.com/daras_ai/media/cdc58fe0-2da1-11ef-84df-02420a0001f4/githubbanner.png"
3+
/>
4+
</h3>
5+
<p align="center">
6+
<a href="https://gooey.ai">🏠 Homepage</a> ·
7+
<a href="https://gooey.ai/explore">👾 Explore Workflows</a> ·
8+
<a href="https://gooey.ai/docs">📚 Docs</a> ·
9+
<a href="https://gooey.ai/api">🤖 API</a> ·
10+
<a href="https://gooey.ai/discord">🛟 Discord</a> ·
11+
<a href="https://gooey.ai/account">💃🏾 Start Building</a>
12+
</p>
13+
14+
<div>
15+
<p align="center">
16+
<a
17+
href="https://x.com/GooeyAI">
18+
<img src="https://img.shields.io/badge/X/Twitter-000000?style=for-the-badge&logo=x&logoColor=white" />
19+
</a>
20+
<a href="https://in.linkedin.com/company/gooeyai">
21+
<img src="https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white" />
22+
</a>
23+
<a href="https://gooey.ai/discord">
24+
<img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white" />
25+
</a>
26+
<a href="https://www.youtube.com/@gooeyai">
27+
<img src="https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white" />
28+
</a>
29+
</p>
30+
</div>
31+
32+
[Gooey.AI](http://gooey.ai/) is the low-code orchestration platform with **discoverable workflows** & **unified billing to all of GenAI universe.**
33+
134
# Gooey Python Library
235

36+
The Gooey Python library provides convenient access to the Gooey API from Python.
37+
338
[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
439
[![pypi](https://img.shields.io/pypi/v/gooeyai)](https://pypi.python.org/pypi/gooeyai)
540

6-
The Gooey Python library provides convenient access to the Gooey API from Python.
41+
# 🤖🐍📦 What Gooey.AI SDK offers?
42+
43+
Gooey.AI simplifies building AI workflows by:
44+
- Offering high and flexible interoperability
45+
- Single API key to run several AI workflows
46+
- Hosting private and open-source AI models - LLMs, ASR, Image and Animation
47+
48+
## 🧑‍💻 Who is this for and why would I want to use it?
49+
50+
- Any developer who wants to quickly prototype with GenAI apps
51+
- Great for those who want to include GenAI in their existing product or app
52+
- Gooey.AI SDKs are great for speedy GTMs as we are already built to scale!
53+
54+
## Try it on Colab
55+
56+
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1EH8zh_zPZgyksR9uitGSO_iXn0JU-JmD?usp=sharing)
757

858
## Installation
959

@@ -21,13 +71,9 @@ from gooey import AnimationPrompt, Gooey
2171
client = Gooey(
2272
api_key="YOUR_API_KEY",
2373
)
24-
client.animate(
25-
animation_prompts=[
26-
AnimationPrompt(
27-
frame="frame",
28-
prompt="prompt",
29-
)
30-
],
74+
client.lipsync(
75+
input_face="./path/to/face.mp4",
76+
input_audio="./path/to/audio.mp3",
3177
)
3278
```
3379

@@ -46,14 +92,10 @@ client = AsyncGooey(
4692

4793

4894
async def main() -> None:
49-
await client.animate(
50-
animation_prompts=[
51-
AnimationPrompt(
52-
frame="frame",
53-
prompt="prompt",
54-
)
55-
],
56-
)
95+
await client.lipsync(
96+
input_face="./path/to/face.mp4",
97+
input_audio="./path/to/audio.mp3",
98+
)
5799

58100

59101
asyncio.run(main())
@@ -136,9 +178,7 @@ client = Gooey(
136178
## Contributing
137179

138180
While we value open-source contributions to this SDK, this library is generated programmatically.
139-
Additions made directly to this library would have to be moved over to our generation code,
140-
otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
141-
a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
142-
an issue first to discuss with us!
181+
182+
Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
143183

144184
On the other hand, contributions to the README are always very welcome!

0 commit comments

Comments
 (0)