Feature/bunny stream

.github/workflows/dev.yml

@@ -0,0 +1,27 @@
+name: Python application
+
+on:
+  push:
+    branches:
+      - feature/*
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - run: touch .env
+    - run: docker-compose pull
+    # In this step, this action saves a list of existing images,
+    # the cache is created without them in the post run.
+    # It also restores the cache if it exists.
+    - uses: satackey/[email protected]
+      # Ignore the failure of a step and avoid terminating the job.
+      continue-on-error: true
+    - run: docker-compose build
+
+    - name: Run Unit Tests
+      run: docker-compose run web poetry run python -m unittest
+
+

.github/workflows/prod.yml

@@ -0,0 +1,55 @@
+name: Python application
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Configure AWS Credentials
+      uses: aws-actions/configure-aws-credentials@v1
+      with:
+        aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+        aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        aws-region: us-east-1
+    - run: docker-compose pull
+    # In this step, this action saves a list of existing images,
+    # the cache is created without them in the post run.
+    # It also restores the cache if it exists.
+    - uses: satackey/[email protected]
+      # Ignore the failure of a step and avoid terminating the job.
+      continue-on-error: true
+    - run: docker-compose build
+
+    - name: Run Unit Tests
+      run: docker-compose run web poetry run python -m unittest
+
+    - name: Publish to PyPi
+      if: github.ref == 'refs/heads/master'
+      run: docker-compose run web poetry build && docker-compose run web poetry publish --username=${{ secrets.PYPI_USERNAME }} --password=${{ secrets.PYPI_PASSWORD }}
+
+    - name: Create pdoc
+      run: docker-compose run web poetry run python -m pdoc -o ./docs bunnyhop
+
+    - uses: shallwefootball/s3-upload-action@master
+      name: Upload S3
+      id: S3
+      with:
+        aws_key_id: ${{ secrets.AWS_KEY_ID }}
+        aws_secret_access_key: ${{ secrets.AWS_SECRET_ACCESS_KEY}}
+        aws_bucket: ${{ secrets.AWS_BUCKET }}
+        source_dir: 'docs'
+
+    - name: Update deployment status (success)
+      if: success()
+      uses: chrnorm/deployment-status@releases/v1
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        target_url: https://${{ secrets.AWS_BUCKET }}.s3-website-us-east-1.amazonaws.com/${{steps.S3.outputs.object_key}}/index.html
+        state: 'success'
+        deployment_id: ${{ steps.test.outputs.deployment_id }}

.gitignore

@@ -76,6 +76,7 @@ target/
 
 # Jupyter Notebook
 .ipynb_checkpoints
+*.ipynb
 
 # IPython
 profile_default/

README.md

@@ -158,6 +158,7 @@ b.Zone.create_edge_rule(
     Triggers = []
 )
 ```
+<hr/>
 ## Storage
 
 ### Storage Zones
@@ -238,6 +239,7 @@ mj['first_name']
 # Returns: 'Michael'
 ```
 
+<hr/>
 # Purge
 
 ## Create a Purge
@@ -246,11 +248,13 @@ mj['first_name']
 b.Purge.create(url='https://myzone.b-cdn.net/style.css')
 ```
 
+<hr/>
 # Stats
 
 ```python
 b.Stats.get(dateFrom='2018-12-01', dateTo='2020-01-01', pullZone='example-zone', serverZoneId='serverZoneID')
 ```
+<hr/>
 # Billing
 
 #### Get Billing Summary
@@ -263,3 +267,192 @@ b.Billing.get()
 ```python
 b.Billing.applycode(couponCode='somecode123')
 ```
+
+<hr/>
+
+# Bunny Stream
+
+1. Acquire first your BunnyNet Stream API key. This Stream API key is different from your own API key.
+2. Create a Video Library in your Bunny console and acquire its Library ID by `navigating to it > API > Video Library ID`
+3. Initialize BunnyStream yung the two keys you have.
+
+
+```python
+from bunnyhop import BunnyStream
+from envs import env
+import os
+
+
+BUNNYCDN_STREAM_API_KEY = '<STREAM_API_KEY>'
+BUNNYCDN_STREAM_LIBRARY_KEY = '<LIBRARY_KEY>'
+
+
+b = BunnyStream(
+    api_key=BUNNYCDN_STREAM_API_KEY,
+    library_id=BUNNYCDN_STREAM_LIBRARY_KEY
+)
+```
+
+
+# StreamCollection
+A `Collection` that can be created in a Bunny's video library.
+
+
+## List Collection
+Lists all of collections available in the given library ID
+
+
+```python
+b.StreamCollection.all(items_per_page=9)
+```
+
+
+
+## Create Collection
+Create a collection. Returns a `StreamCollection` object which you can perform the same operations if you want to not specify the ID
+
+
+```python
+stream_col = b.StreamCollection.create('test')
+stream_col.guid
+```
+
+
+
+## Get a Collection
+Acquires a collection based on the GUID you gave. This returns a `StreamCollection` object.
+
+
+```python
+stream_col = b.StreamCollection.get('6d1089a9-0764-4580-a5c9-e26a98fa7812')
+```
+
+
+## Update a Collection
+Updates a `StreamCollection` object if it has properties but if not, GUID is required.
+
+
+```python
+stream_col.update('updated')
+```
+
+
+## Delete a Collection
+Deletes a collection based on a GUID you provided. If the object is a `StreamCollection` property, it will delete itself if you didn't specified a GUID.
+
+
+```python
+stream_col.delete()
+```
+
+
+
+# Video
+A `Video` that can be created and then uploaded to a collection or just a library.
+
+## Create a Video
+Create a `Video` object in Bunny API. 
+
+**This is required before running `upload()`**
+
+
+```python
+vid = b.Video.create(title='new_video', collection_id='6d1089a9-0764-4580-a5c9-e26a98fa7812')
+```
+
+
+## Upload a Video
+Uploads the Video to Bunny. **`create()` is required before uploading**. If the object is a `Video`-class it will upload itself. Otherwise, provide the GUID of the created video.
+
+
+```python
+import requests
+
+mp4_file = requests.get('https://test-videos.co.uk/vids/bigbuckbunny/mp4/h264/1080/Big_Buck_Bunny_1080_10s_1MB.mp4')
+vid.upload(mp4_file.content)
+# with open(mp4_file, 'rb') as file:
+#     vid.upload(file)
+```
+
+
+## Get a Video
+Acquires a `Video` based on the given GUID.
+
+
+```python
+vid = b.Video.get('fde3acc9-7139-403a-a514-781151e57841')
+```
+
+
+## Fetch a Video
+Uploads a video to the specified `video_id` from the URL that was given. Requires `create()` to be called first and use its provided `video_id`
+
+
+```python
+b.Video.fetch(
+    url='https://test-videos.co.uk/vids/bigbuckbunny/mp4/h264/1080/Big_Buck_Bunny_1080_10s_1MB.mp4',
+    headers={},
+    video_id='5a32233f-b1fd-41f7-ae41-c49ed714fc67')
+```
+
+
+## List videos
+Acquires the list of the videos that are in the current library. 
+
+**Notes**
+
+- The minimum `itemsPerPage` is 10, anything below that will be ignored.
+
+
+```python
+b.Video.all(items_per_page=1)
+```
+
+## Update a Video
+Update a `Video`'s title and collection it belongs. If the object is a `Video` class, it will update itself without needing to provide GUID.
+
+
+```python
+vid.update('updatedTitle', '6d1089a9-0764-4580-a5c9-e26a98fa7812')
+```
+
+
+## Delete a Video
+Deletes a `Video` based on its GUID. If the object is an `Video` class, it will delete itself.
+
+
+```python
+vid.delete()
+```
+
+
+## Set Video's thumbnail
+Set a `Video`'s thumbnail with the specified image's URL
+
+
+```python
+vid.set_thumbnail(thumbnail_url='https://dummyimage.com/600x400/000/fff.jpg')
+```
+
+
+## Add Captions
+
+
+```python
+import base64
+import requests
+
+cc_file = requests.get('https://raw.githubusercontent.com/andreyvit/subtitle-tools/master/sample.srt')
+cc_to_upload = base64.b64encode(cc_file.content)
+
+print(cc_to_upload)
+vid.add_caption(srclang='en', label='test_label', captions_file=cc_to_upload)
+```
+
+
+## Delete Captions
+
+
+```python
+vid.delete_caption('en')
+```

bunnyhop/__init__.py

@@ -1 +1,5 @@
-from .core import Bunny
+"""
+.. include:: ../README.md
+"""
+__docformat__ = "google"
+from .core import Bunny, BunnyStream  

bunnyhop/base.py

@@ -22,9 +22,9 @@ def __init__(self,
             self.endpoint_url = endpoint_url
         super().__init__(**kwargs)
 
-    def __repr__(self):
-        return '<{class_name}: {uni} >'.format(
-            class_name=self.__class__.__name__, uni=self.__str__())
+    # def __repr__(self):
+    #     return '<{class_name}: {uni} >'.format(
+    #         class_name=self.__class__.__name__, uni=self.__str__())
 
     def get_header(self):
         header = {
@@ -79,3 +79,17 @@ def call_storage_api(self, api_url, api_method, header=None, params={}, data={},
             return requests.put(self.get_url(api_url, endpoint_url), headers=header, files=files)
         return self.call_api(api_url, api_method, header=header, params={}, data=data, json_data=json_data,
                              endpoint_url=endpoint_url)
+
+
+class BaseStreamBunny(BaseBunny):
+    """
+    NOTE: The API key for Stream API is different from the bunny.net account API key
+    Docs:
+    https://docs.bunny.net/reference/api-overview
+    """
+
+    endpoint_url = env('BUNNYCDN_STREAM_API_ENDPOINT', 'https://video.bunnycdn.com')
+
+    def __init__(self, api_key, library_id=None, endpoint_url=None, **kwargs):
+        self.library_id = library_id
+        super().__init__(api_key=api_key, endpoint_url=endpoint_url, **kwargs)

bunnyhop/core.py

@@ -3,6 +3,7 @@
 from bunnyhop.stats import Stats
 from bunnyhop.storage import Storage, StorageZone
 from bunnyhop.zone import Zone
+from bunnyhop.stream import StreamCollection, Video
 
 
 class Bunny(object):
@@ -14,3 +15,11 @@ def __init__(self, api_key):
         self.StorageZone = StorageZone(api_key)
         self.Stats = Stats(api_key)
         self.Billing = Billing(api_key)
+
+
+class BunnyStream(object):
+    """  """
+
+    def __init__(self, api_key, library_id):
+        self.StreamCollection = StreamCollection(api_key, library_id)
+        self.Video = Video(api_key, library_id)