readcon 0.2.0__tar.gz

readcon-0.2.0/.github/workflows/bench.yml

@@ -0,0 +1,46 @@
+name: Criterion benchmarks
+
+on:
+  push:
+  pull_request:
+
+concurrency:
+  group: critbench-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+
+jobs:
+  critbench:
+    # This job will only run if the commit message (on push) or PR title
+    # (on pull_request) contains the string "[BENCH]".
+    if: |
+      (github.event_name == 'push' && contains(join(github.event.commits.*.message), '[BENCH]')) ||
+      (github.event_name == 'pull_request' && contains(github.event.pull_request.title, '[BENCH]'))
+    runs-on: ubuntu-22.04
+    name: Run benchmarks
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          components: llvm-tools-preview
+          override: true
+
+      - name: setup sccache
+        uses: mozilla-actions/sccache-action@v0.0.9
+        with:
+          version: "v0.10.0"
+
+      - name: setup sccache environnement variables
+        run: |
+          echo "SCCACHE_GHA_ENABLED=true" >> $GITHUB_ENV
+          echo "RUSTC_WRAPPER=sccache" >> $GITHUB_ENV
+          echo "CMAKE_C_COMPILER_LAUNCHER=sccache" >> $GITHUB_ENV
+          echo "CMAKE_CXX_COMPILER_LAUNCHER=sccache" >> $GITHUB_ENV
+
+      - name: Benchmark
+        id: critbench
+        run: |
+          cargo bench

readcon-0.2.0/.github/workflows/build_test.yml

@@ -0,0 +1,52 @@
+name: Basic tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+concurrency:
+  group: btest_rust-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+
+jobs:
+  btest_rust:
+    runs-on: ubuntu-22.04
+    name: Run basic tests and build
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          components: llvm-tools-preview
+          override: true
+
+      - name: setup sccache
+        uses: mozilla-actions/sccache-action@v0.0.9
+        with:
+          version: "v0.10.0"
+
+      - name: setup sccache environnement variables
+        run: |
+          echo "SCCACHE_GHA_ENABLED=true" >> $GITHUB_ENV
+          echo "RUSTC_WRAPPER=sccache" >> $GITHUB_ENV
+          echo "CMAKE_C_COMPILER_LAUNCHER=sccache" >> $GITHUB_ENV
+          echo "CMAKE_CXX_COMPILER_LAUNCHER=sccache" >> $GITHUB_ENV
+
+      - name: install dependencies
+        run: |
+          python -m pip install meson
+          sudo apt install valgrind
+
+      - name: Build and test
+        id: btest_rust
+        run: |
+          meson setup bbdir -Dwith_tests=True \
+          -Dwith_cpp=True \
+          -Dwith_examples=True \
+          --buildtype=release
+          meson test -C bbdir \
+          --wrap="valgrind --leak-check=full --show-leak-kinds=definite,indirect,possible --track-origins=yes --error-exitcode=1 --suppressions=$GITHUB_WORKSPACE/valgrind.supp --gen-suppressions=all"

readcon-0.2.0/.github/workflows/ci_docs.yml

@@ -0,0 +1,46 @@
+name: Documentation
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: prefix-dev/setup-pixi@v0.8.8
+        with:
+          environments: docs
+
+      - name: Build documentation
+        run: pixi r -e docs docbld
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build
+
+  deploy:
+    if: github.ref == 'refs/heads/main'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

readcon-0.2.0/.github/workflows/coverage.yml

@@ -0,0 +1,73 @@
+name: Coverage
+# Adapted from https://github.com/metatensor/metatensor/pull/939
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+concurrency:
+  group: coverage-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+
+jobs:
+  coverage:
+    runs-on: ubuntu-22.04
+    name: collect code coverage
+    # Adapted from https://www.scivision.dev/github-actions-latest-llvm-clang-flang/
+    strategy:
+      matrix:
+        llvm-version: [20]
+    env:
+      CMAKE_C_COMPILER: clang-${{ matrix.llvm-version }}
+      CMAKE_CXX_COMPILER: clang++-${{ matrix.llvm-version }}
+      CC: clang-${{ matrix.llvm-version }}
+      CXX: clang++-${{ matrix.llvm-version }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: setup LLVM
+        run: |
+            wget https://apt.llvm.org/llvm.sh
+            chmod +x llvm.sh
+            sudo ./llvm.sh ${{ matrix.llvm-version }}
+            sudo apt-get update
+            sudo apt install --no-install-recommends clang-${{ matrix.llvm-version }}
+
+      - name: Install Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          components: llvm-tools-preview
+          override: true
+
+      - name: install cargo-llvm-cov
+        uses: taiki-e/install-action@cargo-llvm-cov
+
+      - name: setup sccache
+        uses: mozilla-actions/sccache-action@v0.0.9
+        with:
+          version: "v0.10.0"
+
+      - name: setup sccache environnement variables
+        run: |
+          echo "SCCACHE_GHA_ENABLED=true" >> $GITHUB_ENV
+          echo "RUSTC_WRAPPER=sccache" >> $GITHUB_ENV
+          echo "CMAKE_C_COMPILER_LAUNCHER=sccache" >> $GITHUB_ENV
+          echo "CMAKE_CXX_COMPILER_LAUNCHER=sccache" >> $GITHUB_ENV
+
+      - name: generate rust code coverage
+        id: coverage
+        run: |
+          cargo llvm-cov --all-features --workspace \
+            --no-fail-fast --codecov \
+            --include-ffi \
+            --output-path rust_codecov.json
+
+      # - name: upload to codecov.io
+      #   uses: codecov/codecov-action@v5
+      #   with:
+      #     fail_ci_if_error: true
+      #     files: rust_codecov.json
+      #     token: ${{ secrets.CODECOV_TOKEN }}

readcon-0.2.0/.github/workflows/lint.yml

@@ -0,0 +1,21 @@
+name: Lint
+
+on:
+  pull_request:
+    branches: [main]
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Conventional commits check
+      uses: cocogitto/cocogitto-action@v3
+
+    - name: Audit for large files
+      uses: HaoZeke/large-file-auditor@v0.1.0
+      with:
+        file-size-threshold: "1M"

readcon-0.2.0/.github/workflows/python_wheels.yml

@@ -0,0 +1,103 @@
+name: Python wheels
+
+on:
+  push:
+    tags:
+      - 'v*'
+  pull_request:
+    paths:
+      - 'src/**'
+      - 'Cargo.toml'
+      - 'Cargo.lock'
+      - 'pyproject.toml'
+  workflow_dispatch:
+
+concurrency:
+  group: python-wheels-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+
+permissions:
+  contents: read
+
+jobs:
+  sdist:
+    name: Build sdist
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build sdist
+        uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+
+      - name: Validate sdist
+        run: pipx run twine check --strict dist/*
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+
+  wheels:
+    name: Build wheels (${{ matrix.os }}, ${{ matrix.target }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-latest
+            target: x86_64
+          - os: ubuntu-latest
+            target: aarch64
+          - os: macos-13
+            target: x86_64
+          - os: macos-14
+            target: aarch64
+          - os: windows-latest
+            target: x86_64
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          args: --release --out dist --features python
+          manylinux: auto
+          # Cross-compile aarch64 on x86_64 runners
+          docker-options: ${{ matrix.target == 'aarch64' && '-e JEMALLOC_SYS_WITH_LG_PAGE=16' || '' }}
+
+      - name: Validate wheels
+        if: matrix.target != 'aarch64' || matrix.os != 'ubuntu-latest'
+        run: pipx run twine check --strict dist/*
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-${{ matrix.os }}-${{ matrix.target }}
+          path: dist/*.whl
+
+  publish:
+    name: Publish to PyPI
+    needs: [sdist, wheels]
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    environment:
+      name: pypi
+      url: https://pypi.org/p/readcon
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: '{sdist,wheels-*}'
+          merge-multiple: true
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

readcon-0.2.0/.gitignore

@@ -0,0 +1,169 @@
+# Additions
+*.profraw
+compile_commands.json
+
+# Documentation build artifacts
+docs/build/
+docs/doctrees/
+docs/source/*.rst
+docs/source/crates/
+docs/source/api/
+
+# pixi
+.pixi/
+###----------------###
+###  TopTal: rust  ###
+###----------------###
+
+# Created by https://www.toptal.com/developers/gitignore/api/rust
+# Edit at https://www.toptal.com/developers/gitignore?templates=rust
+
+### Rust ###
+# Generated by Cargo
+# will have compiled files and executables
+debug/
+target/
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+# End of https://www.toptal.com/developers/gitignore/api/rust
+
+###-------------------------###
+###  TopTal: rust-analyzer  ###
+###-------------------------###
+
+# Created by https://www.toptal.com/developers/gitignore/api/rust-analyzer
+# Edit at https://www.toptal.com/developers/gitignore?templates=rust-analyzer
+
+### rust-analyzer ###
+# Can be generated by other build systems other than cargo (ex: bazelbuild/rust_rules) 
+rust-project.json
+
+# End of https://www.toptal.com/developers/gitignore/api/rust-analyzer
+
+###----------------###
+###  GitHub: Rust  ###
+###----------------###
+
+
+# Generated by cargo mutants
+# Contains mutation testing data
+**/mutants.out*/
+
+# RustRover
+#  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/
+
+###-------------###
+###  TopTal: c  ###
+###-------------###
+
+# Created by https://www.toptal.com/developers/gitignore/api/c
+# Edit at https://www.toptal.com/developers/gitignore?templates=c
+
+### C ###
+# Prerequisites
+*.d
+
+# Object files
+*.o
+*.ko
+*.obj
+*.elf
+
+# Linker output
+*.ilk
+*.map
+*.exp
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Libraries
+*.lib
+*.a
+*.la
+*.lo
+
+# Shared objects (inc. Windows DLLs)
+*.dll
+*.so
+*.so.*
+*.dylib
+
+# Executables
+*.exe
+*.out
+*.app
+*.i*86
+*.x86_64
+*.hex
+
+# Debug files
+*.dSYM/
+*.su
+*.idb
+
+# Kernel Module Compile Results
+*.mod*
+*.cmd
+.tmp_versions/
+modules.order
+Module.symvers
+Mkfile.old
+dkms.conf
+
+# End of https://www.toptal.com/developers/gitignore/api/c
+
+###-------------###
+###  GitHub: C  ###
+###-------------###
+
+###-----------------###
+###  TopTal: macos  ###
+###-----------------###
+
+# Created by https://www.toptal.com/developers/gitignore/api/macos
+# Edit at https://www.toptal.com/developers/gitignore?templates=macos
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+# End of https://www.toptal.com/developers/gitignore/api/macos

readcon-0.2.0/CHANGELOG.md

@@ -0,0 +1,152 @@
+# Changelog
+All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.
+
+- - -
+## v0.2.0 - 2025-08-14
+#### Buildsystem
+- Bump for doctests - (bfe85e1) - HaoZeke
+- Enable doctests - (1d79f3a) - HaoZeke
+#### Continuous Integration
+- Try to run benchmarks more - (049c077) - HaoZeke
+#### Documentation
+- Discuss the design.. - (9229f0d) - HaoZeke
+#### Enhancements
+- Single pass for the writer - (ae39401) - HaoZeke
+- More ergonomic without constants for C++ - (7d78227) - HaoZeke
+- Add a cache for better performance - (ec8244d) - HaoZeke
+- Rework to use a writer object - (7029562) - HaoZeke
+- Update to do better on benchmarks - (063a89c) - HaoZeke
+- Setup the C++ API - (c54daf7) - HaoZeke
+- Rework to use opaque pointers - (736bb71) - HaoZeke
+- Rework the FFI for writes - (baae1c8) - HaoZeke
+- Update the C API sample - (5854ccc) - HaoZeke
+- Rework CLI to test things a bit - (a1177b6) - HaoZeke
+- Add a basic writer - (9b825f8) - HaoZeke
+#### Generated
+- Update generated readme - (0277e8b) - HaoZeke
+- Update with a void pointer - (f415740) - HaoZeke
+#### Maintenance
+- Bump versions - (3619311) - HaoZeke
+- Even faster fails - (f729de5) - HaoZeke
+- Cleanup and reduce scope - (a734715) - HaoZeke
+- Cleanup - (3575fcf) - HaoZeke
+- Fail faster for the FFI writer - (a343b86) - HaoZeke
+- Nicer documentation - (84b33db) - HaoZeke
+- Cleanup with constants - (70cad4f) - HaoZeke
+- Minor cleanup - (a9892c6) - HaoZeke
+- Remove dup - (dade44d) - HaoZeke
+- Update format string - (a874a98) - HaoZeke
+- Fix test [BENCH] - (b53fa91) - HaoZeke
+- Use more constants - (973f924) - HaoZeke
+- Update gitig - (64e9a79) - HaoZeke
+- Add an inverse helper for writes - (6170681) - HaoZeke
+- Minor documentation update - (b89931a) - HaoZeke
+#### Tests
+- Add some for writers - (0a59fcd) - HaoZeke
+
+- - -
+
+## v0.1.1 - 2025-07-19
+#### Benchmarks
+- Add iterator validation - (9c49c86) - HaoZeke
+#### Bugfixes
+- Fixup a misunderstanding of lifetimes - (038cc5c) - HaoZeke
+#### Buildsystem
+- Use the multi con for examples - (cbdfd6a) - HaoZeke
+#### Continuous Integration
+- Only run benchmarks on request - (222d727) - HaoZeke
+- Kill useless release thing - (96aa79a) - HaoZeke
+- Run benchmarks - (f60a32a) - HaoZeke
+- Use valgrind for gha - (0b2179e) - HaoZeke
+#### Enhancements
+- Demonstrate more of the C++ usage - (f9f838c) - HaoZeke
+- Setup the iterator usage in the C example - (596f65a) - HaoZeke
+- Add a more elegant iterator interface to C++ - (706f14b) - HaoZeke
+- Expose iterators through C interface - (aad794a) - HaoZeke
+- Implement a basic forward skipper - (6e2c8a4) - HaoZeke
+#### Generated
+- Update for criterion - (f1fcfa2) - HaoZeke
+#### Maintenance
+- Fix category tags - (19b7499) - HaoZeke
+- Bump version - (09ae400) - HaoZeke
+- Stop hardcoding paths - (7dbb381) - HaoZeke
+- More sane returns - (66fed6a) - HaoZeke
+- Add a valgrind suppression file - (9ea9c89) - HaoZeke
+- Rework to better explain behavior - (d65634a) - HaoZeke
+- Try to use cargo-dist for generating things - (2ff5ce6) - HaoZeke
+- Fix license and keywords - (aa016b2) - HaoZeke
+#### Tests
+- Add a test for the forward iterator - (0917875) - HaoZeke
+
+- - -
+
+## v0.1.0 - 2025-07-19
+#### Buildsystem
+- Remove unstable rust module for stable - (bb7a200) - HaoZeke
+- Let meson run cargo tests too - (99d4362) - HaoZeke
+- Finalize first pass for readcon core - (ddff2bc) - HaoZeke
+#### Continuous Integration
+- Check commits too - (0f636f1) - HaoZeke
+- Setup a basic build and run workflow - (ff9be41) - HaoZeke
+- Import lint and coverage - (36a3a54) - HaoZeke
+#### Data
+- Import test data from readCon - (c5cf85e) - HaoZeke
+#### Documentation
+- Kang from rgpycrumbs - (07435a7) - HaoZeke
+- Minor updates - (f46b178) - HaoZeke
+- Minor updates - (bcd4df7) - HaoZeke
+- Add some more - (6529b22) - HaoZeke
+- Add a bunch - (0ba1212) - HaoZeke
+- Minor note - (1ecc856) - HaoZeke
+- Minor update - (489e9df) - HaoZeke
+- Update readme from readCon - (7751124) - HaoZeke
+#### Enhancements
+- Add and check a C++ interface - (b713997) - HaoZeke
+- Add an example for the C API usage - (94cd71d) - HaoZeke
+- First pass at a baseline C FFI - (577d185) - HaoZeke
+- Start wiring up C connections for readcon - (5f35e54) - HaoZeke
+- Add in first working CLI - (74c25fb) - HaoZeke
+- Add in an iterator - (f7a618d) - HaoZeke
+- Parse a single frame - (d79938a) - HaoZeke
+- Setup the parse header function - (4491175) - HaoZeke
+- Start with error types and a parser - (817e8a8) - HaoZeke
+- Setup some nicer error handling - (f054edd) - HaoZeke
+- Use cog - (7d09a68) - HaoZeke
+#### Generated
+- Update readme - (6524e55) - HaoZeke
+- Vendor a copy of the generated header - (127dd98) - HaoZeke
+#### Maintenance
+- Use a tag prefix - (f1f68af) - HaoZeke
+- Minor renaming - (a871512) - HaoZeke
+- Be safer to ensure null termination - (ca239bc) - HaoZeke
+- Update cog setup - (96cbe69) - HaoZeke
+- Cleanup build for release details - (9af5629) - HaoZeke
+- Additions for coverage - (3d985ee) - HaoZeke
+- Stop using designated initializers for hpp - (9bab1f9) - HaoZeke
+- Finish renaming things - (9e8b5d2) - HaoZeke
+- Saner default settings, switch to C - (c93c562) - HaoZeke
+- Enhance the cbindgen file - (54d2fcb) - HaoZeke
+- Pin a rust version - (d7a6c76) - HaoZeke
+- Silence clippy - (45dbe6c) - HaoZeke
+- More output from the header - (04f0715) - HaoZeke
+- Restructure into a helper and use mass - (eb8d91b) - HaoZeke
+- Add cbindgen as a build dep - (97cb1c9) - HaoZeke
+- Fixup for subproject usage - (699d8df) - HaoZeke
+- Rename project - (2ed99c3) - HaoZeke
+- Actually link up error struct - (94fb2bf) - HaoZeke
+- Remember that usize is used for len() - (e51e012) - HaoZeke
+- Start parsing a bit better - (5de8060) - HaoZeke
+- Start working through lines - (c076bb5) - HaoZeke
+- Add in a quick file reading CLI sample - (37422d4) - HaoZeke
+- Add a test helper - (c896963) - HaoZeke
+- Start with a project configuration - (5730540) - HaoZeke
+- Initialize with cargo new - (059e4eb) - HaoZeke
+#### Tests
+- Update for multi con reads - (6590e83) - HaoZeke
+- Add more unit tests - (7cd595d) - HaoZeke
+- Add a more interesting test - (b4c0049) - HaoZeke
+- Start with a simple test - (fbd71c7) - HaoZeke
+
+- - -
+
+Changelog generated by [cocogitto](https://github.com/cocogitto/cocogitto).