dybuf 0.1.0__tar.gz

dybuf-0.1.0/LICENSE

@@ -0,0 +1,16 @@
+dybuf, dynamic buffer library
+Copyright (C) 2015-2016 Yuchi (yuchi518@gmail.com)
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License version 2 as
+published by the Free Software Foundation. For the terms of this
+license, see <http://www.gnu.org/licenses>.
+
+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, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

dybuf-0.1.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include LICENSE
+include README.md
+recursive-include include *.h
+recursive-include src/dybuf *.pyx *.pxd *.pxi *.c

dybuf-0.1.0/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: dybuf
+Version: 0.1.0
+Summary: Python bindings for the dybuf dynamic buffer library.
+Author-email: Yuchi <yuchi518@gmail.com>
+Maintainer-email: Yuchi <yuchi518@gmail.com>
+License: dybuf, dynamic buffer library
+        Copyright (C) 2015-2016 Yuchi (yuchi518@gmail.com)
+        
+        This program is free software; you can redistribute it and/or modify
+        it under the terms of the GNU General Public License version 2 as
+        published by the Free Software Foundation. For the terms of this
+        license, see <http://www.gnu.org/licenses>.
+        
+        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, write to the Free Software Foundation, Inc.,
+        51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+Project-URL: Homepage, https://github.com/yuchi518/dybuf
+Project-URL: Issues, https://github.com/yuchi518/dybuf/issues
+Keywords: buffer,binary,cython
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: C
+Classifier: Programming Language :: Cython
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# dybuf python package
+
+Python bindings for the [`dybuf`](../c/dybuf.h) dynamic buffer library implemented in C.  The package exposes the `DyBuf` class implemented in Cython and ships binary wheels across the major desktop platforms.
+
+## Key features
+
+- Thin, fast wrapper around the original `dybuf` implementation.
+- Supports reading and writing unsigned integers (8–64 bits), booleans, and raw byte payloads.
+- Compatible with Windows, Linux, and macOS thanks to compiled extension modules.
+- Designed for publishing on PyPI with automated release workflows.
+
+## Installation
+
+Once released to PyPI the package can be installed with:
+
+```bash
+pip install dybuf
+```
+
+## Quick start
+
+```python
+from dybuf import DyBuf
+
+buf = DyBuf(capacity=64)
+buf.append_uint16(0x1234)
+buf.append_uint32(0xDEADBEEF)
+buf.append_bool(True)
+
+buf.flip()  # prepare for reading
+print(hex(buf.next_uint16()))  # 0x1234
+print(hex(buf.next_uint32()))  # 0xdeadbeef
+print(buf.next_bool())         # True
+```
+
+`write()` and `read()` let you work directly with arbitrary byte payloads, while `position`, `limit`, and `capacity` expose the cursor-style API provided by the original library.
+
+## Developing locally
+
+Create a virtual environment and install the build requirements:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -r requirements-dev.txt  # optional, see below
+```
+
+Build the extension in editable mode for local testing:
+
+```bash
+pip install -e .
+pytest
+```
+
+The project is configured to build wheels via `python -m build`, producing both source and binary distributions:
+
+```bash
+python -m build
+```
+
+Generate the Sphinx documentation locally with:
+
+```bash
+pip install -r requirements-dev.txt  # ensures sphinx/docutils are present
+sphinx-build -b html docs docs/_build/html
+open docs/_build/html/index.html  # or use your preferred viewer
+```
+
+## Automated releases
+
+A GitHub Actions workflow under `.github/workflows/pypi-release.yml` drives [cibuildwheel](https://github.com/pypa/cibuildwheel) to produce Windows, Linux, and macOS artifacts and publish them to PyPI.  Provide a `PYPI_API_TOKEN` secret in your repository and tag releases with a semantic version (e.g. `v0.1.0`) to trigger the pipeline.
+
+## Licensing
+
+The wrapper is distributed under the GNU GPL v2, matching the original dybuf project.

dybuf-0.1.0/README.md

@@ -0,0 +1,75 @@
+# dybuf python package
+
+Python bindings for the [`dybuf`](../c/dybuf.h) dynamic buffer library implemented in C.  The package exposes the `DyBuf` class implemented in Cython and ships binary wheels across the major desktop platforms.
+
+## Key features
+
+- Thin, fast wrapper around the original `dybuf` implementation.
+- Supports reading and writing unsigned integers (8–64 bits), booleans, and raw byte payloads.
+- Compatible with Windows, Linux, and macOS thanks to compiled extension modules.
+- Designed for publishing on PyPI with automated release workflows.
+
+## Installation
+
+Once released to PyPI the package can be installed with:
+
+```bash
+pip install dybuf
+```
+
+## Quick start
+
+```python
+from dybuf import DyBuf
+
+buf = DyBuf(capacity=64)
+buf.append_uint16(0x1234)
+buf.append_uint32(0xDEADBEEF)
+buf.append_bool(True)
+
+buf.flip()  # prepare for reading
+print(hex(buf.next_uint16()))  # 0x1234
+print(hex(buf.next_uint32()))  # 0xdeadbeef
+print(buf.next_bool())         # True
+```
+
+`write()` and `read()` let you work directly with arbitrary byte payloads, while `position`, `limit`, and `capacity` expose the cursor-style API provided by the original library.
+
+## Developing locally
+
+Create a virtual environment and install the build requirements:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -r requirements-dev.txt  # optional, see below
+```
+
+Build the extension in editable mode for local testing:
+
+```bash
+pip install -e .
+pytest
+```
+
+The project is configured to build wheels via `python -m build`, producing both source and binary distributions:
+
+```bash
+python -m build
+```
+
+Generate the Sphinx documentation locally with:
+
+```bash
+pip install -r requirements-dev.txt  # ensures sphinx/docutils are present
+sphinx-build -b html docs docs/_build/html
+open docs/_build/html/index.html  # or use your preferred viewer
+```
+
+## Automated releases
+
+A GitHub Actions workflow under `.github/workflows/pypi-release.yml` drives [cibuildwheel](https://github.com/pypa/cibuildwheel) to produce Windows, Linux, and macOS artifacts and publish them to PyPI.  Provide a `PYPI_API_TOKEN` secret in your repository and tag releases with a semantic version (e.g. `v0.1.0`) to trigger the pipeline.
+
+## Licensing
+
+The wrapper is distributed under the GNU GPL v2, matching the original dybuf project.