{ "info": { "author": "Vadim Kalinskiy", "author_email": "vkalinsky@epiphan.com", "bugtrack_url": null, "classifiers": [], "description": "# AV Studio API\n\nThis repo contains:\n\n- `/avstudio`: Python wrapper for AV Studio API\n- `/docs`: API reference\n- `/device_api.ipynb`: Python notebook with API tutorial\n- `/device_api.html`: static version of the tutorial ([link](http://htmlpreview.github.io/?https://github.com/epiphan-video/avstudio_api/blob/master/device_api.html))\n\n## Installation\n\n```\n$ git clone https://github.com/epiphan-video/avstudio_api.git\n$ cd avstudio_api\n$ pip install -r requirements.txt\n```\n\n## Running the interactive tutorial\n\nJupyter has to be installed.\n\n```\n$ cd avstudio_api\n$ python -m notebook\n```\n\n## Documentation\n\nAPI documentation is available via Github Pages: [https://epiphan-video.github.io/avstudio_api](https://epiphan-video.github.io/avstudio_api/)\n\n\n### How to update docs\n\nDocumentation source is stored in `docs-source-slate` folder.\n\n1) Build a slate builder container (once):\n\n```shell\n$ cd slate\n$ docker build -t slate-builder .\n```\n\n2) (optional) Start doc server:\n```bash\ndocker run -it --rm \\\n -v $(pwd)/docs-source-slate/:/slate/source \\\n -v $(pwd)/docs:/slate/build \\\n -p 4567:4567 \\\n slate-builder bundle exec middleman server\n```\n\n...and open http://localhost:4567/ in your browser.\n\n3) When editing is done, use the container to build static docs:\n\n```bash\ndocker run -it --rm -v $(pwd)/docs-source-slate/:/slate/source -v $(pwd)/docs:/slate/build slate-builder\n```\n\nThis command will update files in `docs` folder, if necessary.\n\n3) git commit and push\n\n### Exporting notebook tutorial:\n\n```\njupyter nbconvert --to html --execute device_api.ipynb --ExecutePreprocessor.timeout=-1\n```\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/epiphan-video/avstudio_api", "keywords": "avstudio", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "avstudio", "package_url": "https://pypi.org/project/avstudio/", "platform": "", "project_url": "https://pypi.org/project/avstudio/", "project_urls": { "Documentation": "https://epiphan-video.github.io/avstudio_api", "Homepage": "https://github.com/epiphan-video/avstudio_api" }, "release_url": "https://pypi.org/project/avstudio/2.0/", "requires_dist": [ "requests", "requests-toolbelt" ], "requires_python": ">=2.7", "summary": "Python wrappers for AV Studio public API", "version": "2.0" }, "last_serial": 5620192, "releases": { "2.0": [ { "comment_text": "", "digests": { "md5": "520f5e8467d2c05ff66c77f514232efb", "sha256": "fbcda10ce75c36285cf505559a342b33f7e33f2534a34fb728c50cb410415c76" }, "downloads": -1, "filename": "avstudio-2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "520f5e8467d2c05ff66c77f514232efb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 7426, "upload_time": "2019-08-01T18:53:27", "url": "https://files.pythonhosted.org/packages/83/53/23aa20b9d31fe90405e24fdab2f40b831ec8dd0f3b14b019116b6f2282e0/avstudio-2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "409a52c1ad87ad9cffd81fb754f35132", "sha256": "8f161a4f3bdb93e6655b2de116c438d48ebcc1715232c69f4ac60829b1db73de" }, "downloads": -1, "filename": "avstudio-2.0.tar.gz", "has_sig": false, "md5_digest": "409a52c1ad87ad9cffd81fb754f35132", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 4999, "upload_time": "2019-08-01T18:53:29", "url": "https://files.pythonhosted.org/packages/d4/3c/eca9b71dbbe3c32bc0a9e0b415e632326624bfd2e587c155878a8f3eed01/avstudio-2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "520f5e8467d2c05ff66c77f514232efb", "sha256": "fbcda10ce75c36285cf505559a342b33f7e33f2534a34fb728c50cb410415c76" }, "downloads": -1, "filename": "avstudio-2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "520f5e8467d2c05ff66c77f514232efb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 7426, "upload_time": "2019-08-01T18:53:27", "url": "https://files.pythonhosted.org/packages/83/53/23aa20b9d31fe90405e24fdab2f40b831ec8dd0f3b14b019116b6f2282e0/avstudio-2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "409a52c1ad87ad9cffd81fb754f35132", "sha256": "8f161a4f3bdb93e6655b2de116c438d48ebcc1715232c69f4ac60829b1db73de" }, "downloads": -1, "filename": "avstudio-2.0.tar.gz", "has_sig": false, "md5_digest": "409a52c1ad87ad9cffd81fb754f35132", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 4999, "upload_time": "2019-08-01T18:53:29", "url": "https://files.pythonhosted.org/packages/d4/3c/eca9b71dbbe3c32bc0a9e0b415e632326624bfd2e587c155878a8f3eed01/avstudio-2.0.tar.gz" } ] }