pyaragorn 0.1.0__tar.gz

pyaragorn-0.1.0/.gitignore

@@ -0,0 +1,173 @@
+
+# Added manually
+
+### Cython ###
+
+# Created by https://www.gitignore.io/api/python,c
+# Edit at https://www.gitignore.io/?templates=python,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
+*.pdb
+
+# Kernel Module Compile Results
+*.mod*
+*.cmd
+.tmp_versions/
+modules.order
+Module.symvers
+Mkfile.old
+dkms.conf
+
+# Valgrind files
+callgrind.out.*
+
+# Memprofile
+mprofile_*.dat
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+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
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# pyenv
+.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
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# End of https://www.gitignore.io/api/python,c

pyaragorn-0.1.0/.readthedocs.yaml

@@ -0,0 +1,28 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.13"
+
+# VCS submodules configuration.
+submodules:
+  include: all
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+     - requirements: docs/requirements.txt
+     - method: pip
+       path: .

pyaragorn-0.1.0/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+
+## [Unreleased]
+[Unreleased]: https://github.com/althonos/pyaragorn/compare/v0.1.0...HEAD
+
+
+## [v0.1.0] - 2025-05-27
+[v0.1.0]: https://github.com/althonos/pyaragorn/compare/239956f...v0.1.0
+
+Initial release.

pyaragorn-0.1.0/CMakeLists.txt

@@ -0,0 +1,21 @@
+cmake_minimum_required(VERSION 3.20)
+project(${SKBUILD_PROJECT_NAME} VERSION ${SKBUILD_PROJECT_VERSION} LANGUAGES C)
+
+set(BUILD_SHARED_LIBS OFF)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+
+set(ARAGORN_VERSION "1.2.41")
+
+# --- Setup Cython -------------------------------------------------------------
+
+set_property(GLOBAL PROPERTY PYTHON_EXTENSIONS_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/src)
+set(CYTHON_HEADERS_DIR ${CMAKE_CURRENT_LIST_DIR}/include)
+include(src/scripts/cmake/CythonExtension.cmake)
+
+# --- Set ----------------------------------------------------------------------
+
+set(ARAGORN_C ${CMAKE_CURRENT_LIST_DIR}/vendor/aragorn/aragorn${ARAGORN_VERSION}.c)
+
+# --- Compile code -------------------------------------------------------------
+
+add_subdirectory(src)

pyaragorn-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Contributing to PyARAGORN
+
+For bug fixes or new features, please file an issue before submitting a
+pull request. If the change isn't trivial, it may be best to wait for
+feedback.
+
+## Coding guidelines
+
+### Versions
+
+This project targets Python 3.7 or later.
+
+Python objects should be typed; since it is not supported by Cython,
+you must manually declare types in type stubs (`.pyi` files). In Python
+files, you can add type annotations to function signatures (supported in
+Python 3.5) and in variable assignments (supported only from Python
+3.6 onward).
+
+### Interfacing with C
+
+When interfacing with C, and in particular with pointers, use assertions
+everywhere you assume the pointer to be non-NULL. Also consider using
+assertions when accessing raw C arrays, if applicable.
+
+## Setting up a local repository
+
+Just clone the project repository to get all the required files:
+
+```console
+$ git clone https://github.com/althonos/pyaragorn
+```
+
+## Running tests
+
+Tests are written as usual Python unit tests with the `unittest` module of
+the standard library. Running them requires the extension to be built
+locally:
+
+```console
+$ python -m pip install -v -e . --no-build-isolation
+$ python -m unittest -vv pyaragorn.tests
+```