sharedbox 0.1.0__tar.gz → 0.2.4__tar.gz

sharedbox-0.2.4/.github/workflows/ci.yaml

@@ -0,0 +1,119 @@
+name: CI
+
+on: 
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  release:
+    types: [ published ]
+
+jobs:
+  build_wheels:
+    name: Build wheel for ${{ matrix.python }}-${{ matrix.platform_id }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # Windows
+          - os: windows-latest
+            python: cp310
+            platform_id: win_amd64
+          - os: windows-latest
+            python: cp311
+            platform_id: win_amd64
+          - os: windows-latest
+            python: cp312
+            platform_id: win_amd64
+          - os: windows-latest
+            python: cp313
+            platform_id: win_amd64
+          
+          # Linux x86_64
+          - os: ubuntu-latest
+            python: cp310
+            platform_id: manylinux_x86_64
+          - os: ubuntu-latest
+            python: cp311
+            platform_id: manylinux_x86_64
+          - os: ubuntu-latest
+            python: cp312
+            platform_id: manylinux_x86_64
+          - os: ubuntu-latest
+            python: cp313
+            platform_id: manylinux_x86_64
+          
+          # Linux musllinux x86_64
+          - os: ubuntu-latest
+            python: cp310
+            platform_id: musllinux_x86_64
+          - os: ubuntu-latest
+            python: cp311
+            platform_id: musllinux_x86_64
+          - os: ubuntu-latest
+            python: cp312
+            platform_id: musllinux_x86_64
+          - os: ubuntu-latest
+            python: cp313
+            platform_id: musllinux_x86_64
+
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event_name == 'release' && github.event.release.tag_name || '' }}
+      
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v3.2.0
+        env:
+          CIBW_BUILD: ${{ matrix.python }}-${{ matrix.platform_id }}
+          CIBW_CONTAINER_ENGINE: "docker; create_args: --shm-size=1g"
+          CIBW_TEST_REQUIRES: pytest numpy
+          CIBW_TEST_COMMAND: pytest {project}/tests
+        with:
+          package-dir: .
+          output-dir: wheelhouse
+
+      - name: Upload wheel artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: cibw-wheels-${{ matrix.python }}-${{ matrix.platform_id }}
+          path: ./wheelhouse/*.whl
+
+  make_sdist:
+    name: Make SDist
+    runs-on: ubuntu-latest
+    needs: [build_wheels]
+    if: github.event_name == 'release' && github.event.action == 'published'
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event_name == 'release' && github.event.release.tag_name || '' }}
+
+      - name: Build SDist
+        run: pipx run build --sdist
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: cibw-sdist
+          path: dist/*.tar.gz
+
+  upload_pypi:
+    name: Upload to PyPI
+    needs: [build_wheels, make_sdist]
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    if: github.event_name == 'release' && github.event.action == 'published'
+    steps:
+      - uses: actions/download-artifact@v5
+        with:
+          # unpacks all CIBW artifacts into dist/
+          pattern: cibw-*
+          path: dist
+          merge-multiple: true
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

{sharedbox-0.1.0 → sharedbox-0.2.4}/.gitignore

@@ -16,4 +16,6 @@ wheels/
 
 src/sharedbox/_version.py
 
-wheelhouse/
+wheelhouse/
+
+.nox/

sharedbox-0.2.4/CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+Dates are marked as `DD-MM-YYYY`
+
+## [0.2.2] - 05-10-2025
+
+### Fixed
+
+- Fix CI (again)
+
+## [0.2.1] - 05-10-2025 (YANKED)
+
+### Fixed
+
+- Fix CI bug that was not uploading all wheels
+
+## [0.2.0] - 05-10-2025 (YANKED)
+
+### Changed
+
+- Rewrite codebase in nanobind
+
+## [0.1.0] - 29-09-2025
+
+### Added
+
+- Initial release
+
+[0.2.2]: (https://github.com/jacopoabramo/sharedbox/compare/0.2.1...0.2.2)
+[0.2.1]: (https://github.com/jacopoabramo/sharedbox/compare/0.2.0...0.2.1)
+[0.2.0]: (https://github.com/jacopoabramo/sharedbox/compare/0.1.0...0.2.0)
+[0.1.0]: (https://github.com/jacopoabramo/sharedbox/commits/0.1.0)

sharedbox-0.2.4/CMakeLists.txt

@@ -0,0 +1,102 @@
+cmake_minimum_required(VERSION 3.15)
+
+# Set vcpkg toolchain from VCPKG_ROOT environment variable
+if(DEFINED ENV{VCPKG_ROOT})
+    set(CMAKE_TOOLCHAIN_FILE "$ENV{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake"
+        CACHE STRING "Vcpkg toolchain file")
+    message(STATUS "Using vcpkg toolchain from VCPKG_ROOT: ${CMAKE_TOOLCHAIN_FILE}")
+else()
+    message(FATAL_ERROR "VCPKG_ROOT environment variable is not set. Please install vcpkg and set VCPKG_ROOT to the vcpkg installation directory.")
+endif()
+
+project(${SKBUILD_PROJECT_NAME} LANGUAGES CXX C)
+
+# Set C++ standard
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+if (CMAKE_VERSION VERSION_LESS 3.18)
+  set(DEV_MODULE Development)
+else()
+  set(DEV_MODULE Development.Module)
+endif()
+
+set(Python_ROOT_DIR "${CMAKE_SOURCE_DIR}/.venv")
+find_package(Python 3.10 COMPONENTS Interpreter ${DEV_MODULE} REQUIRED)
+
+message(STATUS "Using Python interpreter: ${Python_EXECUTABLE}")
+
+if (NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
+  set(CMAKE_BUILD_TYPE Release CACHE STRING "Choose the type of build." FORCE)
+  set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
+endif()
+
+execute_process(
+  COMMAND "${Python_EXECUTABLE}" -m nanobind --cmake_dir
+  OUTPUT_STRIP_TRAILING_WHITESPACE OUTPUT_VARIABLE nanobind_ROOT
+)
+find_package(nanobind CONFIG REQUIRED)
+
+find_package(Boost REQUIRED CONFIG)
+
+message(STATUS "Found Boost version: ${Boost_VERSION}")
+
+# Platform-specific compiler settings
+if(WIN32)
+    set(PLATFORM_COMPILE_DEFS
+        BOOST_ALL_NO_LIB
+        _WIN32_WINNT=0x0601
+        WIN32_LEAN_AND_MEAN
+        NOMINMAX
+    )
+    set(PLATFORM_COMPILE_ARGS /EHsc /O2)
+    set(PLATFORM_LIBRARIES kernel32 user32 advapi32)
+else()
+    set(PLATFORM_COMPILE_DEFS
+        BOOST_ALL_NO_LIB
+        _GNU_SOURCE
+    )
+    set(PLATFORM_COMPILE_ARGS -O3)
+    set(PLATFORM_LIBRARIES rt pthread)
+endif()
+
+# Create the _shareddict extension using nanobind
+nanobind_add_module(_shareddict
+    NB_STATIC  # Link nanobind statically
+    src/sharedbox/shareddict.cpp
+    src/sharedbox/_core/sharedmemory.cpp
+)
+
+target_include_directories(_shareddict PRIVATE 
+    src/sharedbox
+    src/sharedbox/_core
+)
+
+target_compile_definitions(_shareddict PRIVATE ${PLATFORM_COMPILE_DEFS})
+target_compile_options(_shareddict PRIVATE ${PLATFORM_COMPILE_ARGS})
+
+# Link Boost (header-only, no library needed for interprocess/container) and platform libraries
+target_link_libraries(_shareddict PRIVATE 
+    Boost::headers  # Boost header-only libraries
+    ${PLATFORM_LIBRARIES}
+)
+
+# Generate stub file for the _shareddict module in the source folder
+nanobind_add_stub(
+    _shareddict_stub
+    MODULE _shareddict
+    OUTPUT ${CMAKE_CURRENT_SOURCE_DIR}/src/sharedbox/_shareddict.pyi
+    PYTHON_PATH $<TARGET_FILE_DIR:_shareddict>
+    DEPENDS _shareddict
+    MARKER_FILE ${CMAKE_CURRENT_SOURCE_DIR}/src/sharedbox/py.typed
+)
+
+# Install the extension to the sharedbox package
+install(TARGETS _shareddict LIBRARY DESTINATION sharedbox)
+
+# Install stub file and marker file from source folder
+install(FILES 
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/sharedbox/_shareddict.pyi
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/sharedbox/py.typed
+    DESTINATION sharedbox
+)

{sharedbox-0.1.0 → sharedbox-0.2.4}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: sharedbox
-Version: 0.1.0
+Version: 0.2.4
 Summary: Python containers using shared memory.
-Author-email: Jacopo Abramo <jacopo.abramo@gmail.com>
+Author-Email: Jacopo Abramo <jacopo.abramo@gmail.com>
 License-Expression: Apache-2.0
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -14,19 +14,13 @@ Classifier: Programming Language :: C++
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: numpy>=2.2.6
-Provides-Extra: dev
-Requires-Dist: pytest>=8.4.2; extra == "dev"
-Requires-Dist: ruff>=0.13.1; extra == "dev"
-Dynamic: license-file
 
 # `sharedbox`
 
 > [!WARNING]
 > This project is a work in progress; be patient or feel free to contribute.
 
-Python inter-process shared containers leveraging `boost::interprocess`.
+Python inter-process shared containers leveraging the [`boost::interprocess`](https://www.boost.org/doc/libs/latest/doc/html/interprocess.html) library.
 
 ## Installation
 
@@ -110,42 +104,66 @@ shared_config.unlink()
 The `examples/` folder contains some code examples on how to use the package.
 
 ## Building locally
+
 ### Requirements
 
 - [`git`](https://git-scm.com/downloads)
 - [`uv`](https://docs.astral.sh/uv/getting-started/installation/)
 - Python >= 3.10
 - [`vcpkg`](https://vcpkg.io/en/)
-- `cython>=3.1`
-- A C++17 compatible compiler
+- [`CMake`](https://cmake.org/download/) >= 3.15
+- A C++17 compatible compiler (MSVC on Windows, GCC on Linux)
 
-First [install and boostrap vcpkg](https://learn.microsoft.com/en-us/vcpkg/get_started/get-started-vscode?pivots=shell-cmd) somewhere in your system.
+> [!NOTE]
+> The build system automatically detects `vcpkg` and installed libraries through the `VCPKG_ROOT` environment variable.
+> Make sure it's set before building.
 
-```sh
-# for Windows it is reccomended to install it in C:\
-cd C:\
+### Install and configure vcpkg
 
-git clone https://github.com/microsoft/vcpkg.git
-cd vcpkg && bootstrap-vcpkg.bat
-```
+First, [install and bootstrap vcpkg](https://learn.microsoft.com/en-us/vcpkg/get_started/get-started?pivots=shell-cmd) somewhere in your system.
 
-Don't forget to add it to your `PATH`.
+#### Windows
+```cmd
+# It is recommended to install in C:\
+cd C:\
+git clone https://github.com/microsoft/vcpkg.git
+cd vcpkg
+bootstrap-vcpkg.bat
 
-Also, add an environment variable pointing to the root of `vcpkg`:
+# Set the VCPKG_ROOT environment variable (permanently)
+setx VCPKG_ROOT "C:\vcpkg"
 
-```sh
-set "VCPKG_ROOT=C:\path\to\vcpkg"
+# Add vcpkg to your PATH (permanently)
+setx PATH "%PATH%;C:\vcpkg"
 ```
 
-Clone this repository, then install `boost::interprocess`:
+#### Linux
+You can use the `install-vcpkg.sh` script which will
+automatically install `vcpkg` in the `/opt` folder
+and set the `VCPKG_ROOT` environment variable.
+The script must be run with super user priviledges:
 
+```bash
+sudo bash install-vcpkg.sh
 ```
+
+### Install `boost-interprocess`
+
+```bash
+# From anywhere (vcpkg should be in PATH)
 vcpkg install boost-interprocess
 ```
 
-Finally, through `uv`, install the package in a virtual environment:
+### Build the package
 
-```sh
+Clone this repository and install using `uv`:
+
+```bash
+# Clone the repository
+git clone https://github.com/jacopoabramo/sharedbox.git
+cd sharedbox
+
+# Create virtual environment and install in development mode
 uv venv --python 3.10
 uv pip install -e .[dev]
 ```
@@ -153,3 +171,5 @@ uv pip install -e .[dev]
 ## License
 
 Licensed under [Apache 2.0](./LICENSE)
+
+`sharedbox` is built using the Boost C++ library, which is licensed under the [Boost Software License](https://boost.org.cpp.al/LICENSE_1_0.txt).

sharedbox-0.1.0/src/sharedbox.egg-info/PKG-INFO → sharedbox-0.2.4/README.md

@@ -1,32 +1,9 @@
-Metadata-Version: 2.4
-Name: sharedbox
-Version: 0.1.0
-Summary: Python containers using shared memory.
-Author-email: Jacopo Abramo <jacopo.abramo@gmail.com>
-License-Expression: Apache-2.0
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-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: Programming Language :: C++
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: numpy>=2.2.6
-Provides-Extra: dev
-Requires-Dist: pytest>=8.4.2; extra == "dev"
-Requires-Dist: ruff>=0.13.1; extra == "dev"
-Dynamic: license-file
-
 # `sharedbox`
 
 > [!WARNING]
 > This project is a work in progress; be patient or feel free to contribute.
 
-Python inter-process shared containers leveraging `boost::interprocess`.
+Python inter-process shared containers leveraging the [`boost::interprocess`](https://www.boost.org/doc/libs/latest/doc/html/interprocess.html) library.
 
 ## Installation
 
@@ -110,42 +87,66 @@ shared_config.unlink()
 The `examples/` folder contains some code examples on how to use the package.
 
 ## Building locally
+
 ### Requirements
 
 - [`git`](https://git-scm.com/downloads)
 - [`uv`](https://docs.astral.sh/uv/getting-started/installation/)
 - Python >= 3.10
 - [`vcpkg`](https://vcpkg.io/en/)
-- `cython>=3.1`
-- A C++17 compatible compiler
+- [`CMake`](https://cmake.org/download/) >= 3.15
+- A C++17 compatible compiler (MSVC on Windows, GCC on Linux)
 
-First [install and boostrap vcpkg](https://learn.microsoft.com/en-us/vcpkg/get_started/get-started-vscode?pivots=shell-cmd) somewhere in your system.
+> [!NOTE]
+> The build system automatically detects `vcpkg` and installed libraries through the `VCPKG_ROOT` environment variable.
+> Make sure it's set before building.
 
-```sh
-# for Windows it is reccomended to install it in C:\
-cd C:\
+### Install and configure vcpkg
 
-git clone https://github.com/microsoft/vcpkg.git
-cd vcpkg && bootstrap-vcpkg.bat
-```
+First, [install and bootstrap vcpkg](https://learn.microsoft.com/en-us/vcpkg/get_started/get-started?pivots=shell-cmd) somewhere in your system.
 
-Don't forget to add it to your `PATH`.
+#### Windows
+```cmd
+# It is recommended to install in C:\
+cd C:\
+git clone https://github.com/microsoft/vcpkg.git
+cd vcpkg
+bootstrap-vcpkg.bat
 
-Also, add an environment variable pointing to the root of `vcpkg`:
+# Set the VCPKG_ROOT environment variable (permanently)
+setx VCPKG_ROOT "C:\vcpkg"
 
-```sh
-set "VCPKG_ROOT=C:\path\to\vcpkg"
+# Add vcpkg to your PATH (permanently)
+setx PATH "%PATH%;C:\vcpkg"
 ```
 
-Clone this repository, then install `boost::interprocess`:
+#### Linux
+You can use the `install-vcpkg.sh` script which will
+automatically install `vcpkg` in the `/opt` folder
+and set the `VCPKG_ROOT` environment variable.
+The script must be run with super user priviledges:
 
+```bash
+sudo bash install-vcpkg.sh
 ```
+
+### Install `boost-interprocess`
+
+```bash
+# From anywhere (vcpkg should be in PATH)
 vcpkg install boost-interprocess
 ```
 
-Finally, through `uv`, install the package in a virtual environment:
+### Build the package
 
-```sh
+Clone this repository and install using `uv`:
+
+```bash
+# Clone the repository
+git clone https://github.com/jacopoabramo/sharedbox.git
+cd sharedbox
+
+# Create virtual environment and install in development mode
 uv venv --python 3.10
 uv pip install -e .[dev]
 ```
@@ -153,3 +154,5 @@ uv pip install -e .[dev]
 ## License
 
 Licensed under [Apache 2.0](./LICENSE)
+
+`sharedbox` is built using the Boost C++ library, which is licensed under the [Boost Software License](https://boost.org.cpp.al/LICENSE_1_0.txt).