Python wrappers for AV Studio public API
Project description
AV Studio API
This repo contains:
/avstudio
: Python wrapper for AV Studio API/docs
: API reference/device_api.ipynb
: Python notebook with API tutorial/device_api.html
: static version of the tutorial (link)
Installation
$ git clone https://github.com/epiphan-video/avstudio_api.git
$ cd avstudio_api
$ pip install -r requirements.txt
Running the interactive tutorial
Jupyter has to be installed.
$ cd avstudio_api
$ python -m notebook
Documentation
API documentation is available via Github Pages: https://epiphan-video.github.io/avstudio_api
How to update docs
Documentation source is stored in docs-source-slate
folder.
- Build a slate builder container (once):
$ cd slate
$ docker build -t slate-builder .
- (optional) Start doc server:
docker run -it --rm \
-v $(pwd)/docs-source-slate/:/slate/source \
-v $(pwd)/docs:/slate/build \
-p 4567:4567 \
slate-builder bundle exec middleman server
...and open http://localhost:4567/ in your browser.
- When editing is done, use the container to build static docs:
docker run -it --rm -v $(pwd)/docs-source-slate/:/slate/source -v $(pwd)/docs:/slate/build slate-builder
This command will update files in docs
folder, if necessary.
- git commit and push
Exporting notebook tutorial:
jupyter nbconvert --to html --execute device_api.ipynb --ExecutePreprocessor.timeout=-1
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
avstudio-2.0.tar.gz
(5.0 kB
view hashes)
Built Distribution
avstudio-2.0-py3-none-any.whl
(7.4 kB
view hashes)