orshot 0.1.0__tar.gz

orshot-0.1.0/PKG-INFO

@@ -0,0 +1,214 @@
+Metadata-Version: 2.4
+Name: orshot
+Version: 0.1.0
+Summary: Orshot API SDK for Python.
+Author-email: Rishi Mohan <iamrishi.ms@gmail.com>
+Project-URL: Homepage, https://orshot.com
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.27.1
+
+# Orshot API Python SDK
+
+View on pypi.org: [pypi.org/project/orshot](https://pypi.org/project/orshot/)
+
+## Installation
+
+```
+pip install orshot
+```
+
+## Usage
+
+If you don't have your API key, get one from [orshot.com](https://orshot.com).
+
+### Initialise
+
+```python
+os = orshot.Orshot('YOUR_ORSHOT_API_KEY')
+```
+
+### Render from template
+
+```python
+response = os.render_from_template({'template_id': 'open-graph-image-1', 'modifications': {'title': 'From python sdk new'}, 'response_type': 'base64', 'response_format': 'png'})
+print(response['data'])
+```
+
+### Generate signed URL
+
+```python
+response = os.generate_signed_url({'template_id': 'open-graph-image-1', 'modifications': {'title': 'From python sdk new'}, 'render_type': 'images', 'response_format': 'png', 'expires_at': 1744276943})
+print(response['data'])
+```
+
+## Example
+
+### `Base64` response format
+
+```python
+import orshot
+
+os = orshot.Orshot('os-he2jdus1cbz1dpt4mktgjyvx')
+modifications = {
+    'title': 'From Orshot Python SDK',
+    'description': 'Create Visuals and Automate Image Generation'
+}
+response = os.render_from_template({ 
+    'template_id': 'open-graph-image-1',
+    'modifications': modifications,
+    'response_type': 'base64',
+    'response_format': 'png'
+})
+print(response)
+```
+
+Base64 output
+
+```
+{
+    'data': {
+        'content': 'data:image/png;base64,iVBORw0KGgoAAA',
+        'format': 'png',
+        'type': 'base64',
+        'responseTime': 3208.03
+    }
+}
+```
+
+### `Binary` response format
+
+```python
+from io import BytesIO
+
+import orshot
+from PIL import Image
+
+os = orshot.Orshot('os-he2jdus1cbz1dpt4mktgjyvx')
+modifications = {
+    'title': 'From Orshot Python SDK',
+    'description': 'Create Visuals and Automate Image Generation'
+}
+response = os.render_from_template({ 
+    'template_id': 'open-graph-image-1',
+    'modifications': modifications,
+    'response_type': 'binary',
+    'response_format': 'png'
+})
+
+with Image.open(BytesIO(response.content)) as im:
+    im.save('og.png')
+```
+
+This example writes the binary image to the file `og.png`
+
+### `URL` response format
+
+```python
+import orshot
+
+os = orshot.Orshot('os-he2jdus1cbz1dpt4mktgjyvx')
+modifications = {
+    'title': 'From Orshot Python SDK',
+    'description': 'Create Visuals and Automate Image Generation'
+}
+response = os.render_from_template({ 
+    'template_id': 'open-graph-image-1',
+    'modifications': modifications,
+    'response_type': 'url',
+    'response_format': 'png'
+})
+print(response)
+```
+
+URL output
+
+```
+{
+    'data': {
+        'content': 'https://storage.orshot.com/00632982-fd46-44ff-9a61-f52cdf1b8e62/images/AuBgAsKzLJl.png',
+        'type': 'url',
+        'format': 'png',
+        'responseTime': 3387.08
+    }
+}
+```
+
+### Signed URL
+
+```python
+import orshot
+
+os = orshot.Orshot('os-he2jdus1cbz1dpt4mktgjyvx')
+modifications = {
+    'title': 'From Orshot Python SDK',
+    'description': 'Create Visuals and Automate Image Generation'
+}
+
+response = os.generate_signed_url({ 
+    'template_id': 'open-graph-image-1',
+    'modifications': modifications,
+    'render_type': 'images',
+    'response_format': 'png',
+    'expires_at': 1744276943
+})
+print(response)
+```
+
+Output
+
+```
+{
+  "data": {
+    "url": "https://api.orshot.com/v1/generate/images?expiresAt=1744276943&id=28&templateId=open-graph-image-1&title=From%20python%20sdk%20new&signature=fa4ea0aa4cf05bd9b836be031dccfc26abf41dcc623561ac262c75b658f725f1"
+  }
+}
+```
+
+## render_from_template
+
+Use this function to generate an image.
+
+| argument | required | description |
+|----------|----------|-------------|
+| `template_id` | Yes | ID of the template (`open-graph-image-1`, `tweet-image-1`, `beautify-screenshot-1`) |
+| `modifications` | Yes | Modifications for the selected template. |
+| `response_type` | No | `base64`, `binary`, `url` (Defaults to `base64`). |
+| `response_format` | No | `png`, `webp`, `pdf`, `jpg`, `jpeg` (Defaults to `png`) |
+
+For available templates and their modifications refer [Orshot Templates Page](https://orshot.com/templates)
+
+## generate_signed_url
+
+Use this function to get a signed URL.
+
+| argument | required | description |
+|----------|----------|-------------|
+| `template_id` | Yes | ID of the template (`open-graph-image-1`, `tweet-image-1`, `beautify-screenshot-1`) |
+| `modifications` | Yes | Modifications for the selected template. |
+| `expires_at` | Yes | Expires at time in UNIX timestamp (Integer) |
+| `render_type` | No | `images`, `pdfs` (Defaults to `images`). |
+| `response_format` | No | `png`, `webp`, `pdf`, `jpg`, `jpeg` (Defaults to `png`) |
+
+## Local development and testing
+
+Install `uv` - https://docs.astral.sh/uv/getting-started/installation/#installation-methods
+
+`uv venv` to create the virtual environment. 
+
+Uninstall before building and installing again
+
+`uv pip uninstall orshot`
+
+Build
+
+`python -m build`
+
+To install the package locally for testing
+
+`uv pip install dist/orshot-0.2.1-py3-none-any.whl`
+
+You can create a `test.py` file with a sample code to render an image.

orshot-0.1.0/README.md

@@ -0,0 +1,201 @@
+# Orshot API Python SDK
+
+View on pypi.org: [pypi.org/project/orshot](https://pypi.org/project/orshot/)
+
+## Installation
+
+```
+pip install orshot
+```
+
+## Usage
+
+If you don't have your API key, get one from [orshot.com](https://orshot.com).
+
+### Initialise
+
+```python
+os = orshot.Orshot('YOUR_ORSHOT_API_KEY')
+```
+
+### Render from template
+
+```python
+response = os.render_from_template({'template_id': 'open-graph-image-1', 'modifications': {'title': 'From python sdk new'}, 'response_type': 'base64', 'response_format': 'png'})
+print(response['data'])
+```
+
+### Generate signed URL
+
+```python
+response = os.generate_signed_url({'template_id': 'open-graph-image-1', 'modifications': {'title': 'From python sdk new'}, 'render_type': 'images', 'response_format': 'png', 'expires_at': 1744276943})
+print(response['data'])
+```
+
+## Example
+
+### `Base64` response format
+
+```python
+import orshot
+
+os = orshot.Orshot('os-he2jdus1cbz1dpt4mktgjyvx')
+modifications = {
+    'title': 'From Orshot Python SDK',
+    'description': 'Create Visuals and Automate Image Generation'
+}
+response = os.render_from_template({ 
+    'template_id': 'open-graph-image-1',
+    'modifications': modifications,
+    'response_type': 'base64',
+    'response_format': 'png'
+})
+print(response)
+```
+
+Base64 output
+
+```
+{
+    'data': {
+        'content': 'data:image/png;base64,iVBORw0KGgoAAA',
+        'format': 'png',
+        'type': 'base64',
+        'responseTime': 3208.03
+    }
+}
+```
+
+### `Binary` response format
+
+```python
+from io import BytesIO
+
+import orshot
+from PIL import Image
+
+os = orshot.Orshot('os-he2jdus1cbz1dpt4mktgjyvx')
+modifications = {
+    'title': 'From Orshot Python SDK',
+    'description': 'Create Visuals and Automate Image Generation'
+}
+response = os.render_from_template({ 
+    'template_id': 'open-graph-image-1',
+    'modifications': modifications,
+    'response_type': 'binary',
+    'response_format': 'png'
+})
+
+with Image.open(BytesIO(response.content)) as im:
+    im.save('og.png')
+```
+
+This example writes the binary image to the file `og.png`
+
+### `URL` response format
+
+```python
+import orshot
+
+os = orshot.Orshot('os-he2jdus1cbz1dpt4mktgjyvx')
+modifications = {
+    'title': 'From Orshot Python SDK',
+    'description': 'Create Visuals and Automate Image Generation'
+}
+response = os.render_from_template({ 
+    'template_id': 'open-graph-image-1',
+    'modifications': modifications,
+    'response_type': 'url',
+    'response_format': 'png'
+})
+print(response)
+```
+
+URL output
+
+```
+{
+    'data': {
+        'content': 'https://storage.orshot.com/00632982-fd46-44ff-9a61-f52cdf1b8e62/images/AuBgAsKzLJl.png',
+        'type': 'url',
+        'format': 'png',
+        'responseTime': 3387.08
+    }
+}
+```
+
+### Signed URL
+
+```python
+import orshot
+
+os = orshot.Orshot('os-he2jdus1cbz1dpt4mktgjyvx')
+modifications = {
+    'title': 'From Orshot Python SDK',
+    'description': 'Create Visuals and Automate Image Generation'
+}
+
+response = os.generate_signed_url({ 
+    'template_id': 'open-graph-image-1',
+    'modifications': modifications,
+    'render_type': 'images',
+    'response_format': 'png',
+    'expires_at': 1744276943
+})
+print(response)
+```
+
+Output
+
+```
+{
+  "data": {
+    "url": "https://api.orshot.com/v1/generate/images?expiresAt=1744276943&id=28&templateId=open-graph-image-1&title=From%20python%20sdk%20new&signature=fa4ea0aa4cf05bd9b836be031dccfc26abf41dcc623561ac262c75b658f725f1"
+  }
+}
+```
+
+## render_from_template
+
+Use this function to generate an image.
+
+| argument | required | description |
+|----------|----------|-------------|
+| `template_id` | Yes | ID of the template (`open-graph-image-1`, `tweet-image-1`, `beautify-screenshot-1`) |
+| `modifications` | Yes | Modifications for the selected template. |
+| `response_type` | No | `base64`, `binary`, `url` (Defaults to `base64`). |
+| `response_format` | No | `png`, `webp`, `pdf`, `jpg`, `jpeg` (Defaults to `png`) |
+
+For available templates and their modifications refer [Orshot Templates Page](https://orshot.com/templates)
+
+## generate_signed_url
+
+Use this function to get a signed URL.
+
+| argument | required | description |
+|----------|----------|-------------|
+| `template_id` | Yes | ID of the template (`open-graph-image-1`, `tweet-image-1`, `beautify-screenshot-1`) |
+| `modifications` | Yes | Modifications for the selected template. |
+| `expires_at` | Yes | Expires at time in UNIX timestamp (Integer) |
+| `render_type` | No | `images`, `pdfs` (Defaults to `images`). |
+| `response_format` | No | `png`, `webp`, `pdf`, `jpg`, `jpeg` (Defaults to `png`) |
+
+## Local development and testing
+
+Install `uv` - https://docs.astral.sh/uv/getting-started/installation/#installation-methods
+
+`uv venv` to create the virtual environment. 
+
+Uninstall before building and installing again
+
+`uv pip uninstall orshot`
+
+Build
+
+`python -m build`
+
+To install the package locally for testing
+
+`uv pip install dist/orshot-0.2.1-py3-none-any.whl`
+
+You can create a `test.py` file with a sample code to render an image.

orshot-0.1.0/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires      = ["setuptools>=61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "orshot"
+version = "0.1.0"
+description = "Orshot API SDK for Python."
+readme = "README.md"
+authors = [
+    { name = "Rishi Mohan", email = "iamrishi.ms@gmail.com" }
+]
+license = { file = "LICENSE" }
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+]
+dependencies = [
+    "requests>=2.27.1",
+]
+requires-python = ">=3.6"
+
+[project.urls]
+Homepage = "https://orshot.com"

orshot-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

orshot-0.1.0/setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()

orshot-0.1.0/src/orshot/__init__.py

@@ -0,0 +1 @@
+from orshot.orshot import Orshot

orshot-0.1.0/src/orshot/constants.py

@@ -0,0 +1,6 @@
+ORSHOT_SOURCE = "orshot-python-sdk";
+ORSHOT_API_BASE_URL = "https://api.orshot.com";
+ORSHOT_API_VERSION = "v1";
+DEFAULT_RESPONSE_TYPE = "base64";
+DEFAULT_RESPONSE_FORMAT = "png";
+DEFAULT_RENDER_TYPE = "images";

orshot-0.1.0/src/orshot/exceptions.py

@@ -0,0 +1,5 @@
+class APIException(Exception):
+    pass
+
+class BadRequestException(Exception):
+    pass

orshot-0.1.0/src/orshot/orshot.py

@@ -0,0 +1,74 @@
+import requests
+from orshot.constants import (
+    ORSHOT_SOURCE,
+    ORSHOT_API_VERSION,
+    ORSHOT_API_BASE_URL,
+    DEFAULT_RENDER_TYPE,
+    DEFAULT_RESPONSE_TYPE,
+    DEFAULT_RESPONSE_FORMAT
+)
+from orshot.types import RenderOptions, SignedUrlOptions
+from orshot.exceptions import APIException, BadRequestException
+
+class Orshot:
+    def __init__(self, api_key: str):
+        self.api_key = api_key
+
+    def _get_base_url(self):
+        return f"{ORSHOT_API_BASE_URL}/{ORSHOT_API_VERSION}"
+    
+    def _get_headers(self):
+        return {
+            'Content-Type': 'application/json',
+            'Authorization': f'Bearer {self.api_key}'
+        }
+
+    def render_from_template(self, render_options: RenderOptions):
+        template_id = render_options.get('template_id')
+        modifications = render_options.get('modifications')
+        response_type = render_options.get('response_type', DEFAULT_RESPONSE_TYPE)
+        response_format = render_options.get('response_format', DEFAULT_RESPONSE_FORMAT)
+
+        endpoint_url = f"{self._get_base_url()}/generate/images/{template_id}"
+
+        data = {
+            'source': ORSHOT_SOURCE,
+            'modifications': modifications,
+            'response': {
+                'type': response_type,
+                'format': response_format
+            }
+        }
+
+        response = requests.post(endpoint_url, headers=self._get_headers(), json=data)
+
+        if response.status_code == 200:
+            if response_type == "base64" or response_type == "url":
+                return response.json()
+            else:
+                return response
+        elif response.status_code == 400:
+            error_response = response.json().get('error')
+
+            raise BadRequestException(error_response)
+        else:
+            raise APIException(f"An error occurred while generating an image. Status code: {response.status_code}. Error: {response.json().get('error')}")
+
+    def generate_signed_url(self, signed_url_options: SignedUrlOptions):
+        endpoint_url = f"{self._get_base_url()}/signed-url/create"
+
+        data = {
+            'source': ORSHOT_SOURCE,
+            'templateId': signed_url_options.get('template_id'),
+            'modifications': signed_url_options.get('modifications'),
+            'responseFormat': signed_url_options.get('response_format', DEFAULT_RESPONSE_FORMAT),
+            'renderType': signed_url_options.get('render_type', DEFAULT_RENDER_TYPE),
+            'expiresAt': signed_url_options.get('expires_at')
+        }
+
+        response = requests.post(endpoint_url, headers=self._get_headers(), json=data)
+
+        if response.status_code == 200:
+            return response.json()
+        else:
+            raise APIException(f"An error occurred while generating a signed URL. Status code: {response.status_code}. Error: {response.json()}")

orshot-0.1.0/src/orshot/types.py

@@ -0,0 +1,16 @@
+from dataclasses import dataclass
+
+@dataclass
+class RenderOptions:
+    template_id: str
+    modifications: dict
+    response_type: str
+    response_format: str
+
+@dataclass
+class SignedUrlOptions:
+    template_id: str
+    response_format: str
+    render_type: str
+    modifications: dict
+    expires_at: int

orshot-0.1.0/src/orshot.egg-info/PKG-INFO

@@ -0,0 +1,214 @@
+Metadata-Version: 2.4
+Name: orshot
+Version: 0.1.0
+Summary: Orshot API SDK for Python.
+Author-email: Rishi Mohan <iamrishi.ms@gmail.com>
+Project-URL: Homepage, https://orshot.com
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.27.1
+
+# Orshot API Python SDK
+
+View on pypi.org: [pypi.org/project/orshot](https://pypi.org/project/orshot/)
+
+## Installation
+
+```
+pip install orshot
+```
+
+## Usage
+
+If you don't have your API key, get one from [orshot.com](https://orshot.com).
+
+### Initialise
+
+```python
+os = orshot.Orshot('YOUR_ORSHOT_API_KEY')
+```
+
+### Render from template
+
+```python
+response = os.render_from_template({'template_id': 'open-graph-image-1', 'modifications': {'title': 'From python sdk new'}, 'response_type': 'base64', 'response_format': 'png'})
+print(response['data'])
+```
+
+### Generate signed URL
+
+```python
+response = os.generate_signed_url({'template_id': 'open-graph-image-1', 'modifications': {'title': 'From python sdk new'}, 'render_type': 'images', 'response_format': 'png', 'expires_at': 1744276943})
+print(response['data'])
+```
+
+## Example
+
+### `Base64` response format
+
+```python
+import orshot
+
+os = orshot.Orshot('os-he2jdus1cbz1dpt4mktgjyvx')
+modifications = {
+    'title': 'From Orshot Python SDK',
+    'description': 'Create Visuals and Automate Image Generation'
+}
+response = os.render_from_template({ 
+    'template_id': 'open-graph-image-1',
+    'modifications': modifications,
+    'response_type': 'base64',
+    'response_format': 'png'
+})
+print(response)
+```
+
+Base64 output
+
+```
+{
+    'data': {
+        'content': 'data:image/png;base64,iVBORw0KGgoAAA',
+        'format': 'png',
+        'type': 'base64',
+        'responseTime': 3208.03
+    }
+}
+```
+
+### `Binary` response format
+
+```python
+from io import BytesIO
+
+import orshot
+from PIL import Image
+
+os = orshot.Orshot('os-he2jdus1cbz1dpt4mktgjyvx')
+modifications = {
+    'title': 'From Orshot Python SDK',
+    'description': 'Create Visuals and Automate Image Generation'
+}
+response = os.render_from_template({ 
+    'template_id': 'open-graph-image-1',
+    'modifications': modifications,
+    'response_type': 'binary',
+    'response_format': 'png'
+})
+
+with Image.open(BytesIO(response.content)) as im:
+    im.save('og.png')
+```
+
+This example writes the binary image to the file `og.png`
+
+### `URL` response format
+
+```python
+import orshot
+
+os = orshot.Orshot('os-he2jdus1cbz1dpt4mktgjyvx')
+modifications = {
+    'title': 'From Orshot Python SDK',
+    'description': 'Create Visuals and Automate Image Generation'
+}
+response = os.render_from_template({ 
+    'template_id': 'open-graph-image-1',
+    'modifications': modifications,
+    'response_type': 'url',
+    'response_format': 'png'
+})
+print(response)
+```
+
+URL output
+
+```
+{
+    'data': {
+        'content': 'https://storage.orshot.com/00632982-fd46-44ff-9a61-f52cdf1b8e62/images/AuBgAsKzLJl.png',
+        'type': 'url',
+        'format': 'png',
+        'responseTime': 3387.08
+    }
+}
+```
+
+### Signed URL
+
+```python
+import orshot
+
+os = orshot.Orshot('os-he2jdus1cbz1dpt4mktgjyvx')
+modifications = {
+    'title': 'From Orshot Python SDK',
+    'description': 'Create Visuals and Automate Image Generation'
+}
+
+response = os.generate_signed_url({ 
+    'template_id': 'open-graph-image-1',
+    'modifications': modifications,
+    'render_type': 'images',
+    'response_format': 'png',
+    'expires_at': 1744276943
+})
+print(response)
+```
+
+Output
+
+```
+{
+  "data": {
+    "url": "https://api.orshot.com/v1/generate/images?expiresAt=1744276943&id=28&templateId=open-graph-image-1&title=From%20python%20sdk%20new&signature=fa4ea0aa4cf05bd9b836be031dccfc26abf41dcc623561ac262c75b658f725f1"
+  }
+}
+```
+
+## render_from_template
+
+Use this function to generate an image.
+
+| argument | required | description |
+|----------|----------|-------------|
+| `template_id` | Yes | ID of the template (`open-graph-image-1`, `tweet-image-1`, `beautify-screenshot-1`) |
+| `modifications` | Yes | Modifications for the selected template. |
+| `response_type` | No | `base64`, `binary`, `url` (Defaults to `base64`). |
+| `response_format` | No | `png`, `webp`, `pdf`, `jpg`, `jpeg` (Defaults to `png`) |
+
+For available templates and their modifications refer [Orshot Templates Page](https://orshot.com/templates)
+
+## generate_signed_url
+
+Use this function to get a signed URL.
+
+| argument | required | description |
+|----------|----------|-------------|
+| `template_id` | Yes | ID of the template (`open-graph-image-1`, `tweet-image-1`, `beautify-screenshot-1`) |
+| `modifications` | Yes | Modifications for the selected template. |
+| `expires_at` | Yes | Expires at time in UNIX timestamp (Integer) |
+| `render_type` | No | `images`, `pdfs` (Defaults to `images`). |
+| `response_format` | No | `png`, `webp`, `pdf`, `jpg`, `jpeg` (Defaults to `png`) |
+
+## Local development and testing
+
+Install `uv` - https://docs.astral.sh/uv/getting-started/installation/#installation-methods
+
+`uv venv` to create the virtual environment. 
+
+Uninstall before building and installing again
+
+`uv pip uninstall orshot`
+
+Build
+
+`python -m build`
+
+To install the package locally for testing
+
+`uv pip install dist/orshot-0.2.1-py3-none-any.whl`
+
+You can create a `test.py` file with a sample code to render an image.

orshot-0.1.0/src/orshot.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+README.md
+pyproject.toml
+setup.py
+src/orshot/__init__.py
+src/orshot/constants.py
+src/orshot/exceptions.py
+src/orshot/orshot.py
+src/orshot/types.py
+src/orshot.egg-info/PKG-INFO
+src/orshot.egg-info/SOURCES.txt
+src/orshot.egg-info/dependency_links.txt
+src/orshot.egg-info/requires.txt
+src/orshot.egg-info/top_level.txt

orshot-0.1.0/src/orshot.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

orshot-0.1.0/src/orshot.egg-info/requires.txt

@@ -0,0 +1 @@
+requests>=2.27.1

orshot-0.1.0/src/orshot.egg-info/top_level.txt

@@ -0,0 +1 @@
+orshot