machiq/frameio-python-sync

Synchronize a server with Frame.io.

Synchronize a server with Frame.io.

Running with Docker

docker pull strombergdev/frameio-python-sync

In order for the server, running in Docker, to be able to see your local filesystem, you have to mount/bind the directory you'd like to expose to the daemon by constructing the correct volume mount string.

For this example, we're going to mount a directory called 'Sync' that is located at /Users/jeff/Sync.

docker run -it -v $PWD/data:/app/server/db -v /Users/jeff/Sync:/app/mount -p 5111:5111 strombergdev/frameio-python-sync:latest

Select /app/mount in the web interface to sync your files to /Users/jeff/Sync.

Login

If you are using docker you should be able to login with your Frame.io username and password. Another option is to use a dev token or a custom OAuth app as instructed below.

Dev token login:

1. Create a dev token at developer.frame.io
   • Required scopes: asset.read, asset.create, asset.delete, project.read, team.read, account.read

Custom OAuth app:

1. Create a PKCE OAuth app at developer.frame.io
   • Required scopes: offline, asset.read, asset.create, asset.delete, project.read, team.read, account.read
   • Running on localhost:
     • Set Redirect URIs to http://127.0.0.1:5111 (port 8080 if running with npm run serve)
   • Running on server:
     • Set Redirect URIs to http://SERVER_IP:5111
2. Enter CLIENT_ID and REDIRECT_URL into config.py

Manual install

Requirements: Python 3.5-3.9 and npm.

Setup/start server:

1. Run make install

2. To run frontend dynamically with VUE hot-reload for development:

   • Run make api
   • In another shell environment, run make web
   • Go to http://127.0.0.1:8080

   To build frontend, when you just want to run without changing stuff:

   • Run make buildweb
   • Run make api
   • Go to http://127.0.0.1:5111 or http://SERVER_IP:5111

3. Login in the top right

4. Choose what folders you want to sync!

Sync Policy

Uploads

- Local files are considered ready for upload if they haven't been updated in the last 60 secs.
- Uploads are verified with XXHash and retried up to 3 times.

Downloads

- Frame.io assets are considered ready for download when upload_completed_at is not None.
- Downloads are verified with XXHash and retried up to 3 times.

Deleting files

- Deletions are not synced, i.e deleting a file on Frame.io will not delete it locally and vice versa.
- If you add a new file with the same name as a deleted one, it will not be synced. 

Duplicates

- Multiple assets with the same path/name: only the first one to be discovered will be synced.
- If you replace a file it will not be re-uploaded since the name is still the same.

Renames

- ONLY supported for project name.
- If you rename a local file or folder, it will be uploaded as a new asset to Frame.io.
- If you rename a Frame.io asset, the corresponding local asset will not be changed.

Using a fork of the official python client. Thanks to Jeff at Frame.io for great input and support!