Skip to main content

Spongecake is the easiest way to launch OpenAI computer use agents.

Project description

spongecake logo

Open source SDK to launch OpenAI computer use agents 🤖

[coming soon] Shows a demo of spongecake in action

(coming soon) Spinning up a computer use agent with sponge box

What is spongecake?

🚀 spongecake is the easiest way to launch OpenAI computer use agents.

Prerequisites

You’ll need the following to get started (click to download):

Note: The versions mentioned above are tested references. Other versions may work, but haven’t been fully validated.

Quick Start

Install the spongecake package using pip:

pip install spongecake

Clone the repo and run test.py...

cd spongecake/test
python3 test.py

Done! Edit the script in test.py to test out sponge bob

Usage Details

[coming soon]

How it works

[coming soon]

Appendix

Contributing

Feel free to open issues for any feature requests or if you encounter any bugs! We love and appreciate contributions of all forms.

Pull Request Guidelines

  1. Fork the repo and create a new branch from main.
  2. Commit changes with clear and descriptive messages.
  3. Include tests, if possible. If adding a feature or fixing a bug, please include or update the relevant tests.
  4. Open a Pull Request with a clear title and description explaining your work.

Roadmap

[coming soon]

Team

Made with ❤️ in San Francisco

Backend set-up

  • Set-up .env in the backend folder with OpenAI Key and Port

SDK set-up

  • cd sdk
  • (in spongecake) pip3 install --upgrade pip setuptools wheel build
  • (in spongecake) pip install --upgrade openai # Make sure you get the latest responses API
  • (in spongecake) python3.11 -m build
  • (in spongecake) pip3 install dist/spongecake-0.1.2-py3-none-any.whl
  • (in root) pip3 install -e spongecake/
  • pip3 install dotenv

Testing the app

  • python3 test.py

Building and running the docker container

  • cd sdk/docker
  • docker build -t local-lxde-vm
  • docker run -d -p 5900:5900 --name myvm local-lxde-vm
  • docker exec -it myvm bash

Connecting to virtual desktop

  • Open TigerVNC viewer
  • Connect to localhost:5900

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spongecake-0.1.0.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

spongecake-0.1.0-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file spongecake-0.1.0.tar.gz.

File metadata

  • Download URL: spongecake-0.1.0.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for spongecake-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3d0895471f0b808d8ecf31f88ed492b0af902f1b5628221644edfb87488965b6
MD5 6e480ec208a703331b6bd289f702b57d
BLAKE2b-256 704e29da461faa063148965f0da1c1f582fe5ccea8492be6f75905c0785480ec

See more details on using hashes here.

File details

Details for the file spongecake-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: spongecake-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for spongecake-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c2be0f7760df2a31820354908598c71ce22bac66579b92bcbb784f27df2715bb
MD5 f265f0d11ca65046f84d00c443a2f5cc
BLAKE2b-256 8d82c26ee8bd82cebdafcc2901bd4a524822126f2db6c8c48e8d8f7dfac2b412

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page