agentleFS
Sign inStart free
apacheapache/streampipes/streampipes-client-python/AGENTS.md

streampipes / streampipes-client-python

AGENTS.md756 starsChanged 52 days agoApache-2.0View on GitHub

Applies to streampipes-client-python/. Root AGENTS.md applies for repository-wide rules; the Java/Maven build commands there do not apply here. - Poetry manages the environment: poetry install --with dev (add docs,stubs,deployment for everything). Install the hook once: poetry run pre-commit install (.pre-commit-config.yaml). - Python 3.8 compatibility is enforced (pyupgrade --py38). - flake8 with --max-line-length 120; black with line-length = 120 (pyproject.toml). - mypy on streampipes and tests ([tool.mypy] in pyproject.toml). - pytest --cov=streampipes --cov-fail-under=90 — coverage below 90 % fails the build.…

We split this AGENTS.md into the rules it gives an agent

2 rules. About 0 are common, 1 is distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Write unit tests alongside the change.

    line 33
  2. Very specific:

    Every .py file carries the ASF license header.

    line 34

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

AGENTS Guide (Python Client)

Scope

Applies to streampipes-client-python/. Root AGENTS.md applies for repository-wide rules; the Java/Maven build commands there do not apply here.

Toolchain

  • Poetry manages the environment: poetry install --with dev (add docs,stubs,deployment for everything). Install the hook once: poetry run pre-commit install (.pre-commit-config.yaml).
  • Python 3.8 compatibility is enforced (pyupgrade --py38).

Gates (all enforced in CI and by the pre-commit hook)

make check          # = make mypy + make lint + make unit-tests
make reformat-all   # pyupgrade, autoflake, isort, black — run before committing
  • flake8 with --max-line-length 120; black with line-length = 120 (pyproject.toml).
  • mypy on streampipes and tests ([tool.mypy] in pyproject.toml).
  • pytest --cov=streampipes --cov-fail-under=90 — coverage below 90 % fails the build.
  • interrogate requires 100 % docstring coverage (fail-under = 100); every public module, class and function needs a docstring.

Conventions (from DEVELOPMENT.md)

  • numpy-style docstrings; the mkdocs site (make doc, make livedoc) is generated from them.
  • Mirror the Java client's API (streampipes-client/.../StreamPipesClient.java) so the clients stay consistent.
  • Write unit tests alongside the change; the 90 % gate is per run, not per file.
  • Every .py file carries the ASF license header.

Layout

  • streampipes/ — package source; tests/ — unit tests; docs/ + mkdocs.yml — site.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free