======================================
[](https://travis-ci.org/PerchLive/django-broadcast) [](https://pypi.python.org/pypi/django-broadcast) [](https://coveralls.io/github/PerchLive/django-broadcast?branch=master) [](https://pypi.python.org/pypi/django-broadcast) [](https://pypi.python.org/pypi/django-broadcast)
Overview
--------
Video broadcasting support for Django apps. Designed to abstract provisioning backend storage for video streaming clients behind
simple "Start Stream" and "Stop Stream" API calls.
API
---
These endpoints are all `POST`. Parameters are URL encoded for request, and JSON encoded for response.
## /stream/start/
#### Request (url encoded)
```
{
'type' : 'hls' (this is the only option currently supported)
'name' : 'some_name' (optional)
}
```
e.g: `https://endpoint.tld/stream/start/?name=some_name&type=hls`
#### Response (json encoded)
```javascript
{
'stream' : {
'id' : 'stream_id', (generally a UUID or similar)
'name' : 'some_name',
'start_date' : '2015-10-22 15:27:40', (time always in GMT)
},
'endpoint': {
'S3': {
'aws_access_key_id': 'key'
'aws_secret_access_key': 'secret',
'aws_session_token': 'token',
'aws_expiration': 3600.0 // in seconds
's3_bucket_name': 'bucket',
's3_bucket_path': 'path',
's3_bucket_region': 'us-west-1' // valid amazon region string
}
// future endpoints could go here, like RTMP, WebRTC, etc
}
}
```
## /stream/stop/
#### Request (url encoded)
```
{
'id' : 'stream_id'
}
```
e.g: `https://endpoint.tld/stream/start/?id=B8C2401D-B2F8-47CD-90BD-53B608D47F3F`
#### Response (json encoded)
```javascript
{
'stream': {
'id' : 'stream_id',
'name' : 'some_name',
'start_date' : '2015-10-22 15:27:40', (time always in GMT)
'stop_date' : '2015-10-22 16:27:40', (time always in GMT)
}
}
```
Usage
---
We currently recommend your hosting Django application setup the URL and views for `/stream/start` and `/stream/stop`.
Within those views, you can yield to built-in methods to handle most of the work for you while leaving you ultimate control
over the request and response formats.
For example, your `/stream/start` view may look like:
```python
from django.http import JsonResponse
from django_broadcast.api import start_hls_stream, prepare_start_hls_stream_response
def your_start_stream_view(request):
# Do request validation, etc.
# Prepare for new Stream : This handles creating storage credentials
# and preparing data needed by mobile client
start_result = start_hls_stream(request=request)
# start_result is a python dictionary with format:
# {'stream': ..., 'storage': ...}
# Use built-in function for standard dictionary representation
# as specified in API section above.
serialized_response = prepare_start_hls_stream_response(start_result)
return JsonResponse({'success': true, 'response': serialized_response})
```
Requirements
------------
- Python (2.7, 3.3, 3.4)
- Django (1.6, 1.7, 1.8)
- Django REST Framework (2.4, 3.0, 3.1)
Installation
------------
Install using `pip`
$ pip install django-broadcast
Setup
-----
Currently django-broadcast supports an `S3` backend:
```python
BROADCAST_SETTINGS = {
"STREAM_MODEL": "home.Stream",
"S3": {
"AWS_ACCESS_KEY_ID": os.environ.get('DJ_BROADCAST_AWS_ACCESS_KEY', ''),
"AWS_SECRET_ACCESS_KEY": os.environ.get('DJ_BROADCAST_AWS_ACCESS_SECRET', ''),
"BUCKET": os.environ.get('DJ_BROADCAST_S3_BUCKET', '')
}
}
```
Testing
-------
Install testing requirements.
$ pip install -r requirements.txt
Run with runtests.
$ ./runtests.py
You can also use the excellent `tox`_ testing tool to run the tests
against all supported versions of Python and Django. Install tox
globally, and then simply run:
$ tox
Metadata
Release files for django-broadcast 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| django-broadcast-0.1.1.tar.gz | 13.8 kB | Without provenance | Details for django-broadcast-0.1.1.tar.gz |
Release files / django-broadcast-0.1.1.tar.gz
| Download URL | django-broadcast-0.1.1.tar.gz |
|---|---|
| Size | 13.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dfb43a8152ec15f31c33e5d0d8b926304c421c2737e646f336c55c07abdd3dcb
|
|
BLAKE2b-256 checksum How to use checksums |
855c7d9cf8f9d19cb8833c1f38b57700b9434ee7e0015689ed3522093f047985
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for django-broadcast 0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.