Metadata-Version: 2.2
Name: check-orbit
Version: 0.1.0
Summary: Pybind11 check_orbit extension built with CMake
Author-Email: Your Name <your.email@example.com>
License: MIT License
         
         Copyright (c) 2024 check-orbit contributors
         
         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.
         
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
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 :: C++
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# check_orbit (pybind11 C++ extension)

This folder contains the C++/CMake-based pybind11 extension `check_orbit` used by the project.

Quick install (build and install into the active Python environment)

Prerequisites
- Python development headers and a C/C++ toolchain:
  - macOS: Xcode command line tools (clang)
  - Windows: MSVC Build Tools (matching the Python ABI)
- CMake

Install build dependencies and build:

```bash
python -m pip install --upgrade pip setuptools wheel scikit-build pybind11 cmake
cd core/cpp
python -m pip install .
```

This uses `scikit-build` to call CMake (the existing `CMakeLists.txt` in this folder).

Create a wheel (artifact) for distribution:

```bash
cd core/cpp
python -m pip wheel . -w ../dist
```

Notes
- Wheels are platform / Python-ABI specific. A wheel built on Windows will not work on macOS (and vice versa).
- If `pip` cannot find a compatible wheel on the target machine, it will attempt to build from source. The target machine must have the required build tools installed.
- For CI-built wheels, consider using `cibuildwheel` to produce many-platform wheels and publish to PyPI or GitHub Releases.
