https://github.com/virtualbrainlab/vbl-dock

Storage server for VBL JSON files
https://github.com/virtualbrainlab/vbl-dock

Last synced: 18 days ago
JSON representation

Storage server for VBL JSON files

• Host: GitHub
• URL: https://github.com/virtualbrainlab/vbl-dock
• Owner: VirtualBrainLab
• License: mit
• Created: 2023-09-23T19:31:29.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-07T02:14:29.000Z (9 months ago)
• Last Synced: 2024-11-06T01:06:46.822Z (2 months ago)
• Language: Python
• Size: 17.6 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vbl-dock

Storage server for VBL JSON files

This is a Flask application that implements a REST API allowing for PUT/POST/GET access to JSON files stored on the server. The JSON files are not encrypted, but are protected by a password. This isn't really a secure setup, but whatever.

## Development

Run in dev mode by using `python server.py`, which loads the Flask server on `localhost:5000`

## Flask app

Users create a new bucket using the POST `/create/` endpoint, passing a token and password:

```

data = {

    "token": "",

    "password": hash256("")

}

```

Users add new data to a bucket using the POST or PUT `/upload///?auth=` endpoint, passing the data:

```

data = {

    "data": {

        "position": [1,2,3]

    }

}

```

Users access data in a bucket using GET `///?auth=` which will return the raw JSON. 

## Folder structure

`/data/` is the top level folder.

Buckets are stored in `/data/bucket/`. Users then organize their data files by type (e.g. neurons, probes, etc) and with a unique name. P

## Hosting

todo...