flow-toon-format 0.9.0b2__tar.gz

flow_toon_format-0.9.0b2/.devcontainer/Dockerfile.dev

@@ -0,0 +1,27 @@
+ARG UV_VERSION=0.8.13
+
+FROM ghcr.io/astral-sh/uv:${UV_VERSION} AS uv
+
+FROM mcr.microsoft.com/devcontainers/base:bookworm
+
+COPY --from=uv /uv /uvx /bin/
+
+# Python environment variables for development
+ENV PYTHONUNBUFFERED=1 \
+    PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONIOENCODING=utf-8 \
+    PIP_NO_CACHE_DIR=1 \
+    PIP_DISABLE_PIP_VERSION_CHECK=1 \
+    UV_NO_CACHE=1 \
+    UV_PROJECT_ENVIRONMENT=/app/.venv \
+    LANG=C.UTF-8 \
+    LC_ALL=C.UTF-8
+
+USER vscode
+
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+
+WORKDIR /app
+
+HEALTHCHECK --interval=60s --timeout=5s --start-period=60s --retries=3 \
+    CMD test -d /app && whoami || exit 1

flow_toon_format-0.9.0b2/.devcontainer/README.md

@@ -0,0 +1,120 @@
+# Development Container
+
+This project uses a [Development Container](https://containers.dev/) to provide a consistent development environment.
+
+## Getting Started
+
+1. Install [Docker Desktop](https://www.docker.com/products/docker-desktop)
+2. Install [VS Code](https://code.visualstudio.com/) and the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
+3. Open this folder in VS Code
+4. When prompted, click "Reopen in Container" (or run command: `Dev Containers: Reopen in Container`)
+
+## Local Customization
+
+To customize your local development environment without modifying the committed configuration, create a `.devcontainer/devcontainer.local.json` file (this file is gitignored).
+
+### Example: Add Additional VS Code Extensions
+
+```json
+{
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "esbenp.prettier-vscode",
+        "usernamehw.errorlens"
+      ]
+    }
+  }
+}
+```
+
+### Example: Mount Additional Volumes
+
+```json
+{
+  "mounts": [
+    "source=${localEnv:HOME}/.gitconfig,target=/home/vscode/.gitconfig,type=bind,consistency=cached"
+  ]
+}
+```
+
+### Example: Override or Add Environment Variables
+
+The container sets several Python-related environment variables by default (see `Dockerfile.dev`). You can override them or add new ones using `remoteEnv`:
+
+```json
+{
+  "remoteEnv": {
+    "PYTHONUNBUFFERED": "0",
+    "DEBUG": "1",
+    "LOG_LEVEL": "DEBUG"
+  }
+}
+```
+
+See `devcontainer.local.json.example` for a complete list of default environment variables that can be overridden.
+
+Alternatively, create a `.devcontainer/.env` file (also gitignored):
+```bash
+DEBUG=1
+LOG_LEVEL=DEBUG
+```
+
+And reference it in `devcontainer.local.json`:
+```json
+{
+  "runArgs": ["--env-file", ".devcontainer/.env"]
+}
+```
+
+### Example: Forward Additional Ports
+
+```json
+{
+  "forwardPorts": [8080, 3000]
+}
+```
+
+## How It Works
+
+The Dev Container will:
+- Build from `Dockerfile.dev`
+- Mount your workspace to `/app`
+- Install Git and GitHub CLI features
+- Run `uv sync --all-groups` to create a virtual environment at `/app/.venv`
+- Configure VS Code to use the virtual environment's Python interpreter
+- Set up bash as the default terminal
+
+### Default Environment Variables
+
+The following Python-related environment variables are set in the container:
+
+- **`PYTHONUNBUFFERED=1`** - Ensures real-time output in logs
+- **`PYTHONDONTWRITEBYTECODE=1`** - Prevents `.pyc` file creation
+- **`PYTHONIOENCODING=utf-8`** - Ensures UTF-8 encoding for I/O
+- **`PIP_NO_CACHE_DIR=1`** - Disables pip caching to reduce container size
+- **`PIP_DISABLE_PIP_VERSION_CHECK=1`** - Suppresses pip update warnings
+- **`UV_NO_CACHE=1`** - Disables uv caching
+- **`UV_PROJECT_ENVIRONMENT=/app/.venv`** - Sets the virtual environment location for uv
+- **`LANG=C.UTF-8`** - Sets locale for proper Unicode handling
+- **`LC_ALL=C.UTF-8`** - Sets all locale categories to UTF-8
+
+These can be overridden in `devcontainer.local.json` using the `remoteEnv` property.
+
+### Virtual Environment
+
+The project uses `uv` to manage dependencies. When the container is created:
+1. `uv sync --all-groups` is automatically run to create a virtual environment at `/app/.venv`
+2. VS Code is configured to use `/app/.venv/bin/python` as the Python interpreter
+3. All dependencies from `pyproject.toml` (including dev groups) are installed
+
+To manually update dependencies, run:
+```bash
+uv sync --all-groups
+```
+
+## Rebuilding the Container
+
+If you modify the Dockerfile or devcontainer configuration:
+1. Run command: `Dev Containers: Rebuild Container`
+2. Or run: `Dev Containers: Rebuild Container Without Cache` for a clean build

flow_toon_format-0.9.0b2/.devcontainer/devcontainer.json

@@ -0,0 +1,30 @@
+{
+  // To customize this for your local environment without committing changes,
+  // create a .devcontainer/devcontainer.local.json file (it's gitignored).
+  // See .devcontainer/README.md for examples.
+  "name": "toon-python (devcontainer)",
+  "build": {
+    "dockerfile": "Dockerfile.dev",
+    "context": ".."
+  },
+  "workspaceFolder": "/app",
+  "mounts": [
+    "source=${localWorkspaceFolder},target=/app,type=bind,consistency=cached"
+  ],
+  "features": {
+    "ghcr.io/devcontainers/features/git:1": {},
+    "ghcr.io/devcontainers/features/github-cli:1": {}
+  },
+  "remoteEnv": {
+    // Python environment variables (can be overridden in devcontainer.local.json)
+    // These supplement the ENV vars set in Dockerfile.dev
+  },
+  "postCreateCommand": "uv sync --all-groups",
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "python.defaultInterpreterPath": "/app/.venv/bin/python"
+      }
+    }
+  }
+}

flow_toon_format-0.9.0b2/.devcontainer/devcontainer.local.json.example

@@ -0,0 +1,32 @@
+{
+  // Example local devcontainer configuration
+  // Copy this to devcontainer.local.json and customize as needed
+  // This file is gitignored and won't be committed
+  
+  "remoteEnv": {
+    // Override Python environment variables
+    // Uncomment and modify any of these to override defaults from Dockerfile.dev:
+    
+    // "PYTHONUNBUFFERED": "0",
+    // "PYTHONDONTWRITEBYTECODE": "0",
+    // "PYTHONIOENCODING": "utf-8",
+    // "PIP_NO_CACHE_DIR": "0",
+    // "PIP_DISABLE_PIP_VERSION_CHECK": "0",
+    // "UV_NO_CACHE": "0",
+    // "UV_PROJECT_ENVIRONMENT": "/custom/path/.venv",
+    // "LANG": "en_US.UTF-8",
+    // "LC_ALL": "en_US.UTF-8",
+    
+    // Add custom environment variables for local development:
+    // "DEBUG": "1",
+    // "LOG_LEVEL": "DEBUG"
+  },
+  
+  // You can also override other devcontainer settings:
+  // "features": {},
+  // "customizations": {
+  //   "vscode": {
+  //     "extensions": []
+  //   }
+  // }
+}

flow_toon_format-0.9.0b2/.editorconfig

@@ -0,0 +1,22 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{py,pyi}]
+indent_style = space
+indent_size = 4
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
+
+[*.{json,toml}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

flow_toon_format-0.9.0b2/.github/CODEOWNERS

@@ -0,0 +1,8 @@
+# Default owners for everything
+* @toon-format/python-maintainers
+
+# Project governance and documentation
+CODE_OF_CONDUCT.md @johannschopplich
+CONTRIBUTING.md @johannschopplich
+LICENSE @johannschopplich
+README.md @johannschopplich

flow_toon_format-0.9.0b2/.github/workflows/lint.yml

@@ -0,0 +1,39 @@
+name: Lint
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    name: Lint and Type Check
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          uv sync
+          uv pip install ruff mypy pytest
+
+      - name: Run ruff check
+        run: uv run ruff check src/ tests/
+
+      - name: Run ruff format check
+        run: uv run ruff format --check src/ tests/
+
+      - name: Run mypy
+        run: uv run mypy src/

flow_toon_format-0.9.0b2/.github/workflows/publish.yml

@@ -0,0 +1,83 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Check package
+        run: twine check dist/*
+
+      - name: Store distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    if: github.event_name == 'release' && github.event.action == 'published'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/toon_format
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  publish-to-testpypi:
+    name: Publish to TestPyPI
+    if: github.event_name == 'workflow_dispatch'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/toon_format
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/

flow_toon_format-0.9.0b2/.github/workflows/test.yml

@@ -0,0 +1,52 @@
+name: Tests
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+
+jobs:
+  test:
+    name: Test Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Run tests with coverage
+        run: uv run pytest --cov=toon_format --cov-report=xml --cov-report=term --cov-report=html --cov-fail-under=85
+
+      - name: Upload coverage reports as artifact
+        uses: actions/upload-artifact@v4
+        if: matrix.python-version == '3.12'
+        with:
+          name: coverage-reports
+          path: |
+            coverage.xml
+            htmlcov/
+          retention-days: 30
+
+      - name: Coverage comment on PR
+        uses: py-cov-action/python-coverage-comment-action@v3
+        if: matrix.python-version == '3.12' && github.event_name == 'pull_request'
+        with:
+          GITHUB_TOKEN: ${{ github.token }}
+          MINIMUM_GREEN: 90
+          MINIMUM_ORANGE: 85

flow_toon_format-0.9.0b2/.gitignore

@@ -0,0 +1,110 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# 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
+
+# Package-specific
+toon_format.egg-info/
+
+# Ruff cache
+.ruff_cache/
+
+# Mypy cache
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.python-version
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.claude/
+CLAUDE.md
+
+# DevContainer local overrides
+.devcontainer/devcontainer.local.json
+.devcontainer/.env
+
+# macOS
+.DS_Store
+.AppleDouble
+.LSOverride
+._*
+
+# 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
+
+# uv
+.uv/
+uv.lock
+
+PR_DESCRIPTION.md
+AGENTS.md
+.augment/

flow_toon_format-0.9.0b2/CONTRIBUTING.md

@@ -0,0 +1,106 @@
+# Contributing to toon-python
+
+Thank you for your interest in contributing to the official Python implementation of TOON!
+
+## Project Setup
+
+This project uses [`uv`](https://github.com/astral-sh/uv) for dependency management.
+
+```bash
+# Clone the repository
+git clone https://github.com/toon-format/toon-python.git
+cd toon-python
+
+# Install dependencies (uv will create a virtual environment automatically)
+uv sync
+
+# Run tests
+uv run pytest
+
+# Run tests with coverage
+uv run pytest --cov=src/toon_format --cov-report=term-missing
+```
+
+## Development Workflow
+
+1. **Fork the repository** and create a feature branch
+2. **Make your changes** following the coding standards below
+3. **Add tests** for any new functionality
+4. **Ensure all tests pass** and coverage remains high
+5. **Submit a pull request** with a clear description
+
+## Coding Standards
+
+### Python Version Support
+
+We support Python 3.8 and above (including Python 3.13 and 3.14).
+
+### Type Safety
+
+- All code must include type hints
+- Run `mypy` before committing:
+  ```bash
+  uv run mypy src/
+  ```
+
+### Code Style
+
+- We use `ruff` for linting and formatting
+- Run before committing:
+  ```bash
+  uv run ruff check src/ tests/
+  uv run ruff format src/ tests/
+  ```
+
+### Testing
+
+- All new features must include tests
+- Maintain test coverage at **85%+ line coverage**
+- Tests should cover edge cases and spec compliance
+- Run the full test suite:
+  ```bash
+  uv run pytest tests/
+
+  # Run with coverage report
+  uv run pytest --cov=toon_format --cov-report=term --cov-fail-under=85
+  ```
+
+## SPEC Compliance
+
+All implementations must comply with the [TOON specification](https://github.com/toon-format/spec/blob/main/SPEC.md).
+
+Before submitting changes that affect encoding/decoding behavior:
+1. Verify against the official SPEC.md
+2. Add tests for the specific spec sections you're implementing
+3. Document any spec version requirements
+
+## Pull Request Guidelines
+
+- **Title**: Use a clear, descriptive title
+- **Description**: Explain what changes you made and why
+- **Tests**: Include tests for your changes
+- **Documentation**: Update README or documentation if needed
+- **Commits**: Use clear commit messages ([Conventional Commits](https://www.conventionalcommits.org/) preferred)
+
+Your pull request will use our standard template which guides you through the required information.
+
+## Communication
+
+- **GitHub Issues**: For bug reports and feature requests
+- **GitHub Discussions**: For questions and general discussion
+- **Pull Requests**: For code reviews and implementation discussion
+
+## Maintainers
+
+This is a collaborative project. Current maintainers:
+
+- [@xaviviro](https://github.com/xaviviro)
+- [@davidpirogov](https://github.com/davidpirogov)
+- [@bpradana](https://github.com/bpradana)
+- [@Justar96](https://github.com/Justar96)
+
+All maintainers have equal and consensual decision-making power. For major architectural decisions, please open a discussion issue first.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.

flow_toon_format-0.9.0b2/LICENSE

@@ -0,0 +1,24 @@
+MIT License
+
+Copyright (c) 2025-PRESENT Xavi Vinaixa
+Copyright (c) 2025-PRESENT David Pirogov
+Copyright (c) 2025-PRESENT Justar
+Copyright (c) 2025-PRESENT Johann Schopplich
+
+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.