feat: initial commit

Author: taishi-n

.github/workflows/release.yml

@@ -0,0 +1,18 @@
+name: release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  pypi:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uv build
+      - run: uv publish

.gitignore

@@ -0,0 +1,18 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+.pytest_cache/
+
+# Build artifacts
+dist/
+build/
+site/
+docs/_build/
+
+# Outputs and local assets
+outputs/
+
+# macOS
+**/.DS_Store

.readthedocs.yml

@@ -0,0 +1,17 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+    - requirements: docs/requirements.txt
+
+mkdocs:
+  configuration: mkdocs.yml

AGENTS.md

@@ -0,0 +1,46 @@
+# Repository Guidelines
+
+## Project Structure & Module Organization
+- Source code: `src/oobss/` with namespaces:
+  - `oobss.separators` (algorithms), `oobss.audio` (I/O, STFT), `oobss.configs`, `oobss.logging_utils`.
+- CLI entrypoint: `oobss` (defined in `pyproject.toml`).
+- Documentation: `docs/` (Material for MkDocs + mkdocstrings).
+- Examples: `examples/` (separation, evaluation, benchmarks, block spectrogram).
+- Tests: `tests/`.
+
+## Build, Test, and Development Commands
+- `uv sync` — create/update the virtual environment.
+- `uv run pytest` — run the test suite.
+- `uv run mkdocs build` — build docs locally.
+- `uv run ruff format .` — auto-format code.
+- `uv run ty check` — type check.
+- Releases: `uv build` / `uv publish` (must still support `pip install torchrir`).
+- `uv.lock` is committed; update it **only** when `pyproject.toml` changes.
+
+## Coding Style & Naming Conventions
+- Python: follow Ruff defaults and `ty` type checker; prefer explicit imports and small modules.
+- Naming: snake_case for functions/variables, PascalCase for classes. Public API lives under the `oobss` package.
+- Keep docstrings concise; use English for all docs and comments.
+
+## Testing Guidelines
+- Framework: `pytest`.
+- Run: `uv run pytest`.
+- Aim to cover separator interfaces (`OnlineSeparator.process_stream`), streaming utilities, and examples where feasible.
+- Keep fixtures small; prefer synthetic data over large assets.
+
+## Commit & Pull Request Guidelines
+- Codex proposes commit message drafts; the user reviews/approves before committing.
+- All commits must follow Conventional Commits via Commitizen (`uv run cz commit`).
+- Before PR: run format (`uv run ruff format .`), type check (`uv run ty check`), tests, and (if docs touched) `uv run mkdocs build`.
+- PRs should include a concise summary, linked issues/design notes, and example outputs/benchmarks when performance-critical code changes.
+
+## Versioning & Releases
+- Use Commitizen for version bumps, tagging, and changelog updates.
+  - Run: `uv run cz bump --changelog --yes`
+  - Version source: `pyproject.toml` (PEP 621); tag format `vX.Y.Z`.
+- After bumping, push commits and tags: `git push origin main --tags`.
+- Signed tags are manual by the user, e.g., `git tag -s vX.Y.Z -m "vX.Y.Z"`.
+
+## Security & Configuration Tips
+- Secrets/credentials should never be committed; use environment variables for local tests.
+- Optional deps (torch, torchaudio, torchrir, sounddevice) are not pinned; document which extras are required for your feature.

CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.

LICENSE

@@ -0,0 +1,233 @@
+oobss Custom Non-Commercial License
+(Apache License 2.0 with Additional Restrictions)
+
+Copyright (c) 2026 oobss contributors
+
+This license is based on the Apache License, Version 2.0 (the "Apache 2.0 License").
+The Apache 2.0 License text appears below and is incorporated by reference.
+
+Additional Restrictions (override Apache 2.0 where applicable)
+----------------------------------------------------------------
+
+You may use, copy, modify, and distribute this software only under the
+conditions below. If there is any conflict between the Apache 2.0 License and
+these Additional Restrictions, these Additional Restrictions control.
+
+1) Non-Commercial Use Only
+   You may not use this software, in whole or in part, for Commercial Purposes.
+
+   "Commercial Purposes" means any use intended for or directed toward
+   commercial advantage or monetary compensation, including but not limited to:
+   - selling software or services that include this software,
+   - using this software in paid products, SaaS, or consulting deliverables,
+   - internal business operations that generate revenue or reduce commercial
+     operating costs as part of a commercial activity.
+
+2) Required Attribution for Any Use
+   Any redistribution, publication, deployment, service, product, or research
+   artifact that uses this software (including modified versions or derivative
+   works) must include a clear and visible attribution notice.
+
+   The attribution must include at least:
+   - the project name: "oobss"
+   - the copyright holder/contributors
+   - a reference to this license file
+
+   Example attribution:
+   "This product uses oobss (Copyright (c) 2026 oobss contributors), licensed
+   under the oobss Custom Non-Commercial License (Apache 2.0 with Additional
+   Restrictions)."
+
+3) Downstream Notice and Pass-Through
+   If you distribute this software or derivative works, you must:
+   - keep all copyright, license, and attribution notices,
+   - provide a copy of this license,
+   - require downstream recipients to comply with the same terms.
+
+4) No Trademark License
+   This license does not grant permission to use any project or contributor
+   names, marks, or logos except as necessary for the required attribution.
+
+5) Reservation of Rights
+   All rights not expressly granted are reserved.
+
+---------------------------------------------------------------------------
+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 and the Additional Restrictions
+above.
+
+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