Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sageteamorg/django-sage-streaming
django-sage-streaming is a package based on Django Web Framework & Django Rest Framework for video streaming. We made this package in Django so that everyone can easily stream videos.
https://github.com/sageteamorg/django-sage-streaming
django django-streaming django-video-streaming python video-streaming
Last synced: 21 days ago
JSON representation
django-sage-streaming is a package based on Django Web Framework & Django Rest Framework for video streaming. We made this package in Django so that everyone can easily stream videos.
- Host: GitHub
- URL: https://github.com/sageteamorg/django-sage-streaming
- Owner: sageteamorg
- License: gpl-3.0
- Created: 2021-07-15T09:10:12.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-07-22T18:12:11.000Z (6 months ago)
- Last Synced: 2024-12-08T23:14:47.899Z (about 1 month ago)
- Topics: django, django-streaming, django-video-streaming, python, video-streaming
- Language: Python
- Homepage: https://github.com/sageteam-org/django-sage-streaming
- Size: 48.8 KB
- Stars: 41
- Watchers: 3
- Forks: 19
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Authors: AUTHORS.md
Awesome Lists containing this project
README
# Django Sage Streaming
#### django-sage-streaming is a package based on Django Web Framework & Django Rest Framework for video streaming.
##### The Latest version of [django-sage-streaming](https://django-sage-streaming.readthedocs.io/) documentation
- [Project Detail](#project-detail)
- [installation](#installation)
- [Get Started](#getting-started)
- [Admin](#admin)
- [Settings](#settings)
- [Front-End implementation](#frontend)
## Project Detail
You can find all technologies we used in our project into these files:
* Version: 1.0.0
* Frameworks:
- Django 3.2.5
* Libraries:
- Django rest framework 3.12.4
* Language: Python 3.9.4
## Installation
First install package
```shell
$ pip install django-sage-streaming
```
Then add `sage_stream` to INSTALLED_APPS in settings.py
```python
INSTALLED_APPS = [
...
'sage_stream',
...
]
```
Also make sure you have `rest_framework` in INSTALLED_APPS
```python
INSTALLED_APPS = [
...
'rest_framework',
...
]
```
## Getting Started
`django-sage-streaming` provides two ways that you can stream videos over HTTP:
1. built-in API View: for using built-in view add `sage_stream.api.urls` to urls.py
```python
from django.urls import path, include
urlpatterns = [
...
path('api/', include('sage_stream.api.urls')),
...
]
```
Now you can access the stream api here: `localhost:8000/api/stream?path=`
[The settings of built-in view is available here](#settings)
2. create custom views: you can use stream functions in your application
```python
from sage_stream.utils.stream_services import get_streaming_response
response = get_streaming_response(
path=video_path, # path to video
range_header=range_header, # range header extracted from request
range_re=range_re, # range header regex pattern (default is available in sage_stream.settings.STREAM_RANGE_HEADER_REGEX_PATTERN)
max_load_volume=max_load_volume, # the maximum volume of the response body
)
```
Other functions you can use
```python
from sage_stream.utils.file_services import file_iterator # iterates in given file chunk by chunk in generator mode
from sage_stream.utils.log_services import log_watch_request # creates WatchLog instance with given data
# usage examples
# log
log_watch_request(video_path, request.user.is_authenticated, ip, request.user)
# file iterator
resp = StreamingHttpResponse(
file_iterator(
path,
offset=first_byte,
length=length
),
status=206,
content_type=content_type
)
```
## Admin
`django-sage-streaming` also has logging system for watching requests
It is available in admin panel when you add `sage_stream` to INSTALLED_APPS
## Settings
Here are the parameters that you can set from setting:
| Parameter | Description |
| -------------------------------------------- |:--------------------------------------------------------------------------------:|
| STREAM_DEFAULT_PERMISSION_CLASSES | permission_classes that used in built-in APIView. default: (AllowAny,) |
| STREAM_DEFAULT_VIDEO_PATH_URL_VAR | url path variable key. default: path |
| STREAM_MAX_LOAD_VOLUME | maximum load video in each chunk(by MB). default: 8 |
| STREAM_WATCH_LOG_ENABLED | is log watch requests enabled. default: True |
| STREAM_RANGE_HEADER_REGEX_PATTERN | range header regex pattern. default: r'bytes\s*=\s*(\d+)\s*-\s*(\d*)' |
## Frontend
Frontend implementation is so easy
you just need to add stream url as `src` in `video` tag
```html
```