pyforce-rosie 2.0.0__tar.gz

pyforce_rosie-2.0.0/.dockerignore

@@ -0,0 +1,15 @@
+.venv
+.uv
+.pytest_cache
+.mypy_cache
+.ruff_cache
+__pycache__
+dist
+build
+.git
+.cookie-pyrate
+.env
+.env.test
+tests
+docs
+site

pyforce_rosie-2.0.0/.env.test

@@ -0,0 +1 @@
+# Environment for the test suite (pytest-env loads it before collection)

pyforce_rosie-2.0.0/.git-blame-ignore-revs

@@ -0,0 +1,3 @@
+# Formatting-only commits: `git blame` skips them
+# (git config blame.ignoreRevsFile .git-blame-ignore-revs; GitHub does it by itself)
+a80a0490e6bdef9040f868d24e9fe5dc4a9650d5  # Format the code with ruff format

pyforce_rosie-2.0.0/.github/workflows/qa.yml

@@ -0,0 +1,15 @@
+name: QA
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  qa:
+    uses: gvieralopez/cookie-pyrate/.github/workflows/reusable-qa.yml@v1.1.0
+    with:
+      cookie-pyrate-ref: v1.1.0
+      python-version: "3.15"
+      # the client runs on users' own Pythons; the robot's image uses 3.15
+      test-python-versions: '["3.12", "3.13", "3.14", "3.15"]'

pyforce_rosie-2.0.0/.github/workflows/release.yml

@@ -0,0 +1,43 @@
+name: Release
+
+on:
+  workflow_run:
+    workflows: ["QA"]
+    branches: [main]
+    types: [completed]
+
+concurrency:
+  group: release
+  cancel-in-progress: false
+
+jobs:
+  release:
+    if: github.event.workflow_run.conclusion == 'success'
+    uses: gvieralopez/cookie-pyrate/.github/workflows/reusable-release.yml@v1.1.0
+    permissions:
+      contents: write
+      packages: write
+    with:
+      cookie-pyrate-ref: v1.1.0
+      create-github-release: true
+      attach-distribution: false
+      # ghcr.io/pyforce/rosie, with WebRosie (the release in the Dockerfile's WEBROSIE_VERSION)
+      publish-docker-image: true
+      prepare-next-version: true
+    secrets:
+      # Created by `make repo`; lets the version bumps land on a protected main.
+      RELEASE_SSH_KEY: ${{ secrets.RELEASE_SSH_KEY }}
+
+  pypi:
+    needs: release
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/pyforce-rosie/
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: gvieralopez/cookie-pyrate/.github/actions/publish-to-pypi@v1.1.0
+        with:
+          sha: ${{ needs.release.outputs.sha }}

pyforce_rosie-2.0.0/.gitignore

@@ -0,0 +1,223 @@
+# 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 is intentionally committed for reproducible environments.
+
+# 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
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# 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
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Checkout of the shared Cookie Pyrate actions, made by the CI workflows in the
+# workspace root. It is a separate repository and is linted where it lives.
+.cookie-pyrate/
+
+# rosie
+recordings/

pyforce_rosie-2.0.0/.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+repos:
+  - repo: local
+    hooks:
+      - id: lint
+        name: Ruff Lint
+        entry: make lint
+        language: system
+        types: [python]
+        pass_filenames: false
+
+      - id: format
+        name: Ruff Format
+        entry: make format
+        language: system
+        types: [python]
+        pass_filenames: false
+
+      - id: typecheck
+        name: Mypy Typecheck
+        entry: make typecheck
+        language: system
+        types: [python]
+        pass_filenames: false

pyforce_rosie-2.0.0/.python-version

@@ -0,0 +1 @@
+3.15

pyforce_rosie-2.0.0/.readthedocs.yaml

@@ -0,0 +1,23 @@
+# Read the Docs builds the documentation with Zensical, from the locked docs group.
+version: 2
+
+build:
+  os: ubuntu-26.04
+  tools:
+    # Read the Docs may not offer the project's Python yet; uv installs it from .python-version.
+    python: "latest"
+  jobs:
+    pre_create_environment:
+      - asdf plugin add uv
+      - asdf install uv latest
+      - asdf global uv latest
+    create_environment:
+      - uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
+    install:
+      - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --no-default-groups --group docs
+    build:
+      html:
+        - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv run --no-sync zensical build --clean
+    post_build:
+      - mkdir -p "${READTHEDOCS_OUTPUT}/html"
+      - cp -r dist/docs/. "${READTHEDOCS_OUTPUT}/html/"

pyforce_rosie-2.0.0/AGENTS.md

@@ -0,0 +1,47 @@
+# rosie
+
+Modular robot control system
+
+Style, conventions and tooling for this project.
+
+## Layout
+
+1. `src/rosie/{models,errors,__main__}.py`; sub-domains as sub-packages (e.g. `motion/`).
+2. Data structures live in `models.py`, error types in `errors.py`, unless the framework in use recommends a different file structure.
+3. Order functions top-down — callers before callees, private helpers (`_name`) last — so the most important read first.
+4. Do not write docstrings or descriptive comments unless the user asks for them or they provide context that cannot be inferred by reading the code.
+
+## Design
+
+1. Prefer immutable dataclasses for plain data: `@dataclass(frozen=True)` (add `slots=True` when it fits).
+2. Where a framework owns the type — ORM entities, pydantic models, settings objects — follow its idiom instead of forcing a dataclass.
+3. Avoid default arguments in functions.
+4. If a function takes a bool that drives an `if`, prefer splitting into two functions (one delegating to the other, or factoring out shared logic when it saves ≥2 LoC).
+
+## Hygiene
+
+1. No commented-out code.
+2. Every `# noqa` must specify a rule code, e.g. `# noqa: E501` and should be avoided unless the user asks for it.
+3. Serialise JSON with `indent=2`.
+4. Wrap any disk I/O in `TemporaryDirectory()` and operate via `Path` objects.
+
+## Python
+
+1. Always use f-strings, `pathlib`, and idiomatic constructs.
+2. Avoid `open()` for reading or writing — use `Path.read_text()` / `Path.write_text()` / `Path.read_bytes()` / `Path.write_bytes()` (ruff `PTH`).
+3. Never use `print` outside `scripts/`. Use `logger = logging.getLogger(__name__)` at module level (ruff `T20`).
+4. Annotate everything; mypy runs with `disallow_untyped_defs = true`. Use modern typing (`list[...]`, `dict[...]`, `X | None`, `collections.abc.MutableMapping`, etc.).
+
+## Tests
+
+1. Function-based pytest with `@pytest.mark.parametrize`. No test classes.
+2. The test tree mirrors the package tree: a module at `validation/rules.py` is tested by `tests/validation/test_rules.py`.
+3. Shared fixtures, env dicts and fixture-path constants live in `tests/conftest.py`. Test data under `tests/data/` or `tests/fixtures/`.
+4. `.env.test` holds the suite's baseline environment; `pytest-env` loads it before collection. Override a single variable in a single test with `monkeypatch.setenv` / `monkeypatch.delenv` — never assign to `os.environ` directly, so nothing leaks between tests.
+5. Don't lower the `--cov-fail-under` threshold configured in `pyproject.toml`; add tests instead.
+
+## Tooling
+
+1. Use **ruff + mypy + pytest** with **uv**.
+2. Standard QA invocation: `make qa` — it covers lint, format, type checks and tests. `make test` runs the suite on its own.
+3. Never call `python3` directly in agent scripts; use `uv run` so inline script metadata can declare dependencies.

pyforce_rosie-2.0.0/CODEOWNERS

@@ -0,0 +1 @@
+* @gvieralopez @rolurq @frndmg @alxrcs @nilox94