Skip to content

Commit

Permalink
First import, let's call it 0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
madeddie committed Sep 24, 2018
0 parents commit 822da66
Show file tree
Hide file tree
Showing 14 changed files with 1,108 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .gitignore
@@ -0,0 +1,12 @@
# Python related
__pycache__/
*.egg-info/

# IDE related
.vscode/

# Sphinx documentation
docs/_build/

# Operating System related
.DS_Store
18 changes: 18 additions & 0 deletions Pipfile
@@ -0,0 +1,18 @@
[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"

[packages]
requests = "*"
xmltodict = "*"

[dev-packages]
black = "*"
"flake8" = "*"
rope = "*"
pydocstyle = "*"
sphinx = "*"

[requires]
python_version = "3.6"
285 changes: 285 additions & 0 deletions Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

37 changes: 37 additions & 0 deletions README.md
@@ -0,0 +1,37 @@
DVEO REST API wrapper for Python
================================

This module tries to make using the [DVEO][dveo] REST API easier to use with Python.

Example of usage:

```{.sourceCode .python}
>>> from dveo import API
>>> dveo = API('203.0.113.12', 'p455w0rd')
>>> dveo.system_status()['system']['uptime']
OrderedDict([('days', '20'), ('hours', '7'), ('mins', '51')])
>>> dveo.list_inputs()
['net_stream1', 'net_stream2', 'net_stream3', 'net_stream4', ...]
>>> dveo.input_config('net_stream2')['inputname']
'BigTV'
>>> dveo.input_by_output_param('rtmptargeturi', 'acme', partial=True, include_value=True)
[('net_stream1', 'rtmp://vid1.acme.net/stream'), ('net_stream2', 'rtmp://stream10.acme.com/rtmp'), ('net_stream3', 'rtmp://stream11.acme.com/rtmp'), ...]
```

Check out the variables and commands of your DVEO device API on `http(s)://YOURDVEODEVICE:25599/metadata`. The URL isn't protected. The port is set in the DVEO configuration.

Installation
------------

``` {.sourceCode .bash}
$ pipenv install dveo
```

Example scripts
---------------

In the `examples` directory you'll find some implementation examples.

- `retrieve_stream_settings.py` loads input and output settings for one or more encoders and prints them and writes them to a json file.

[dveo]: https://dveo.com/
19 changes: 19 additions & 0 deletions docs/Makefile
@@ -0,0 +1,19 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

0 comments on commit 822da66

Please sign in to comment.