ledgercore 0.1.0__tar.gz

ledgercore-0.1.0/.codecrate.toml

@@ -0,0 +1,14 @@
+[codecrate]
+output = "context_ledgercore.md"
+keep_docstrings = true
+dedupe = true
+respect_gitignore = true
+# exclude = ["*/.venv/*", "integration_tests", "examples", "docs"]
+gitignore_allow = ["taskledger/_version.py"]
+exclude = ["*/.venv/*", "integration_tests", "todo.md"]
+include = ["**/*.py", "**/*.toml", "**/*.rst", "**/*.md", "**/*.typed", "**/*.js", "**/*.css", "**/*.html", "**/*.conf"]
+split_max_chars = 0
+manifest = false
+layout = "full"
+profile = "portable-agent"
+emit_standalone_unpacker = true

ledgercore-0.1.0/.github/workflows/codecov.yml

@@ -0,0 +1,20 @@
+name: CodeCov
+on: push
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    env:
+      OS: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Setup Python
+      uses: actions/setup-python@master
+    - name: 'generate report'
+      run: |
+        pip install coverage click pytest pytest-cov
+        pip install -e .
+        pytest --cov --cov-branch --cov-report=xml
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v5
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }} # required

ledgercore-0.1.0/.github/workflows/pre-commit.yml

@@ -0,0 +1,31 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Install Python tools
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install "ruff==0.15.12"
+
+      - name: Install Node tools
+        run: |
+          npm install -g prettier@2.7.1 @prettier/plugin-xml@2.2.0 eslint
+
+      - uses: pre-commit/action@v3.0.1

ledgercore-0.1.0/.github/workflows/python-publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@v1.13.0
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

ledgercore-0.1.0/.github/workflows/tests.yml

@@ -0,0 +1,28 @@
+name: Run tests
+on: [push]
+jobs:
+  run:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+    - uses: actions/checkout@master
+    - name: Setup Python
+      uses: actions/setup-python@master
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install packages
+      run: |
+        pip install pytest
+        pip install -e .
+    - name: Run tests
+      if: runner.os != 'Windows'
+      run: python -m pytest
+    - name: Run tests on Windows
+      if: runner.os == 'Windows'
+      timeout-minutes: 60
+      env:
+        PYTHONFAULTHANDLER: "1"
+      run: python -X faulthandler -m pytest -vv

ledgercore-0.1.0/.gitignore

@@ -0,0 +1,222 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+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
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  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/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+.codex
+
+ledgercore/_version.py
+
+context_ledgercore.md
+context_ledgercore.index.json
+*.unpack.py
+workspace/
+.taskledger/
+.pi-lens/
+.code/
+todo.md
+uv.lock
+/plan.md

ledgercore-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,66 @@
+exclude: |
+  # NOT INSTALLABLE ADDONS
+  # END NOT INSTALLABLE ADDONS
+  # Files and folders generated by bots, to avoid loops
+  ^setup/|/static/description/index\.html$|
+  # We don't want to mess with tool-generated files
+  .svg$|/tests/([^/]+/)?cassettes/|^.copier-answers.yml$|^.github/|
+  # Maybe reactivate this when all README files include prettier ignore tags?
+  ^README\.md$|
+  # Repos using Sphinx to generate docs don't need prettying
+  ^docs/_templates/.*\.html$|
+  # Don't bother non-technical authors with formatting issues in docs
+  readme/.*\.(rst|md)$|
+  # Ignore build and dist directories in addons
+  /build/|/dist/|/dev/|/notnebooks/
+  # You don't usually want a bot to modify your legal texts
+  (LICENSE.*|COPYING.*)|
+default_language_version:
+  python: python3
+repos:
+  - repo: local
+    hooks:
+      - id: ruff-check
+        name: ruff check
+        entry: ruff check --fix --exit-non-zero-on-fix --config=.ruff.toml --force-exclude
+        language: system
+        types_or: [python, pyi]
+      - id: ruff-format
+        name: ruff format
+        entry: ruff format --force-exclude
+        language: system
+        types_or: [python, pyi]
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.21.2
+    hooks:
+      - id: pyupgrade
+        args: [--py310-plus]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-symlinks
+      - id: check-xml
+      - id: mixed-line-ending
+        args: ["--fix=lf"]
+      - id: debug-statements
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+        # exclude files where underlines are not distinguishable from merge conflicts
+        exclude: /README\.rst$|^docs/.*\.rst$
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v4.0.0-alpha.8
+    hooks:
+      - id: prettier
+        name: prettier (with plugin-xml)
+        additional_dependencies:
+          - "prettier@2.7.1"
+          - "@prettier/plugin-xml@2.2.0"
+        args:
+          - --plugin=@prettier/plugin-xml
+        files: \.(css|htm|html|js|json|jsx|less|md|scss|toml|ts|xml|yaml|yml)$

ledgercore-0.1.0/.readthedocs.yaml

@@ -0,0 +1,23 @@
+# Read the Docs configuration file
+# 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-24.04
+  tools:
+    python: "3.13"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+# Optionally, 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: .

ledgercore-0.1.0/.ruff.toml

@@ -0,0 +1,26 @@
+
+target-version = "py310"
+fix = true
+
+[lint]
+extend-select = [
+    "B",
+    "C90",
+    "E501",  # line too long (default 88)
+    "I",  # isort
+    "UP",  # pyupgrade
+]
+exclude = ["setup/*", "notebooks/*"]
+
+[format]
+exclude = ["setup/*", "notebooks/*"]
+
+[lint.per-file-ignores]
+"__init__.py" = ["F401", "I001"]  # ignore unused and unsorted imports in __init__.py
+"__manifest__.py" = ["B018"]  # useless expression
+
+[lint.isort]
+section-order = ["future", "standard-library", "third-party", "first-party", "local-folder"]
+
+[lint.mccabe]
+max-complexity = 20

ledgercore-0.1.0/.taskledger.toml

@@ -0,0 +1,76 @@
+# Project-local taskledger configuration.
+# This file lives in the source project root.
+config_version = 2
+taskledger_dir = '../taskledger-state/ledgercore'
+# Stable project identity. Commit this with your source tree.
+project_uuid = "1d41c550-f0e8-4d08-89ac-a2f7cc4f9c7c"
+project_name = "ledgercore"
+
+# Taskledger branch-scoped state. This block is intentionally safe to commit.
+ledger_ref = "main"
+ledger_parent_ref = ""
+ledger_next_task_number = 5
+ledger_branch_guard = "off"
+
+# Project-local taskledger overrides.
+# The source-budget settings below are the active composition defaults.
+# Lower them for stricter prompts,.or raise them when a run needs more context.
+# Supported keys:
+# default_memory_update_mode = "replace"
+# default_file_render_mode = "content"
+# default_save_run_reports = true
+# default_source_max_chars = 12000
+# default_total_source_max_chars = 48000
+# default_source_head_lines = 200
+# default_source_tail_lines = 50
+# default_context_order = ["memory", "file", "item", "inline", "loop_artifact"]
+# workflow_schema = "opsx-lite"
+# project_context = "Project-specific workflow guidance."
+# default_artifact_order = ["analysis", "plan", "implementation", "validation"]
+
+# Optional project-local planning guidance for agents.
+# This is advisory and cannot override lifecycle gates.
+# [prompt_profiles.planning]
+# profile = "balanced"
+# question_policy = "ask_when_missing"
+# max_required_questions = 5
+# min_acceptance_criteria = 1
+# todo_granularity = "implementation_steps"
+# require_files = true
+# require_test_commands = true
+# require_expected_outputs = true
+# require_validation_hints = true
+# plan_body_detail = "normal"
+# required_question_topics = ["scope", "tests"]
+# extra_guidance = "Mention docs and validation evidence in every plan."
+
+# Agent command transcript logging (disabled by default).
+# [agent_logging]
+# enabled = false
+# capture_taskledger_cli = true
+# capture_managed_shell = true
+# capture_visible_stdout = true
+# capture_visible_stderr = true
+# capture_visible_combined = true
+# capture_payload_metadata = true
+# max_inline_chars = 4000
+# store_full_output_artifacts = true
+# max_artifact_bytes = 2000000
+# fail_on_logging_error = false
+# redact_patterns = ["(?i)(api[_-]?key|token|password|secret)=\\S+"]
+# capture_safe_read_only = true
+# capture_human_oriented = true
+
+# Action/event logging for monitor activity (enabled by default).
+# Set enabled = false to stop writing new action events.
+# [event_logging]
+# enabled = true
+
+# Optional sync.git defaults for private external Git state.
+# [sync.git]
+# repo = "../taskledger-state"
+# project_path = "project-a"
+# remote = "origin"
+# branch = "main"
+# allow_active_locks = false
+# hooks = false

ledgercore-0.1.0/CHANGELOG.md

@@ -0,0 +1,23 @@
+# 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).
+
+## [0.1.0] - Unreleased
+
+### Added
+
+- Atomic UTF-8 text writes and race-safe file creation (`ledgercore.atomic`).
+- Shared exception hierarchy with stable error codes (`ledgercore.errors`).
+- YAML front matter reader/writer and source file iteration (`ledgercore.frontmatter`).
+- Prefixed numeric ID formatting, parsing, next-ID generation, slug helpers (`ledgercore.ids`).
+- UTF-8 text helpers, newline normalization, content hash, text merging (`ledgercore.io`).
+- Validated JSON object/array loading and deterministic JSON writing (`ledgercore.jsonio`).
+- Safe relative POSIX path validation, config discovery, config-relative resolution (`ledgercore.paths`).
+- Canonical cross-ledger resource references (`ledgercore.refs`).
+- UTC timestamp generation with second precision (`ledgercore.time`).
+- Validated YAML mapping loading and deterministic YAML writing (`ledgercore.yamlio`).
+- `py.typed` marker for PEP 561 type checking support.
+- Full test suite with 235 tests.

ledgercore-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# Contributing to ledgercore
+
+Thank you for your interest in contributing to `ledgercore`.
+
+## Setup
+
+Clone the repository and install with dev dependencies:
+
+```bash
+git clone https://github.com/holgern/ledgercore.git
+cd ledgercore
+python -m pip install -e ".[dev]"
+```
+
+## Running tests
+
+```bash
+python -m pytest -q
+```
+
+All tests must pass before submitting a change.
+
+## Linting
+
+```bash
+python -m ruff check .
+```
+
+Ruff is configured in `.ruff.toml`. Fix any reported issues before submitting.
+
+## Type checking
+
+```bash
+python -m mypy ledgercore
+```
+
+The project uses strict mypy. There should be no errors.
+
+## Making changes
+
+- Keep the package dependency-free except for PyYAML.
+- Do not add a CLI.
+- Do not couple to `taskledger`, `archledger`, or any product-specific package.
+- Maintain the typed public API.
+- Add tests for new functionality.
+- Update `CHANGELOG.md` under an appropriate section.
+- Run all checks before opening a pull request.
+
+## Building
+
+```bash
+python -m build
+python -m twine check dist/*
+```
+
+## Pull request checklist
+
+- [ ] Tests pass (`python -m pytest -q`).
+- [ ] Lint passes (`python -m ruff check .`).
+- [ ] Type checking passes (`python -m mypy ledgercore`).
+- [ ] Build succeeds (`python -m build`).
+- [ ] Twine check passes (`python -m twine check dist/*`).
+- [ ] CHANGELOG.md updated if applicable.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the
+Apache-2.0 license.