agentleFS
HermeticOrmusHermeticOrmus/python-conventions-skills/skills/python-conventions/SKILL.md

python-conventions

Skill2 starsChanged 6 months agoMITView on GitHub

Modern Python (3.11+) conventions — type discipline, pathlib, async patterns, structlog, ruff + mypy strict + pytest defaults. Use when writing or reviewing Python code.

7 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 7 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Never time.sleep in async

    line 29
  2. Distinctive:

    No print() in libraries

    line 34

“Common” is measured: kept by at least 6 in 10 of the 7 edited versions of this file we could read. “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
SKILL.md

Python conventions

Modern Python (3.11+) defaults.

Types

  • Type hints required everywhere
  • from __future__ import annotations at top
  • Pydantic v2 for I/O, TypedDict for internal, Literal for string enums

Stdlib

  • pathlib.Path over os.path
  • dataclasses over manual init
  • subprocess.run over os.system
  • f-strings except logging
  • match for tagged unions

Async

  • async def end-to-end, httpx not requests
  • TaskGroup for structured concurrency
  • Never time.sleep in async

Logging

  • structlog or stdlib + structured extras
  • No print() in libraries
  • Lazy formatting

Tooling

  • ruff for lint + format
  • mypy --strict
  • pytest fixtures
  • uv over pip

Banned

  • Bare except
  • Mutable defaults
  • from foo import *
  • eval/exec on user input
  • Stringly-typed returns

Full content + 15 worked examples at https://github.com/HermeticOrmus/python-conventions-skills.

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.