dipsac 0.1.1__tar.gz

dipsac-0.1.1/.gitignore

@@ -0,0 +1,16 @@
+# Python
+python/.venv/
+python/dist/
+python/build/
+*.egg-info/
+__pycache__/
+.pytest_cache/
+
+# JavaScript
+js/node_modules/
+js/dist/
+*.tgz
+
+# never a key
+.env
+.env.*

dipsac-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 DIPSAC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dipsac-0.1.1/PKG-INFO

@@ -0,0 +1,242 @@
+Metadata-Version: 2.5
+Name: dipsac
+Version: 0.1.1
+Summary: The official Python library for the DIPSAC API: PDF, image, audio, video and SEO tools, and the AI Voice Studio.
+Project-URL: Homepage, https://dipsac.com
+Project-URL: Documentation, https://dipsac.com/dashboard/reference
+Project-URL: Source, https://github.com/dipsactools/dipsac-sdk
+Project-URL: Issues, https://github.com/dipsactools/dipsac-sdk/issues
+Author-email: DIPSAC <contact@dipsac.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,audio,dipsac,image,pdf,sdk,text-to-speech,transcription,video
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: httpx<1,>=0.25
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: twine>=5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# DIPSAC Python library
+
+The official Python library for the [DIPSAC API](https://dipsac.com/dashboard/reference):
+PDF, image, audio, video and SEO tools, and the AI Voice Studio (text to speech,
+transcription, subtitles).
+
+```bash
+pip install dipsac
+```
+
+Python 3.9 or newer. The only dependency is `httpx`.
+
+## Quick start
+
+Make a key at <https://dipsac.com/dashboard/keys>. Keys start with `dps_`.
+
+```python
+from dipsac import Dipsac
+
+client = Dipsac(api_key="dps_...")        # or set the DIPSAC_API_KEY environment variable
+
+# Files in, a file out
+merged = client.pdf.merge(["invoice.pdf", "terms.pdf"])
+merged.save("merged.pdf")
+
+# Files in, facts out
+info = client.image.info("photo.jpg")
+print(info["width"], info["height"])
+
+# No file at all
+print(client.dev.json('{"b": 1, "a": 2}', sort_keys=True)["result"])
+```
+
+## What is in it
+
+| | |
+|---|---|
+| `client.pdf` | merge, split, delete_pages, rotate, compress, convert, from_office, protect, unlock, watermark, metadata |
+| `client.image` | convert, compress, resize, crop, remove_background, to_pdf, info |
+| `client.audio` | convert, normalize, merge |
+| `client.video` | convert, extract_audio, cut, resize, mute |
+| `client.seo` | meta, ssl, redirects, whois, domain_age, canonical |
+| `client.dev` | hash, hash_verify, json |
+| `client.ai` | speak, transcribe, transcribe_video, subtitles, builtin_voices, voices, register_voice, library, ... |
+| `client.jobs` | get, result |
+| `client.glb` | limits, inspect, plan, image |
+
+Every method is documented in its docstring, and typed. Which methods your key
+may call depends on your plan; a call your plan does not include raises
+`PermissionDeniedError`, which says which plan does.
+
+## Giving it a file
+
+Anywhere a method takes a file you can pass:
+
+```python
+client.pdf.metadata("report.pdf")                    # a path
+client.pdf.metadata(Path("report.pdf"))              # a pathlib.Path
+client.pdf.metadata(open("report.pdf", "rb"))        # an open binary file
+client.pdf.metadata(pdf_bytes)                       # bytes
+client.pdf.metadata(("report.pdf", pdf_bytes))       # a name and bytes
+```
+
+The API tells what a file is by the extension of its name. A path and an open
+file bring their own name. Bare bytes have none, so the library reads their type
+from how they begin (PDF, PNG, JPEG, GIF, WebP, WAV, MP3, MP4 and a few more);
+for anything else, such as a Word file, pass the `(name, bytes)` form.
+
+Uploads are read into memory before they are sent.
+
+## What you get back
+
+- **JSON** comes back as a `dict`.
+- **A file** comes back as a `DipsacFile`:
+
+  ```python
+  out = client.image.convert("photo.png", "jpg")
+  out.content        # the bytes
+  out.content_type   # "image/jpeg"
+  out.filename       # the name the API gave it, e.g. "photo.jpg"
+  out.save("small.jpg")      # or out.save() to use that name, or out.save("some/folder")
+  ```
+
+- **A `Job`**, when you send the work to the background (next section).
+
+## Long work: background jobs
+
+Slow operations (video, big PDFs, background removal) take `mode="async"`. The
+call returns at once with a `Job`; `wait()` polls until it is done and downloads
+the result.
+
+```python
+job = client.video.convert("talk.mov", "mp4", mode="async")
+clip = job.wait()                 # raises JobFailedError if the job fails
+clip.save("talk.mp4")
+```
+
+`wait(timeout=600, poll_interval=2)` raises `JobTimeoutError` if the job is not
+done in time. The job is not cancelled: keep `job.id` and pick it up later with
+`client.job(job_id).wait()`. Results are kept for a limited time
+(`job.raw["expires_at"]`).
+
+## AI Voice Studio
+
+```python
+# Text to speech
+audio = client.ai.speak("Namaste, aap kaise hain?", language="hi", fmt="mp3")
+audio.save("hello.mp3")
+
+# Long text: synthesise in the background
+audio = client.ai.speak(long_text, language="en", background=True).wait()
+
+# Speech to text
+result = client.ai.transcribe("call.mp3", language="hi")
+print(result["text"])
+
+# Subtitles
+client.ai.subtitles("episode.mp4", fmt="srt").save("episode.srt")
+
+# Which voices exist
+voices = client.ai.builtin_voices(language="hi")
+```
+
+Speech is metered per account. When an allowance is used up the call raises
+`PaymentRequiredError`; `error.body` carries the numbers.
+
+## Errors
+
+Every error is a `dipsac.DipsacError`.
+
+```python
+import dipsac
+
+try:
+    client.audio.convert("voice.wav", "mp3")
+except dipsac.PermissionDeniedError as e:
+    print(e.message)             # "/v1/audio/convert requires the Pro plan or higher. ..."
+    print(e.required_plan)       # "pro"
+except dipsac.RateLimitError as e:
+    print(e.retry_after)         # seconds
+except dipsac.APIStatusError as e:
+    print(e.status_code, e.code, e.message, e.request_id)
+except dipsac.APIConnectionError:
+    print("could not reach the API")
+```
+
+| Status | Exception | |
+|---|---|---|
+| 400 | `BadRequestError` | |
+| 401 | `AuthenticationError` | the key is missing or wrong |
+| 402 | `PaymentRequiredError` | an allowance is used up |
+| 403 | `PermissionDeniedError` | the plan does not include this; `.required_plan` |
+| 404 | `NotFoundError` | |
+| 409 | `ConflictError` | e.g. a job that has not finished |
+| 413 | `PayloadTooLargeError` | the file is over your plan's size limit |
+| 415 | `UnsupportedMediaTypeError` | the wrong kind of file; `.accepted` |
+| 422 | `UnprocessableEntityError` | a parameter is missing or invalid; `.fields` |
+| 429 | `RateLimitError` | `.retry_after` |
+| 5xx | `InternalServerError` | |
+| | `APIConnectionError`, `APITimeoutError` | no answer |
+| | `JobFailedError`, `JobTimeoutError` | background jobs |
+
+Quote `e.request_id` when you write to support.
+
+## Retries
+
+The library sends a request again, up to `max_retries` times (default 2), only
+where that cannot do the work twice:
+
+- a `429` from your plan's per-second limit is waited out and retried;
+- a `429` from your plan's monthly limit is raised at once (waiting would take a day);
+- a connection that never opened is retried;
+- a `GET` that got a 502, 503 or 504 is retried;
+- a `POST` that failed on the server is **not** retried.
+
+## Configuration
+
+```python
+client = Dipsac(
+    api_key="dps_...",
+    timeout=300,            # seconds; per call: client.pdf.compress(f, timeout=60)
+    max_retries=2,
+    base_url="https://api.dipsac.com",
+)
+```
+
+`DIPSAC_API_KEY` and `DIPSAC_BASE_URL` are read from the environment when the
+arguments are left out. Pass `http_client=httpx.Client(...)` to use a proxy or
+your own transport.
+
+## asyncio
+
+```python
+import asyncio
+from dipsac import AsyncDipsac
+
+async def main():
+    async with AsyncDipsac() as client:
+        merged = await client.pdf.merge(["a.pdf", "b.pdf"])
+        job = await client.video.mute("clip.mp4", mode="async")
+        muted = await job.wait()
+
+asyncio.run(main())
+```
+
+## Links
+
+- API reference: <https://dipsac.com/dashboard/reference>
+- Speech API: <https://dipsac.com/dashboard/speech>
+- Support: contact@dipsac.com

dipsac-0.1.1/README.md

@@ -0,0 +1,210 @@
+# DIPSAC Python library
+
+The official Python library for the [DIPSAC API](https://dipsac.com/dashboard/reference):
+PDF, image, audio, video and SEO tools, and the AI Voice Studio (text to speech,
+transcription, subtitles).
+
+```bash
+pip install dipsac
+```
+
+Python 3.9 or newer. The only dependency is `httpx`.
+
+## Quick start
+
+Make a key at <https://dipsac.com/dashboard/keys>. Keys start with `dps_`.
+
+```python
+from dipsac import Dipsac
+
+client = Dipsac(api_key="dps_...")        # or set the DIPSAC_API_KEY environment variable
+
+# Files in, a file out
+merged = client.pdf.merge(["invoice.pdf", "terms.pdf"])
+merged.save("merged.pdf")
+
+# Files in, facts out
+info = client.image.info("photo.jpg")
+print(info["width"], info["height"])
+
+# No file at all
+print(client.dev.json('{"b": 1, "a": 2}', sort_keys=True)["result"])
+```
+
+## What is in it
+
+| | |
+|---|---|
+| `client.pdf` | merge, split, delete_pages, rotate, compress, convert, from_office, protect, unlock, watermark, metadata |
+| `client.image` | convert, compress, resize, crop, remove_background, to_pdf, info |
+| `client.audio` | convert, normalize, merge |
+| `client.video` | convert, extract_audio, cut, resize, mute |
+| `client.seo` | meta, ssl, redirects, whois, domain_age, canonical |
+| `client.dev` | hash, hash_verify, json |
+| `client.ai` | speak, transcribe, transcribe_video, subtitles, builtin_voices, voices, register_voice, library, ... |
+| `client.jobs` | get, result |
+| `client.glb` | limits, inspect, plan, image |
+
+Every method is documented in its docstring, and typed. Which methods your key
+may call depends on your plan; a call your plan does not include raises
+`PermissionDeniedError`, which says which plan does.
+
+## Giving it a file
+
+Anywhere a method takes a file you can pass:
+
+```python
+client.pdf.metadata("report.pdf")                    # a path
+client.pdf.metadata(Path("report.pdf"))              # a pathlib.Path
+client.pdf.metadata(open("report.pdf", "rb"))        # an open binary file
+client.pdf.metadata(pdf_bytes)                       # bytes
+client.pdf.metadata(("report.pdf", pdf_bytes))       # a name and bytes
+```
+
+The API tells what a file is by the extension of its name. A path and an open
+file bring their own name. Bare bytes have none, so the library reads their type
+from how they begin (PDF, PNG, JPEG, GIF, WebP, WAV, MP3, MP4 and a few more);
+for anything else, such as a Word file, pass the `(name, bytes)` form.
+
+Uploads are read into memory before they are sent.
+
+## What you get back
+
+- **JSON** comes back as a `dict`.
+- **A file** comes back as a `DipsacFile`:
+
+  ```python
+  out = client.image.convert("photo.png", "jpg")
+  out.content        # the bytes
+  out.content_type   # "image/jpeg"
+  out.filename       # the name the API gave it, e.g. "photo.jpg"
+  out.save("small.jpg")      # or out.save() to use that name, or out.save("some/folder")
+  ```
+
+- **A `Job`**, when you send the work to the background (next section).
+
+## Long work: background jobs
+
+Slow operations (video, big PDFs, background removal) take `mode="async"`. The
+call returns at once with a `Job`; `wait()` polls until it is done and downloads
+the result.
+
+```python
+job = client.video.convert("talk.mov", "mp4", mode="async")
+clip = job.wait()                 # raises JobFailedError if the job fails
+clip.save("talk.mp4")
+```
+
+`wait(timeout=600, poll_interval=2)` raises `JobTimeoutError` if the job is not
+done in time. The job is not cancelled: keep `job.id` and pick it up later with
+`client.job(job_id).wait()`. Results are kept for a limited time
+(`job.raw["expires_at"]`).
+
+## AI Voice Studio
+
+```python
+# Text to speech
+audio = client.ai.speak("Namaste, aap kaise hain?", language="hi", fmt="mp3")
+audio.save("hello.mp3")
+
+# Long text: synthesise in the background
+audio = client.ai.speak(long_text, language="en", background=True).wait()
+
+# Speech to text
+result = client.ai.transcribe("call.mp3", language="hi")
+print(result["text"])
+
+# Subtitles
+client.ai.subtitles("episode.mp4", fmt="srt").save("episode.srt")
+
+# Which voices exist
+voices = client.ai.builtin_voices(language="hi")
+```
+
+Speech is metered per account. When an allowance is used up the call raises
+`PaymentRequiredError`; `error.body` carries the numbers.
+
+## Errors
+
+Every error is a `dipsac.DipsacError`.
+
+```python
+import dipsac
+
+try:
+    client.audio.convert("voice.wav", "mp3")
+except dipsac.PermissionDeniedError as e:
+    print(e.message)             # "/v1/audio/convert requires the Pro plan or higher. ..."
+    print(e.required_plan)       # "pro"
+except dipsac.RateLimitError as e:
+    print(e.retry_after)         # seconds
+except dipsac.APIStatusError as e:
+    print(e.status_code, e.code, e.message, e.request_id)
+except dipsac.APIConnectionError:
+    print("could not reach the API")
+```
+
+| Status | Exception | |
+|---|---|---|
+| 400 | `BadRequestError` | |
+| 401 | `AuthenticationError` | the key is missing or wrong |
+| 402 | `PaymentRequiredError` | an allowance is used up |
+| 403 | `PermissionDeniedError` | the plan does not include this; `.required_plan` |
+| 404 | `NotFoundError` | |
+| 409 | `ConflictError` | e.g. a job that has not finished |
+| 413 | `PayloadTooLargeError` | the file is over your plan's size limit |
+| 415 | `UnsupportedMediaTypeError` | the wrong kind of file; `.accepted` |
+| 422 | `UnprocessableEntityError` | a parameter is missing or invalid; `.fields` |
+| 429 | `RateLimitError` | `.retry_after` |
+| 5xx | `InternalServerError` | |
+| | `APIConnectionError`, `APITimeoutError` | no answer |
+| | `JobFailedError`, `JobTimeoutError` | background jobs |
+
+Quote `e.request_id` when you write to support.
+
+## Retries
+
+The library sends a request again, up to `max_retries` times (default 2), only
+where that cannot do the work twice:
+
+- a `429` from your plan's per-second limit is waited out and retried;
+- a `429` from your plan's monthly limit is raised at once (waiting would take a day);
+- a connection that never opened is retried;
+- a `GET` that got a 502, 503 or 504 is retried;
+- a `POST` that failed on the server is **not** retried.
+
+## Configuration
+
+```python
+client = Dipsac(
+    api_key="dps_...",
+    timeout=300,            # seconds; per call: client.pdf.compress(f, timeout=60)
+    max_retries=2,
+    base_url="https://api.dipsac.com",
+)
+```
+
+`DIPSAC_API_KEY` and `DIPSAC_BASE_URL` are read from the environment when the
+arguments are left out. Pass `http_client=httpx.Client(...)` to use a proxy or
+your own transport.
+
+## asyncio
+
+```python
+import asyncio
+from dipsac import AsyncDipsac
+
+async def main():
+    async with AsyncDipsac() as client:
+        merged = await client.pdf.merge(["a.pdf", "b.pdf"])
+        job = await client.video.mute("clip.mp4", mode="async")
+        muted = await job.wait()
+
+asyncio.run(main())
+```
+
+## Links
+
+- API reference: <https://dipsac.com/dashboard/reference>
+- Speech API: <https://dipsac.com/dashboard/speech>
+- Support: contact@dipsac.com

dipsac-0.1.1/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["hatchling>=1.24"]
+build-backend = "hatchling.build"
+
+[project]
+name = "dipsac"
+dynamic = ["version"]
+description = "The official Python library for the DIPSAC API: PDF, image, audio, video and SEO tools, and the AI Voice Studio."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.9"
+authors = [{ name = "DIPSAC", email = "contact@dipsac.com" }]
+keywords = ["dipsac", "pdf", "image", "audio", "video", "text-to-speech", "transcription", "api", "sdk"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dependencies = ["httpx>=0.25,<1"]
+
+[project.optional-dependencies]
+dev = ["pytest>=8", "pytest-asyncio>=0.23", "build>=1.2", "twine>=5"]
+
+[project.urls]
+Homepage = "https://dipsac.com"
+Documentation = "https://dipsac.com/dashboard/reference"
+Source = "https://github.com/dipsactools/dipsac-sdk"
+Issues = "https://github.com/dipsactools/dipsac-sdk/issues"
+
+[tool.hatch.version]
+path = "src/dipsac/_version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/dipsac"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/dipsac", "README.md", "LICENSE", "tests"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"

dipsac-0.1.1/src/dipsac/__init__.py

@@ -0,0 +1,41 @@
+"""The official Python library for the DIPSAC API.
+
+    from dipsac import Dipsac
+
+    client = Dipsac(api_key="dps_...")            # or set DIPSAC_API_KEY
+    client.pdf.merge(["a.pdf", "b.pdf"]).save("merged.pdf")
+
+Docs: https://dipsac.com/dashboard/reference
+"""
+from ._client import DEFAULT_BASE_URL, AsyncDipsac, Dipsac
+from ._errors import (
+    APIConnectionError,
+    APIStatusError,
+    APITimeoutError,
+    AuthenticationError,
+    BadRequestError,
+    ConflictError,
+    DipsacError,
+    InternalServerError,
+    JobFailedError,
+    JobTimeoutError,
+    NotFoundError,
+    PayloadTooLargeError,
+    PaymentRequiredError,
+    PermissionDeniedError,
+    RateLimitError,
+    UnprocessableEntityError,
+    UnsupportedMediaTypeError,
+)
+from ._files import FileInput
+from ._models import AsyncJob, DipsacFile, Job
+from ._version import __version__
+
+__all__ = [
+    "Dipsac", "AsyncDipsac", "DipsacFile", "Job", "AsyncJob", "FileInput", "DEFAULT_BASE_URL",
+    "DipsacError", "APIConnectionError", "APITimeoutError", "APIStatusError", "BadRequestError",
+    "AuthenticationError", "PaymentRequiredError", "PermissionDeniedError", "NotFoundError",
+    "ConflictError", "PayloadTooLargeError", "UnsupportedMediaTypeError",
+    "UnprocessableEntityError", "RateLimitError", "InternalServerError", "JobFailedError",
+    "JobTimeoutError", "__version__",
+]