pylogiclock 0.2.0

Scan and validate code with configurable logic-lock rules.

logic-lock

================================================== L O G I C - L O C K pip install pylogiclock import logiclock ==================================================

Rules, decorator metadata, and code — stay consistent

pip install pylogiclock — import logiclock (PyPI uses pylogiclock; logic-lock is blocked as too similar to an existing name.)

---

What it does

logic-lock ties authoritative rule definitions (e.g. JSON: conditions + result) to what you declare on Python functions with @logic_lock (rule id, optional result / conditions). It can report mismatches (wrong result string, missing conditions) and includes helpers for matching, reports, and scenario hints — so teams don’t silently drift between “what the rule says” and “what the code claims.”

Why use it

• One place for rule IDs and expected outcomes; metadata on callables documents intent.
• Catch inconsistencies early (tests or CI) instead of only in code review.
• Small CLI today (report-sample, version); scan / validate will grow — the Python API is the main integration point right now.

TL;DR

pip install pylogiclock
logiclock --version
logiclock --no-color report-sample

---

In your code

from logiclock.decorators import logic_lock

@logic_lock(
    "my_rule",
    result="ok",
    conditions=["user.is_active"],
)
def handle_request(user):
    ...

More examples: tests/test_rule_validator.py.

---

Install

How	Command
PyPI	pip install pylogiclock
This repo	pip install .

CLI: logiclock --help

---

Troubleshooting

Issue	Try
No module named logiclock	pip install pylogiclock or pip install -e .
CLI not found	Same venv; python -m pip show pylogiclock
scan is a stub	Use the Python API for now
Colors in CI	logiclock --no-color ...

Issues

---

Development

Python 3.11+.

pip install -r requirements-lock.txt
pip install -e . --no-deps
flake8 src tests
pytest tests

Or pip install -e ".[dev]". Refresh lock:

pip-compile --strip-extras --extra dev -o requirements-lock.txt pyproject.toml

CI in this repo

• lint-and-test: flake8 + pytest
• logiclock-scan: composite action, continue-on-error: true for now

GitHub Actions (yours)

jobs:
  logiclock:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: "3.12"
          cache: pip
          cache-dependency-path: |
            pyproject.toml
            requirements-lock.txt
      - run: |
          pip install -r requirements-lock.txt
          pip install . --no-deps
      - run: logiclock --strict --no-color scan

This repo (uses: ./):

- uses: ./
  with:
    python-version: "3.12"
    install-command: pip install -r requirements-lock.txt && pip install . --no-deps
    scan-command: logiclock --strict --no-color scan

Other repos:

install-command: pip install "pylogiclock @ git+https://github.com/YOUR_ORG/logiclock.git@vX.Y.Z"

On PyPI: use pip install pylogiclock in install-command.