pylibobs 0.0.1__tar.gz

pylibobs-0.0.1/LICENSE

@@ -0,0 +1,338 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Moe Ghoul>, 1 April 1989
+  Moe Ghoul, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

pylibobs-0.0.1/MANIFEST.in

@@ -0,0 +1,19 @@
+# Files to ship in the sdist (in addition to the package itself).
+include LICENSE
+include README.md
+include pyproject.toml
+include setup.py
+include MANIFEST.in
+
+# Maintainer tools — kept in sdist so end-users can rebuild bundled libs
+# if they want to pin a different OBS version.
+recursive-include scripts *.py
+
+# The bundled libobs is intentionally NOT in the sdist — it's downloaded
+# at wheel-build time by CI. Excluded explicitly to keep the sdist small.
+prune pylibobs/_libs
+prune scripts/.fetch_cache
+
+# Test files don't ship in the installed package — they're only in the repo.
+prune tests
+prune examples

pylibobs-0.0.1/PKG-INFO

@@ -0,0 +1,285 @@
+Metadata-Version: 2.4
+Name: pylibobs
+Version: 0.0.1
+Summary: Python bindings for libobs (the core of OBS Studio) — capture, mix, record, stream
+Author: pylibobs contributors
+License: GPL-2.0-or-later
+Project-URL: Homepage, https://github.com/jonata/pylibobs
+Project-URL: Documentation, https://github.com/jonata/pylibobs#readme
+Project-URL: Repository, https://github.com/jonata/pylibobs
+Project-URL: Issues, https://github.com/jonata/pylibobs/issues
+Project-URL: Changelog, https://github.com/jonata/pylibobs/releases
+Keywords: obs,obs-studio,libobs,streaming,recording,rtmp,youtube,twitch,screen-capture,video,audio
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+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 :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Multimedia :: Video :: Capture
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cffi>=1.15
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Requires-Dist: requests>=2.28; extra == "dev"
+Dynamic: license-file
+
+# pylibobs
+
+Python bindings for **libobs** — the core C library of [OBS Studio](https://obsproject.com/).
+
+Lets Python scripts and apps drive libobs directly: initialize OBS, build scenes, configure
+encoders, mix audio, and record / stream — all without OBS Studio's UI running.
+
+> **Status:** beta. The public API is feature-complete and covered by tests. Reference counting
+> semantics match OBS 32's `obs_*_get_ref()` model.
+
+---
+
+## Why?
+
+Existing options:
+
+- **`obspython`** runs *inside* OBS only — you can't `pip install` it or use it from a normal Python app.
+- **`obsws-python` / `simpleobsws`** talk to OBS via WebSocket — requires OBS to be running, and only
+  exposes what the WebSocket API allows.
+
+`pylibobs` links libobs directly (via `cffi`), so **your Python process is the OBS host**.
+
+---
+
+## License
+
+Copyright (C) 2026  Jonata Bolzan Loss and contributors.
+
+pylibobs is licensed under **GPL v2 or later**, inherited from libobs.
+See [LICENSE](LICENSE) for the full text.
+
+The published wheels bundle libobs's compiled binaries (also GPLv2+),
+so the wheel as distributed is covered by GPLv2+. Anything you build
+on top of pylibobs must be GPL-compatible if you redistribute it.
+Personal use carries no obligation.
+
+---
+
+## Installation
+
+```bash
+pip install pylibobs
+```
+
+That's it on Windows / macOS / Linux. The wheel ships with **bundled libobs binaries** (libobs
+plus its plugin DLLs and data files, sourced from the official OBS Studio release on PyPI's
+build server). You don't need to install OBS Studio.
+
+If you're installing from sdist (rare — only when no wheel is published for your platform), or
+you want to use a system-installed OBS, the loader falls back through:
+
+1. `$LIBOBS_PATH` environment variable (explicit override)
+2. Bundled libs inside the wheel — `pylibobs/_libs/<platform>/<arch>/`
+3. `ctypes.util.find_library("obs")`
+4. Well-known OBS Studio install paths
+
+Maintainers / contributors can refresh the bundled libs by running:
+
+```bash
+python scripts/fetch_libs.py                  # current platform
+python scripts/fetch_libs.py --all            # every platform
+python scripts/fetch_libs.py --version 32.1.2 # pin OBS version
+```
+
+This downloads libobs from the official OBS GitHub release. The `_libs/` tree is `.gitignore`d
+and only populated during wheel builds.
+
+---
+
+## Quick start
+
+```python
+import time
+from pylibobs import (
+    OBSContext, OBSData, Source, Scene, Output,
+    VideoEncoder, AudioEncoder,
+)
+
+with OBSContext() as obs:
+    obs.set_video(width=1920, height=1080, fps_num=60)
+    obs.set_audio()
+    obs.load_modules()
+
+    scene = Scene.create("main")
+    cap = Source.create("monitor_capture", "Desktop", {"monitor": 0})
+    scene.add(cap)
+
+    venc = VideoEncoder.create("obs_x264", "video", {"crf": 23, "preset": "veryfast"})
+    aenc = AudioEncoder.create("ffmpeg_aac", "audio", {"bitrate": 192})
+
+    out = Output.create("ffmpeg_muxer", "rec", {"path": "out.mkv"})
+    out.set_video_encoder(venc)
+    out.set_audio_encoder(aenc)
+    out.start()
+
+    time.sleep(10)
+    out.stop()
+```
+
+See `examples/` for full recording and streaming scripts.
+
+### pylibobs-studio (tkinter, stdlib only)
+
+`examples/pylibobs_studio.py` is a complete OBS-style desktop application
+built on nothing but the Python standard library:
+
+```bash
+python examples/pylibobs_studio.py
+```
+
+Features:
+
+| Pane | What it does |
+|---|---|
+| **Live preview** | libobs's D3D11 renderer draws directly into a tkinter `Frame` via its native HWND (`Frame.winfo_id()` → `Display.from_window(hwnd, w, h)`). No Qt, no GTK, no extra deps. |
+| **Scenes** | Add / remove scenes; selecting one routes it to the program output. |
+| **Sources** | Per-scene list; add via a type-picker dialog populated from `enum_input_types()`, with auto-launched monitor/window/file pickers for the source types that need them. Reorder, toggle visibility, remove. |
+| **Audio mixer** | One row per audio-capable source: live VU meter (green / yellow / red), volume slider on an IEC dB curve, mute toggle. Levels come from a `VolumeMeter` queue read on the tk main loop. |
+| **Recording** | Standard MKV recording with live frames / bytes / dropped-frames in the status bar. |
+
+The whole app is ~600 lines in a single file. Use it as a starting point
+for your own pylibobs-based applications.
+
+---
+
+## API overview
+
+| Class            | Wraps              | Notes                                        |
+|------------------|--------------------|----------------------------------------------|
+| `OBSContext`     | `obs_startup` / `obs_shutdown`, video/audio reset | Use as a context manager. |
+| `OBSData`        | `obs_data_t`       | Dict-like; `OBSData({"k": "v"})`             |
+| `Source`         | `obs_source_t`     | `Source.create(kind, name, settings)`        |
+| `Scene` / `SceneItem` | `obs_scene_t` / `obs_sceneitem_t` | Add sources, set visibility, iterate items |
+| `VideoEncoder` / `AudioEncoder` | `obs_encoder_t` | Per-type factory                |
+| `Service`        | `obs_service_t`    | RTMP/streaming targets                       |
+| `Output`         | `obs_output_t`     | File or stream sinks; `start()`/`stop()`     |
+| `Display`        | `obs_display_t`    | Live preview into a native window (HWND)     |
+
+---
+
+## Testing
+
+```bash
+pip install -e ".[dev]"
+
+# Unit tests (mocked cffi layer — fast, no libobs needed)
+pytest tests/unit
+
+# Integration tests (need a real libobs)
+pytest tests/integration -m integration
+
+# On Linux CI with no display:
+Xvfb :99 -screen 0 1920x1080x24 &
+DISPLAY=:99 pytest tests/integration -m integration
+```
+
+CI runs the full matrix on Windows, Linux, and macOS — see `.github/workflows/ci.yml`.
+
+---
+
+## Project layout
+
+```
+pylibobs/
+├── pylibobs/
+│   ├── _lib.py            # Library locator
+│   ├── _ffi.py            # cffi instance
+│   ├── _declarations.py   # C API declarations for cdef()
+│   ├── context.py         # OBSContext
+│   ├── data.py            # OBSData
+│   ├── source.py          # Source
+│   ├── scene.py           # Scene / SceneItem
+│   ├── encoder.py         # VideoEncoder / AudioEncoder
+│   ├── service.py         # Service
+│   ├── output.py          # Output
+│   └── _libs/             # Bundled libobs binaries (after fetch_libs.py)
+├── tests/unit/            # Mocked tests
+├── tests/integration/     # Real libobs tests
+├── scripts/fetch_libs.py  # Pull libobs from OBS releases
+└── examples/              # record_to_file.py, stream_to_rtmp.py
+```
+
+---
+
+## Coverage / known gaps
+
+`pylibobs` currently declares **100% of the public libobs API** (all 1388 exported
+`obs_*` / `gs_*` / `signal_*` / `audio_resampler_*` / `media_remux_*` functions are callable
+via `pylibobs._ffi.get_lib()`). Pythonic class-based wrappers cover the common workflows:
+
+- Lifecycle, video/audio init, scenes, sources, scene items, transforms (pos/scale/rot/crop/bounds)
+- Outputs (file + RTMP streaming), encoders (incl. ROI hints), services
+- Live preview (`Display` attached to a native window via HWND)
+- Filters, transitions, hotkeys, fader + VU meter, audio monitoring
+- Raw audio/video callbacks (numpy-friendly), audio resampler, media remux
+- Properties API (read + edit, with type-aware widgets in `examples/pylibobs_studio.py`)
+- Save / load whole scene collections to JSON
+
+What's intentionally raw-only (callable via `get_lib()` but no class wrapper):
+
+- The 290 `gs_*` graphics primitives — exposing them invites GPU-thread bugs; use
+  `obs_render_main_texture()` instead.
+- Property *builders* (`obs_properties_add_*`) — only useful for C plugin authors.
+- Multi-canvas API (`obs_canvas_*`), `obs_view_*`, codec bitstream parsers
+  (`obs_avc_*` / `obs_av1_*`).
+
+---
+
+## Contributing
+
+```bash
+git clone https://github.com/jonata/pylibobs.git
+cd pylibobs
+python -m venv .venv && source .venv/bin/activate    # Windows: .venv\Scripts\activate
+pip install -e ".[dev]"
+python scripts/fetch_libs.py                          # download bundled libobs
+pytest                                                # 100+ tests, mock + integration
+```
+
+The integration suite needs process isolation (libobs can't gracefully restart inside a
+single process); use the included runner:
+
+```bash
+python scripts/run_tests.py
+```
+
+---
+
+## Release process
+
+1. Bump `version` in `pyproject.toml` and tag the commit `vX.Y.Z`.
+2. Push the tag. GitHub Actions:
+   - Builds platform-specific wheels with bundled libobs (Windows / Linux / macOS Intel + Apple Silicon)
+   - Builds the sdist
+   - Publishes to PyPI via [Trusted Publishing](https://docs.pypi.org/trusted-publishers/) (no token needed in repo secrets)
+   - Attaches all wheels to a GitHub Release with auto-generated notes
+
+To set up Trusted Publishing on PyPI for this repo, register `pylibobs` as a project on PyPI,
+then in *Project settings → Publishing*, add a "GitHub Actions" trusted publisher pointing at
+`<owner>/pylibobs` / workflow `release.yml` / environment `pypi`.
+
+---
+
+Contributions welcome — PRs against `main`.