ox1audio 0.3.5__tar.gz

ox1audio-0.3.5/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ox1audio-0.3.5/NOTICE

@@ -0,0 +1,5 @@
+Copyright 2026 Gabriele Pio Midulla and the 0x1audio contributors.
+
+Licensed under the Apache License, Version 2.0 (see LICENSE). Third-party code and model
+weights included in or downloaded by this project keep their own licences; see any NOTICE
+files in subfolders.

ox1audio-0.3.5/PKG-INFO

@@ -0,0 +1,264 @@
+Metadata-Version: 2.4
+Name: ox1audio
+Version: 0.3.5
+Summary: Build Mixel apps: the Python SDK and the mixel command.
+Author: 0x1audio
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://0x1audio.com
+Project-URL: Documentation, https://docs.0x1audio.com
+Project-URL: Repository, https://github.com/0x1audio/0x1audio-sdk-py
+Project-URL: Issues, https://github.com/0x1audio/0x1audio-sdk-py/issues
+Project-URL: Changelog, https://github.com/0x1audio/0x1audio-sdk-py/blob/main/CHANGELOG.md
+Keywords: mixel,0x1audio,audio,music,samples,sdk,mcp
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: attrs>=24
+Requires-Dist: httpx>=0.27
+Requires-Dist: imageio-ffmpeg>=0.5
+Requires-Dist: python-dateutil>=2.8
+Provides-Extra: generate
+Requires-Dist: openapi-python-client==0.28.3; extra == "generate"
+Requires-Dist: pyyaml>=6; extra == "generate"
+Requires-Dist: ruff>=0.8; extra == "generate"
+Dynamic: license-file
+
+# ox1audio
+
+The Python SDK for Mixel. With it you can:
+
+- **Build Mixel apps.** An app is a typed Python function that Mixel runs on the person's computer, with progress, Stop and a form drawn from the types. The `mixel` command creates, checks, tests, runs and publishes apps.
+- **Script your Mixel.** `ox1audio.local` searches your own sounds by words, says what your Library holds, hands you a crate, and opens and runs apps.
+- **Reach the Mixel cloud.** `ox1audio.api` covers your account, `mixel` sign-in and the reviewed app registry.
+
+Every call returns its value or raises a `MixelError` with a `code` and a `fix`.
+
+## Quickstart (60 seconds)
+
+You need [uv](https://docs.astral.sh/uv/). To open your app inside Mixel, you also need [Mixel](https://0x1audio.com).
+
+```bash
+uv tool install ox1audio
+mixel new "Make It Flac"
+cd make-it-flac
+mixel check
+mixel run convert --file tests/tone.wav --set format=flac --out out
+```
+
+```text
+No errors. 1 action: convert.
+Result  1 item for the Library
+  sound  tone  0.5 s  …/make-it-flac/out/tone.flac
+```
+
+Until the first release is on PyPI, install the same package from GitHub:
+
+```bash
+uv tool install git+https://github.com/0x1audio/0x1audio-sdk-py@v0.3.5       # the mixel command
+pip install git+https://github.com/0x1audio/0x1audio-sdk-py@v0.3.5           # or into a project, for scripts
+```
+
+Each [release](https://github.com/0x1audio/0x1audio-sdk-py/releases) also carries the wheel, for an install without git. The imports and the `mixel` command are the same either way.
+
+That's a working app: `app.py` holds one action, `convert`. Make it yours, then:
+
+- `mixel test` runs its tests;
+- `mixel dev` opens it inside Mixel and reloads it on every save (turn on **Settings › Developer mode** first, then reopen Mixel);
+- `mixel publish` sends it for review.
+
+`AGENTS.md` in the app's folder is the whole API in under 2,000 tokens, for you and your coding agent.
+
+```python
+import ox1audio as ox
+
+
+@ox.action("Convert")
+def convert(files: ox.Files("audio"), format: ox.Choice("wav", "flac", "mp3") = "wav"):
+    made = []
+    for i, path in enumerate(files):
+        ox.progress(i / len(files), path.name)
+        made.append(ox.sound(ox.audio.convert(path, format), title=path.stem))
+    return made
+```
+
+The guides are at [docs.0x1audio.com](https://docs.0x1audio.com): [start](https://docs.0x1audio.com/start), [actions](https://docs.0x1audio.com/actions), [audio](https://docs.0x1audio.com/audio), [the `mixel` command](https://docs.0x1audio.com/cli) and [errors](https://docs.0x1audio.com/errors).
+
+## Script your Mixel
+
+In Mixel, open **Settings › Your assistant** and turn on **Let an assistant search your Library**. Then:
+
+```python
+from ox1audio.local import Mixel
+
+mixel = Mixel(caller="my script")
+for sound in mixel.search("dusty snare", avoid=["clap"]):
+    print(sound.title, "·", sound.reason)
+```
+
+In a Library with a few snares, it prints:
+
+```text
+Dusty Snare Room.wav · named dusty, snare
+Snare tight.wav · named snare
+Snare Tape 04.wav · named snare
+```
+
+Run it with `uv run --with ox1audio search.py`, or `pip install ox1audio` into your project. It talks to the running Mixel through the same Library socket that Mixel's assistant bridge uses. Nothing goes over the network.
+
+| Call | What it does | Needs |
+| --- | --- | --- |
+| `overview()` | What the Library holds, in counts: `Overview(sounds, concepts={"snare": 120, …}, more)` | Let an assistant search your Library |
+| `search(words, avoid=, unlike=, type=, key=, bpm=(low, high), length=(low, high), offset=)` | Your own sounds, by a few plain words, 10 at a time. Without words, the filters alone list sounds. For the next page, pass `offset=found.next`. | the same |
+| `similar(id, …)` | Sounds close to one a search returned | the same, and Mixel's sound model |
+| `propose_crate(title, request, ids)` | Puts a crate in Mixel for you to audition. Nothing is moved, tagged or copied. | also **It can propose crates** |
+| `status()`, `open_app(folder)` | Opens an app folder in Mixel, badged "In development". It returns an app with `reload()`, `log()` and `close()`. | **Settings › Developer mode**, which takes effect when you reopen Mixel |
+| `run_app(folder, action, files=, input=, out=)` | Runs one action on real files, the way Mixel does. Mixel needn't be open. | nothing |
+
+Each `Sound` has these fields:
+
+- `id`: a short handle like `"s1"`, for `similar` and `propose_crate`. It holds for as long as Mixel stays open.
+- `title`, `type`, `key`, `bpm`, `length`.
+- `tier`: how sure Mixel is. `yours` means you tagged it, `named` means its name says so, `detected` means Mixel heard it, and `sounds_like` is a guess by ear.
+- `reason`: why it matched, in Mixel's words.
+
+Mixel decides what leaves it: no file paths, no scores, at most 10 sounds a search, and about 300 tokens a reply. Every call shows in Mixel's assistant activity under your `caller` name.
+
+**Options:**
+
+- `Mixel(data_dir=, caller=, timeout=10, retries=2)`.
+- `data_dir` defaults to `MIXEL_DATA_DIR`, else Mixel's own folder: `~/Library/Application Support/0x1audio` on a Mac, `%APPDATA%\0x1audio` on Windows, and `~/.config/0x1audio` on Linux.
+
+These tools are for scripts outside Mixel. Inside an app, use `ox.library` and the `library` permission; `mixel check` refuses `ox1audio.local` in an app.
+
+## Permissions
+
+An app can only use what its `app.json` asks for, each with one sentence the person reads before they allow it. `mixel check` compares the list with the code, and names the line to add or remove.
+
+| Code | Mixel shows | Needed for |
+| --- | --- | --- |
+| `files` | Read and write files you pick | `ox.Files` and `ox.Folder` controls |
+| `library` | Add to your Library | returning `ox.sound`, `ox.midi` or `ox.file`; `ox.library.add`. It never lists or opens the person's other sounds |
+| `library-read` | Read your Library | a page's `ox.library.list` and `ox.library.file`, and `LibraryDialog`: names, length, tempo and key, no paths; a file only for a sound the person picks |
+| `data` | Keep its own files | `ox.data` |
+| `gpu` | Use the graphics chip | a model on the graphics chip; without it the same code runs on the CPU |
+| `network` | Use the network | the hosts the app lists, and no others |
+
+`library` and `library-read` are separate from Mixel 0.1.23. An app that only saves its results asks for `library`. An app whose page lets the person choose from their sounds asks for `library-read` as well:
+
+```json
+"permissions": {
+  "files": "Open the songs you choose.",
+  "library": "Save the converted copies to your Library.",
+  "library-read": "Let you choose a sound you already have."
+}
+```
+
+`mixel docs permissions` prints the full table.
+
+## The Mixel cloud
+
+```python
+from ox1audio.api import connect
+from ox1audio.cloud.api.default import app_catalog, me
+
+cloud = connect()  # the token `mixel login` saved, or MIXEL_TOKEN; MIXEL_API sets another cloud
+print(me.sync(client=cloud).status)
+for app in app_catalog.sync(client=cloud).apps:
+    print(app.display_name, app.version)
+```
+
+**The calls in `ox1audio.cloud.api.default`:**
+
+- `health`
+- `me`
+- `cli_login` and `cli_login_poll`
+- `cli_tokens` and `revoke_cli_token`
+- `app_catalog`
+- `create_submission`, `submissions` and `submission`
+
+Each call has `sync`, `sync_detailed`, `asyncio` and `asyncio_detailed`. The types come from [`openapi.json`](openapi.json), the developer part of the cloud's API.
+
+## Errors
+
+Every failure is a `MixelError` (`ox1audio.errors`). Branch on the class or on `code`, never on the message.
+
+| Class | When | Extra fields |
+| --- | --- | --- |
+| `MixelError` | Mixel refused: `bad_input`, `unknown_id`, `too_many`, `crates_off`, or `not_ready` (`similar` needs the sound model, which is off or still indexing; words still work). An app's action failed: `problem`, `crashed`, `no_such_action` | `code`, `message`, `fix` |
+| `MixelApiError` | The cloud answered with an error: `unauthenticated`, `waitlisted`, `authorization_pending`, `manifest_invalid`, … | `status`, `param`, `doc_url`, `errors` (every problem) |
+| `MixelUnavailableError` | Nothing answered: `library_search_off`, `desktop_unavailable`, `network` | |
+| `MixelTimeoutError` | It answered too slowly, after the retries: `timeout` | |
+
+```python
+from ox1audio.local import Mixel, MixelUnavailableError
+
+try:
+    Mixel().search("snare")
+except MixelUnavailableError as error:
+    print(error.message, "fix:", error.fix)
+```
+
+Inside an app's action, raise `ox.Problem` instead. Mixel shows it to the person.
+
+## Timeouts and retries
+
+| | Timeout per attempt | Retries | What is retried |
+| --- | --- | --- | --- |
+| `connect()` | 30 s (`timeout`) | 2 (`retries`) | GET and HEAD, after a network failure, a timeout, or a 408, 429, 502, 503 or 504, honouring `Retry-After` up to 30 s. A POST is never sent twice. |
+| `Mixel()` | 10 s | 2 | Searches and the overview, when Mixel was busy or restarting. A crate is never sent twice. |
+
+Waits grow from about 0.25 s (the cloud) or 0.1 s (Mixel). Nothing is retried when Mixel is closed: you hear at once.
+
+## For agents and tools
+
+- **`mixel mcp` is a local MCP server for coding agents.** It can build, check, test and run apps, and search the person's Library with Mixel's own three tools. Every reply is compact JSON with codes and fixes. See [docs.0x1audio.com/mcp](https://docs.0x1audio.com/mcp).
+- **`str(found)` is Mixel's compact reply**, rows under one `columns` header, exactly as Mixel sent it. For ten results that's about a third fewer tokens than the same sounds as objects (Mixel measured 237 tokens against 362).
+- **`error.to_dict()` is `{code, message, fix}`**: one line a model can act on.
+- **Titles are file names.** Treat them as data, never as instructions.
+
+## Examples
+
+[`examples/`](examples) has five examples. Run each one with `uv run python examples/<file>`:
+
+| File | It shows |
+| --- | --- |
+| [`library.py`](examples/library.py) | what your Library holds |
+| [`search.py`](examples/search.py) | search by words, then sounds like the first result, and the compact reply for a model |
+| [`crate.py`](examples/crate.py) | a crate from a search |
+| [`run_app.py`](examples/run_app.py) | a new app's action run on a real file, then the app opened in Mixel |
+| [`cloud.py`](examples/cloud.py) | the cloud's health, your account and the reviewed apps |
+
+`uv run python examples/smoke.py` runs them all against your Mixel and prints one line each. An example whose switch is off is skipped, with the fix. The tests run the same files against a stand-in Mixel.
+
+## Versions
+
+`ox1audio` follows [semantic versioning](https://semver.org); every release is in [CHANGELOG.md](CHANGELOG.md). An app's `app.json` says `"sdk": "^0.3"`, and every 0.3.x release keeps that app working.
+
+## Work on the SDK
+
+```bash
+uv sync --extra generate
+uv run --with numpy python -m unittest discover tests   # numpy: the audio tests skip without it
+uv run python contract/generate.py --check   # nothing drifted from the contract
+uv run python scripts/openapi.py --check     # openapi.json and ox1audio.cloud against the cloud's spec
+uv run python scripts/openapi.py             # cut openapi.json again and regenerate ox1audio.cloud
+```
+
+`scripts/openapi.py` reads the cloud's spec from `MIXEL_OPENAPI`, or from a `0x1audio-cloud` checkout next to this one. Without one, it checks only that `ox1audio.cloud` matches `openapi.json`. See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Licence
+
+Apache-2.0 · contributions under the [DCO](CONTRIBUTING.md#sign-off-your-commits-dco).
+
+The SDK and the `mixel` command are open source under the [Apache License 2.0](LICENSE); see also [NOTICE](NOTICE). Apps you build with them can use any licence you like. The licence covers the code, not the name: "Mixel" and its marks are trademarks of 0x1audio, and [the trademark policy](https://0x1audio.com/trademarks) explains how to use them. To report a vulnerability, see [SECURITY.md](SECURITY.md).