https://github.com/ynput/ayon-aquarium
AYON addon for Aquarium integration
https://github.com/ynput/ayon-aquarium
addon aquarium ayon pipeline ynput
Last synced: about 2 months ago
JSON representation
AYON addon for Aquarium integration
- Host: GitHub
- URL: https://github.com/ynput/ayon-aquarium
- Owner: ynput
- License: apache-2.0
- Created: 2024-01-25T10:11:17.000Z (over 2 years ago)
- Default Branch: develop
- Last Pushed: 2024-11-30T14:31:08.000Z (over 1 year ago)
- Last Synced: 2026-04-13T07:49:52.509Z (about 2 months ago)
- Topics: addon, aquarium, ayon, pipeline, ynput
- Language: Python
- Homepage: https://ayon.ynput.io/features?addons=aquarium
- Size: 810 KB
- Stars: 1
- Watchers: 7
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Aquarium addon
> [!NOTE]
> This addon is ready to be used, but keep in mind that it isn't been tested heavily in a production environment.
> If you have any issue, feel free to [reach us](mailto:support@fatfi.sh) or directly open a new issue.
## Presentation
Welcome in [Aquarium](https://fatfi.sh/aquarium) addon for [Ayon](https://ynput.io/ayon/). 🎉
With this addon, you will be able to connect your projects from Ayon and Aquarium to synchronize your data. You can also create new Aquarium projects, using your existing Ayon projects.
This addon is composed by 3 main parts:
- [Client](#client)
- [Server](#server)
- API
- Frontend
- [Services](#services)
- Leecher
- Processor
### Directory structure
#### Client
Client code is used in the [Ayon Launcher](https://github.com/ynput/ayon-launcher), the AYON pipeline desktop application.
> [!WARNING]
> The client integration is not finished yet.
This client integration allow you to
- Authenticate the user
- Publish media
#### Server
Python server-side part of the addon. It's mainly used to declare specific addon API endpoints, used by the leecher and processor services to keep your data in sync.
It's also responsible to decalre specific addon settings, in your Ayon server and project settings.
##### Frontend
This folder is used to provide a web UI in your Ayon settings to pair projects between Ayon and Aquarium and also to trigger a full project sync.
#### Services
Syncing data between Ayon and Aquarium relies on [Ayon services system](https://ayon.ynput.io/docs/dev_event_system).
This addon use two components:
- **Leecher**
- It's listenning Aquarium's events, and store them into Ayon database for async processing.
- **Processor**
- It's looking for specific Aquarium events in Ayon's database and process them to transform data into compatible Ayon's structure and send request to addon server API endpoints to interact with the server.
## Installation
This addon is available in Ayon's addon market, or you can clone/download this repository to add it into your [Ayon server addon folder](https://ayon.ynput.io/docs/admin_server_installing_addons).
## Development
Looking to develop on this addon ?
First of all thanks !
We created a [dedicated documentation here](https://ayon.ynput.io/docs/addon_aquarium_admin).
## Maintainers
The repository is co-maintained by [Ynput](https://ynput.io) and [Fatfish Lab](https://fatfi.sh)
We welcome new PR, so feel free to open new ones !
## License
This project uses the following license: Apache-2.0. See the license file to read it.