pyObscuraProto 1.0__tar.gz

pyobscuraproto-1.0/.github/workflows/autotests.yml

@@ -0,0 +1,74 @@
+name: Auto Tests
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+      - 'hotfix/*'
+      - 'release/*'
+  pull_request:
+    branches:
+      - main
+      - develop
+      - 'release/*'
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.14'
+        cache: 'pip'
+        cache-dependency-path: |
+          dev-requirements.txt
+          setup.py
+
+    - name: Install ccache
+      run: sudo apt-get install -y ccache
+
+    - name: Cache ccache
+      uses: actions/cache@v4
+      with:
+        path: ~/.ccache
+        key: ${{ runner.os }}-ccache-${{ hashFiles('CMakeLists.txt', 'src/ObscuraProto/bindings.cpp') }}
+        restore-keys: |
+          ${{ runner.os }}-ccache-
+
+    - name: Install build dependencies (CMake, etc.)
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y cmake
+
+    - name: Install Python dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r dev-requirements.txt
+
+    - name: Lint with Ruff
+      run: |
+        ruff check src/ tests/ examples/
+
+    - name: Check formatting with Ruff
+      run: |
+        ruff format --check src/ tests/ examples/
+
+    - name: Build and install project
+      env:
+        CMAKE_ARGS: "-DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache"
+      run: |
+        pip install -e .
+
+    - name: Type-check with Pyright
+      run: |
+        pyright src/ tests/ examples/
+
+    - name: Run tests
+      run: |
+        pytest

pyobscuraproto-1.0/.github/workflows/pypi_publish.yml

@@ -0,0 +1,174 @@
+name: Python Package
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build_wheels:
+    name: Build wheels (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-26-intel
+          - macos-latest
+          - windows-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.14'
+          cache: 'pip'
+      - name: Install cibuildwheel
+        run: pip install 'cibuildwheel>=2.16,<3'
+        env:
+          PIP_REQUIRE_VIRTUALENV: false
+      - name: Build wheels
+        run: python -m cibuildwheel --output-dir wheelhouse
+        env:
+          CIBW_BUILD_VERBOSITY: 2
+          CIBW_REPAIR_WHEEL_COMMAND_MACOS: |
+            set -e
+            echo "=== Wheel libraries ==="
+            unzip -l {wheel} | grep '\.dylib\|\.so'
+            echo "=== delocate-listdeps ==="
+            delocate-listdeps {wheel}
+            echo "=== delocate-wheel ==="
+            delocate-wheel --require-archs {delocate_archs} -w {dest_dir} -v {wheel}
+          CIBW_ENVIRONMENT_MACOS: MACOSX_DEPLOYMENT_TARGET=26
+          CIBW_ENVIRONMENT_WINDOWS: |
+            CMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake
+          CIBW_BEFORE_BUILD_MACOS: pip install --upgrade delocate
+          CIBW_BEFORE_BUILD_WINDOWS: |
+            echo "=== CMake version ==="
+            cmake --version
+            echo "=== Generator platform ==="
+            echo CMAKE_GENERATOR_PLATFORM=%CMAKE_GENERATOR_PLATFORM%
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-${{ matrix.os }}
+          path: ./wheelhouse/*.whl
+
+  build_linux_aarch64:
+    name: Build wheels (linux-aarch64)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.14'
+          cache: 'pip'
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Install cibuildwheel
+        run: pip install 'cibuildwheel>=2.16,<3'
+        env:
+          PIP_REQUIRE_VIRTUALENV: false
+      - name: Build aarch64 wheels
+        run: python -m cibuildwheel --output-dir wheelhouse
+        env:
+          CIBW_ARCHS_LINUX: aarch64
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-linux-aarch64
+          path: ./wheelhouse/*.whl
+
+  build_windows_arm64:
+    name: Build wheels (windows-arm64)
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.14'
+          cache: 'pip'
+      - name: Set up MSVC ARM64 toolchain
+        uses: ilammy/msvc-dev-cmd@v1
+        with:
+          arch: x64_arm64
+      - name: Install cibuildwheel
+        run: pip install 'cibuildwheel>=2.16,<3'
+      - name: Build ARM64 wheels
+        run: python -m cibuildwheel --output-dir wheelhouse
+        env:
+          CIBW_BUILD_VERBOSITY: 2
+          CIBW_ARCHS_WINDOWS: ARM64
+          CIBW_ENVIRONMENT_WINDOWS: |
+            CMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake
+            VCPKG_TARGET_TRIPLET=arm64-windows
+          CIBW_BEFORE_BUILD_WINDOWS: |
+            echo "=== CMake version ==="
+            cmake --version
+            echo "=== Environment ==="
+            set | findstr "CMAKE"
+            echo "=== Generator platform ==="
+            echo CMAKE_GENERATOR_PLATFORM=%CMAKE_GENERATOR_PLATFORM%
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-windows-arm64
+          path: ./wheelhouse/*.whl
+
+  build_sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.14'
+          cache: 'pip'
+      - name: Build sdist
+        run: |
+          pip install build
+          SETUPTOOLS_SCM_PRETEND_VERSION="${GITHUB_REF_NAME#v}" python -m build --sdist
+        env:
+          PIP_REQUIRE_VIRTUALENV: false
+      - uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+
+  publish:
+    name: Release & Publish to PyPI
+    environment:
+      name: pypi
+      url: https://pypi.org/project/pyObscuraProto/
+    permissions:
+      id-token: write
+      contents: write
+    needs:
+      - build_wheels
+      - build_linux_aarch64
+      - build_windows_arm64
+      - build_sdist
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: wheels-*
+          merge-multiple: true
+          path: dist
+      - uses: actions/download-artifact@v4
+        with:
+          name: sdist
+          path: dist
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: Release ${{ github.ref_name }}
+          body_path: CHANGELOG.md
+          files: dist/*
+          draft: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pyobscuraproto-1.0/.gitignore

@@ -0,0 +1,210 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Other
+server_public_key.pem

pyobscuraproto-1.0/.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.0
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+
+  - repo: https://github.com/RobertCraigie/pyright-python
+    rev: v1.1.398
+    hooks:
+      - id: pyright

pyobscuraproto-1.0/CHANGELOG.md

@@ -0,0 +1,6 @@
+### 1.0: Initial Release - C++ Library Wrapper
+- Implemented Python bindings for the core C++ library.
+- Exposed key C++ functionalities to Python, enabling seamless integration.
+- Provided initial set of features, including websocket connection and handler declaration via decorators.
+- Streaming
+- Authorization

pyobscuraproto-1.0/CMakeLists.txt

@@ -0,0 +1,29 @@
+cmake_minimum_required(VERSION 3.14)
+project(ObscuraProto LANGUAGES CXX)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+
+set(BUILD_TESTING OFF CACHE BOOL "" FORCE)
+
+include(FetchContent)
+
+FetchContent_Declare(
+    pybind11
+    GIT_REPOSITORY https://github.com/pybind/pybind11.git
+    GIT_TAG        v2.11.1
+)
+FetchContent_MakeAvailable(pybind11)
+
+FetchContent_Declare(
+    ObscuraProto
+    GIT_REPOSITORY https://github.com/ObscuraEcosystem/ObscuraProto.git
+    GIT_TAG        v1.0.1
+)
+FetchContent_MakeAvailable(ObscuraProto)
+
+target_compile_definitions(obscuraproto INTERFACE _WEBSOCKETPP_CPP11_STL_)
+
+pybind11_add_module(_obscuraproto src/ObscuraProto/bindings.cpp)
+target_link_libraries(_obscuraproto PRIVATE obscuraproto)

pyobscuraproto-1.0/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing to pyObscuraProto
+
+## System Dependencies
+
+- **CMake** (≥ 3.14) — build system
+
+### macOS
+```bash
+brew install cmake
+```
+
+### Linux (Debian/Ubuntu)
+```bash
+sudo apt-get update
+sudo apt-get install -y cmake
+```
+
+## Development Setup
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/ObscuraEcosystem/pyObscuraProto.git
+   cd pyObscuraProto
+   ```
+
+2. Create and activate a virtual environment:
+   ```bash
+   python3 -m venv .venv
+   source .venv/bin/activate
+   ```
+
+3. Install development dependencies:
+   ```bash
+   pip install -r dev-requirements.txt
+   ```
+
+4. Install pre-commit hooks:
+   ```bash
+   pre-commit install
+   ```
+
+5. Build the project:
+   ```bash
+   pip install -e .
+   ```
+
+## Code Quality Tools
+
+### Ruff (linter & formatter)
+
+Lint check:
+```bash
+ruff check src/ tests/ examples/
+```
+
+Auto-fix lint issues:
+```bash
+ruff check --fix src/ tests/ examples/
+```
+
+Format check:
+```bash
+ruff format --check src/ tests/ examples/
+```
+
+Format code:
+```bash
+ruff format src/ tests/ examples/
+```
+
+### Pyright (type checker)
+
+```bash
+pyright src/ tests/ examples/
+```
+
+## Pre-commit Hooks
+
+Pre-commit hooks run automatically on `git commit` and include:
+
+1. **ruff** — lints and auto-fixes fixable issues
+2. **ruff-format** — ensures code is properly formatted
+3. **pyright** — checks for type errors
+
+To run all hooks manually without committing:
+```bash
+pre-commit run --all-files
+```
+
+To bypass hooks temporarily (not recommended):
+```bash
+git commit --no-verify
+```
+
+## CI Pipeline
+
+Every push and pull request triggers GitHub Actions which runs:
+
+1. `ruff check` — lint validation
+2. `ruff format --check` — formatting validation
+3. Build the C++ extension and install the package
+4. `pyright` — type checking
+5. `pytest` — test suite
+
+## Code Style Guidelines
+
+- **Line length**: 120 characters
+- **Naming**: Follow PEP 8 conventions
+- **Imports**: Sorted automatically by Ruff (I rule)
+- **Type hints**: Use type annotations for all function signatures
+- **Docstrings**: Use Google-style docstrings (auto-formatted by Ruff)
+
+## Testing
+
+Run tests:
+```bash
+pytest
+```
+
+## Pull Request Process
+
+1. Ensure all pre-commit hooks pass
+2. Ensure CI passes on your branch
+3. Update documentation if needed
+4. Request review from maintainers

pyobscuraproto-1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Kretov Artem
+
+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.

pyobscuraproto-1.0/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.4
+Name: pyObscuraProto
+Version: 1.0
+Summary: A Python wrapper for ObscuraProto
+Author: Kretov Artem
+Author-email: 20kretovartem000@gmail.com
+Requires-Python: >=3.13
+License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: license-file
+Dynamic: requires-python
+Dynamic: summary
+
+A Python wrapper for ObscuraProto, providing high-level WebSocket server and client functionalities.