strayguard 0.1.0__tar.gz

strayguard-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,75 @@
+name: publish
+
+on:
+  push:
+    tags: ["v*"]          # a version tag publishes to PyPI
+  workflow_dispatch:      # a manual run publishes to TestPyPI only
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build and check the package
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v7
+      - uses: astral-sh/setup-uv@v10.3.0
+      - name: Check that the tag matches the version in pyproject.toml
+        if: github.event_name == 'push'
+        run: |
+          version=$(python3 -c 'import tomllib; print(tomllib.load(open("pyproject.toml", "rb"))["project"]["version"])')
+          if [ "v$version" != "$GITHUB_REF_NAME" ]; then
+            echo "Tag $GITHUB_REF_NAME does not match version $version in pyproject.toml."
+            exit 1
+          fi
+      - name: Run the unit tests
+        run: uv run --no-project --with pytest pytest -q
+      - name: Build the wheel and the source archive
+        run: uv build
+      - name: Check that PyPI can show the README
+        run: uvx twine check --strict dist/*
+      - uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+
+  testpypi:
+    name: Publish to TestPyPI
+    if: github.event_name == 'workflow_dispatch'
+    needs: build
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/strayguard
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+
+  pypi:
+    name: Publish to PyPI
+    if: github.event_name == 'push'
+    needs: build
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    environment:
+      name: pypi
+      url: https://pypi.org/p/strayguard
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

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

@@ -0,0 +1,53 @@
+name: tests
+
+on:
+  push: 
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+
+concurrency:
+  group: tests-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: Python ${{ matrix.python }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 10
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
+        include:
+          - os: macos-latest
+            python: "3.14"
+    steps:
+      - uses: actions/checkout@v7
+      - uses: astral-sh/setup-uv@v10.3.0
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Run the unit tests
+        run: uv run --no-project --with pytest pytest -v
+
+  build:
+    name: Build the package
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v7
+      - uses: astral-sh/setup-uv@v10.3.0
+      - name: Build the wheel and the source archive
+        run: uv build
+      - name: Check the package metadata
+        run: |
+          unzip -p dist/*.whl '*/METADATA' > METADATA
+          grep -q '^License-Expression: MIT' METADATA
+          grep -q '^Keywords: ' METADATA
+          grep -q '^Requires-Python: >=3.9' METADATA
+          echo "Metadata OK"
+  

strayguard-0.1.0/.gitignore

@@ -0,0 +1,220 @@
+# 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
+*.lcov
+.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/*
+!.pixi/config.toml
+
+# 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/Zensical 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/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

strayguard-0.1.0/.pre-commit-hooks.yaml

@@ -0,0 +1,11 @@
+- id: strayguard
+  name: strayguard
+  description: Flag new files that do not belong in the repository, with TypeSafe Jev.
+  entry: strayguard check
+  language: python
+  pass_filenames: false
+  always_run: true
+  require_serial: true
+  verbose: true
+  stages: [pre-commit]
+  minimum_pre_commit_version: "3.2.0"

strayguard-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Eva
+
+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.

strayguard-0.1.0/PKG-INFO

@@ -0,0 +1,245 @@
+Metadata-Version: 2.5
+Name: strayguard
+Version: 0.1.0
+Summary: A git pre-commit hook that asks TypeSafe Jev whether each new file belongs in your repo.
+Project-URL: Homepage, https://github.com/Eve2512/Strayguard
+Project-URL: Issues, https://github.com/Eve2512/Strayguard/issues
+Author: Eva Hill
+License-Expression: MIT
+License-File: LICENSE
+Keywords: git,gitignore,hook,jev,pre-commit,typesafe
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.9
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Strayguard
+Catch files that don't belong before you commit them. A git pre-commit hook that asks TypeSafe Jev whether each new file belongs in your repo. It catches scratch scripts, debug dumps, build output and local config before they land. Takes under a second, costs a fraction of a cent, needs no config.
+
+
+### Why
+
+```git add .``` adds everything. Sometimes that includes:
+
+- ```test_fix2.py```, a throwaway script
+- ```debug_output.json```, which you dumped while chasing a bug
+- ```notes-to-self.md```
+- ```data_export.csv``` with real customer rows
+- ```.env.local``` with your own settings
+- a whole ```dist/``` folder
+
+Coding agents make this worse, they create helper scripts and scratch files and often don't clean them up.
+Whatever coding tool you use most likely miss most of these files:
+
+| Tool | Catches | Misses |
+|---|---|---|
+| ```.gitignore``` | Names you listed in advance | Every name you didn't think of |
+| Secret scanners | API keys and tokens | Junk scripts, data dumps, notes |
+| Large-file checks | Big files | Small junk files |
+| **strayguard** | **Files that don't look like part of the project** | Changes to files git already tracks |
+
+
+### How it works
+
+1. You run ```git commit```.
+2. strayguard looks only at files that are **new** in this commit.
+3. A few local rules run first, such as ```.env``` and ```.DS_Store```. Files they match are never sent anywhere.
+4. For the other files, Jev picks one category: **belongs**, **scratch / leftover**, **output dump**, **build output** or **local only**.
+5. If Jev is at least 70% sure a file doesn't belong, strayguard shows it to you.
+6. If everything belongs, you see nothing.
+
+Jev never writes text(not good for that anyways) It only picks a category and returns a probability. The same file always gets the same answer, because strayguard caches the result.
+
+### Install
+
+You need Python 3.9+ and a [TypeSafe API key](https://console.typesafe.ai/keys).
+
+```bash
+pipx install strayguard
+```
+
+Until the first PyPI release, install it from GitHub instead:
+
+```bash
+pipx install git+https://github.com/Eve2512/Strayguard
+```
+
+```bash
+export TYPESAFE_API_KEY=your-key
+```
+
+Then, inside your repo:
+
+```bash
+strayguard install
+```
+
+```text
+✓ strayguard installed in .git/hooks/pre-commit
+```
+
+That's it, there's no config file
+
+
+### With the pre-commit framework
+
+Add this to `.pre-commit-config.yaml`:
+
+```yaml
+repos:
+  - repo: https://github.com/Eve2512/Strayguard
+    rev: v0.1.0
+    hooks:
+      - id: strayguard
+```
+
+The pre-commit framework captures the output of its hooks, so strayguard cannot ask you questions there. It shows the warning and lets the commit through, as described in [GUI clients, CI and coding agents](#gui-clients-ci-and-coding-agents).
+
+
+## What you'll see
+
+### Everything belongs
+
+Nothing, your commit goes through as normal.
+
+```text
+$ git commit -m "add login page"
+[main 4f2a91c] add login page
+ 3 files changed, 120 insertions(+)
+```
+
+### Something looks wrong
+
+```text
+$ git commit -m "add login page"
+
+⚠ strayguard: 2 new files look like they don't belong
+
+  debug_output.json   output dump          87%
+  test_fix2.py        scratch / leftover   91%
+
+  [u] unstage   [g] add to .gitignore   [k] keep and commit   [o] one by one
+  > g
+
+  ✓ Added 2 files to .gitignore and staged .gitignore.
+  ✓ Unstaged 2 files. They are still on your disk.
+
+  Commit stopped so you can check. Run git commit again.
+```
+
+| Key | What it does |
+|---|---|
+| `u` | Takes the files out of this commit. They stay on your disk. |
+| `g` | Adds the files to `.gitignore` so this never happens again, and takes them out of this commit. |
+| `k` | Commits the files anyway. strayguard won't ask about them again. |
+| `o` | Lets you choose `u`, `g` or `k` for each file. |
+| Enter | Same as `k`. |
+
+strayguard **never deletes files**. It stops the commit only if it changed something for you, so you can check before you commit again.
+
+
+### GUI clients, CI and coding agents
+
+strayguard asks you a question only when its output goes straight to your terminal. GUI git clients, CI, coding agents and the pre-commit framework all capture the output, so there strayguard warns and lets the commit through:
+
+```text
+⚠ strayguard: 2 new files may not belong (not blocking)
+
+  debug_output.json   output dump          87%
+  test_fix2.py        scratch / leftover   91%
+
+  To unstage them:
+    git rm --cached -r -- debug_output.json test_fix2.py
+```
+
+To block the commit instead, set `STRAYGUARD_STRICT=1`, this is a good setting for coding-agent sessions.
+
+
+### Files caught by a local rule
+
+These files are never sent to Jev, so they show `rule` instead of a percentage:
+
+```text
+  .env.local           local only           rule
+```
+
+### When strayguard can't reach Jev
+
+It prints one line, still runs its local rules, and lets the commit through:
+
+```text
+strayguard: no TYPESAFE_API_KEY set, so only the local rules ran.
+strayguard: Jev did not answer in 5 s, so only the local rules ran.
+```
+
+## Settings
+
+Everything is optional except the key.
+
+| Variable | Default | What it does |
+|---|---|---|
+| `TYPESAFE_API_KEY` | none | **Required.** Your TypeSafe API key. |
+| `STRAYGUARD=off` | `on` | Skip the check for one commit: `STRAYGUARD=off git commit ...` |
+| `STRAYGUARD_STRICT=1` | `0` | Block the commit when strayguard can't ask you, such as in CI or with agents. |
+| `STRAYGUARD_THRESHOLD` | `0.70` | How sure Jev must be before strayguard warns you. |
+| `STRAYGUARD_MODEL` | `jev-latest` | Pin a version, for example `jev-1.13.0`, to keep answers stable. |
+| `STRAYGUARD_NAMES_ONLY=1` | `0` | Send only file names and sizes, never content. |
+
+You can also skip every hook for one commit with `git commit --no-verify`.
+
+## Privacy
+
+For each **new** text file, strayguard sends TypeSafe its path, its size, its first 40 lines (at most 2,000 characters) and the names of a few tracked files next to it.
+
+It never sends:
+
+- files that a local rule catches, such as `.env` files, keys and certificates
+- binary files, or files larger than 1 MB
+- any content at all when `STRAYGUARD_NAMES_ONLY=1` is set
+
+TypeSafe says it does not train models on customer data. See its [legal page](https://docs.typesafe.ai/legal).
+
+## Cost and speed
+
+- A typical commit costs less than $0.0001.
+- The check usually finishes in under a second.
+- Each file's answer is cached by its content, so running the commit again is instant and free.
+
+## Uninstall
+
+```bash
+strayguard uninstall
+```
+
+This removes the hook only if strayguard wrote it.
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `strayguard install` | Add the pre-commit hook to this repo |
+| `strayguard uninstall` | Remove the hook |
+| `strayguard check` | Run the check on staged new files (the hook runs this) |
+| `strayguard --version` | Show the version |
+
+## Development
+
+Run the unit tests. They use no network and no API key:
+
+```bash
+uv run --no-project --with pytest pytest
+```
+
+GitHub Actions runs the same tests on Python 3.9 to 3.14 for each push to `main` and for each pull request.
+
+## License
+
+MIT. See [LICENSE](https://github.com/Eve2512/Strayguard/blob/main/LICENSE).
+