Skip to content

Latest commit

 

History

11 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

python-config logo

@sebastienrousseau/python-config

Shareable Python configuration standards providing hardened Ruff, Black, Flake8, and MyPy rules.

Build Status npm package Documentation OpenSSF Scorecard License: Apache-2.0 OR MIT Node >= 20.0.0


Contents

Getting started

Ecosystem

Configuration reference

Operational


Install

Using a package manager

Install @sebastienrousseau/python-config as a development dependency:

# npm
npm install --save-dev @sebastienrousseau/python-config

# pnpm
pnpm add -D @sebastienrousseau/python-config

# yarn
yarn add -D @sebastienrousseau/python-config

# bun
bun add -d @sebastienrousseau/python-config

Build from source

git clone https://github.com/sebastienrousseau/python-config.git
cd python-config
make            # check + test

Requirements

  • Node.js 20.0.0 or newer. Declared in engines.node and proved on every push: the CI matrix runs Node 20, 22, 24 on Linux, macOS and Windows, and fails if the matrix floor and engines.node disagree.
  • npm 9.0.0 or newer (or modern pnpm / yarn / bun).
  • Module systems. Full native support for ECMAScript Modules (ESM) and CommonJS (CJS).
  • Target environment: Optimized for Python 3.12+ / Ruff.

Quick Start

This package ships configuration for a toolchain that does not resolve anything through node_modules. Install it to version and update the presets, then either copy them into place or pass their path to the tool.

Copy the presets into your project

cp node_modules/@sebastienrousseau/python-config/pyproject.toml ./pyproject.toml
cp node_modules/@sebastienrousseau/python-config/ruff.toml ./ruff.toml
cp node_modules/@sebastienrousseau/python-config/.flake8 ./.flake8

Or point the tool at the installed file

ruff check --config node_modules/@sebastienrousseau/python-config/ruff.toml .
flake8 --config node_modules/@sebastienrousseau/python-config/.flake8 .

The configuration ecosystem

@sebastienrousseau/python-config is a focused satellite of the @sebastienrousseau/config suite — a unified ecosystem of single-purpose, zero-overhead developer configurations designed to share a single design philosophy, strict typing, and zero runtime dependencies.

Configuration Target / Purpose Native Standard
@sebastienrousseau/biome-config Rust-powered linting & formatting Biome 1.9+
@sebastienrousseau/browserslist-config Target browser matrix Browserslist 4+
@sebastienrousseau/c-config Modern C23 clang-format and clang-tidy rules Clang 18+ / C23
@sebastienrousseau/c8-config V8 native code coverage thresholds c8 / V8
@sebastienrousseau/commitlint-config Conventional Commits standard Commitlint 19+
@sebastienrousseau/cpp-config Modern C++23 clang-format, tidy & cmake rules Clang 18+ / C++23
@sebastienrousseau/csharp-config C# Roslyn analyzers and OmniSharp rules .NET 8/9 / Roslyn
@sebastienrousseau/dart-config Dart and Flutter analysis_options presets Dart 3.x / Flutter
@sebastienrousseau/docker-config Multi-stage Docker hardening Hadolint / BuildKit
@sebastienrousseau/eslint-config Strict ECMAScript & TypeScript linting ESLint 9+ Flat Config
@sebastienrousseau/go-config Golangci-lint, staticcheck, and revive rules Go 1.22+ / golangci-lint
@sebastienrousseau/java-config Checkstyle, SpotBugs, and PMD rulesets Java 21+ / Checkstyle
@sebastienrousseau/jsdoc-config Structured API documentation generation JSDoc 4+
@sebastienrousseau/knip-config Unused files, exports & dependencies audit Knip 5+
@sebastienrousseau/kotlin-config Official ktlint formatting and Detekt analysis Kotlin 2.0+ / Detekt
@sebastienrousseau/lefthook-config Fast, parallel Git hook automation Lefthook 1.7+
@sebastienrousseau/lua-config Lua 5.4, Neovim LuaCheck and StyLua presets Lua 5.4 / StyLua
@sebastienrousseau/markdownlint-config Markdown document style & structure markdownlint-cli2
@sebastienrousseau/mocha-config BDD testing settings & reporting Mocha 10+
@sebastienrousseau/oxlint-config Sub-millisecond Rust JavaScript linting Oxlint
@sebastienrousseau/php-config PER-CS 2.0, PSR-12 and Level 8 PHPStan PHP 8.3+ / PHPStan
@sebastienrousseau/playwright-config Cross-browser end-to-end testing Playwright 1.40+
@sebastienrousseau/prettier-config Deterministic code formatting Prettier 3+
@sebastienrousseau/python-config Hardened Ruff, Black, Flake8, and MyPy rules Python 3.12+ / Ruff
@sebastienrousseau/r-config Lintr and styler presets for data science R 4.3+ / lintr
@sebastienrousseau/remark-config AST-based markdown verification Remark 13+
@sebastienrousseau/ruby-config RuboCop and StandardRB rules for Ruby 3.3+ Ruby 3.3+ / RuboCop
@sebastienrousseau/rust-config Hardened rustfmt formatting and Clippy lints Rust 2021 / Clippy
@sebastienrousseau/semantic-release-config Tag-driven automated releases & changelogs semantic-release 24+
@sebastienrousseau/shell-config Strict ShellCheck static analysis & shfmt presets POSIX / Bash / ShellCheck
@sebastienrousseau/size-limit-config Performance bundle budget enforcement Size Limit 11+
@sebastienrousseau/sql-config Dialect-aware SQLFluff linting & formatting SQLFluff / ANSI SQL
@sebastienrousseau/stylelint-config Modern CSS & SCSS quality assurance Stylelint 16+
@sebastienrousseau/swift-config Strict SwiftLint rules & SwiftFormat presets Swift 5.10 / SwiftLint
@sebastienrousseau/tailwindcss-config Utility-first design tokens & typography Tailwind CSS 4+
@sebastienrousseau/tsconfig-config Strict type checking & modern module resolution TypeScript 5+
@sebastienrousseau/vitest-config Lightning-fast Vite-native unit testing Vitest 2+
@sebastienrousseau/zig-config Hardened ZLS and build formatting rules Zig 0.13+ / ZLS

To adopt the complete suite with a single import, install the master meta-package:

npm install --save-dev @sebastienrousseau/config

Why this approach?

Configuration rot is one of the most common vectors for project decay. Ad-hoc tool configurations copied between repositories quickly drift, leaving security vulnerabilities unpatched, formatting rules inconsistent, and CI times bloated.

@sebastienrousseau/python-config solves this with three deliberate engineering choices:

  1. Zero Runtime Dependencies: The configuration contains only static, serialisable declarative definitions and clean programmatic adapters.
  2. Dual CJS/ESM Architecture: Ships dedicated CommonJS (index.cjs) and ES Module (index.mjs) entrypoints alongside comprehensive TypeScript declarations (index.d.ts).
  3. Deterministic Governance: Versioned strictly by +0.0.1 per release, cryptographically signed with published PGP keys, and audited continuously.

Hardened Ruff, Black, Flake8 & MyPy Rules

Combines ultra-fast Rust-based Ruff linting and formatting with strict MyPy type checking across Python 3.12+ codebases.

Before (Unstandardized)

# ruff.toml
[lint]
select = ["E", "F"]

After (@sebastienrousseau/python-config Enforced)

# ruff.toml
line-length = 88
target-version = "py312"
[lint]
select = ["E", "F", "W", "I", "B", "C4", "UP", "SIM", "RUF"]
ignore = []

Module Compatibility

This package exports dual module entrypoints via package.json exports:

"exports": {
  ".": {
    "types": "./index.d.ts",
    "import": "./index.mjs",
    "require": "./index.cjs"
  }
}

Full TypeScript declarations (index.d.ts) are included out of the box, providing rich IDE autocomplete and JSDoc documentation inline.


When not to use this configuration

When maintaining legacy Python 2.7 codebases or projects restricted to unmaintained linter forks.


Development

Contributors use a standard POSIX Makefile as the convention-based task runner:

Task Command Purpose
Default gate make Runs full test and lint battery
Unit tests make test Executes native validation test suite
Lints make lint Runs syntax and code quality checks
Clean make clean Removes node_modules and temporary cache
git clone https://github.com/sebastienrousseau/python-config.git
cd python-config
make test

Security

  • Private Reporting: Report security vulnerabilities by emailing sebastian.rousseau@gmail.com. Expect an initial response within 48 hours and a mitigation plan within 7 days.
  • Commit Integrity: All commits on main and release tags are cryptographically signed.
  • Release Signing Key: The release-signing PGP key is published in KEYS.asc.
  • Supply Chain: Monitored continuously via Dependabot, CodeQL, and SLSA provenance. See SECURITY.md for details.
4B7F16C909C7A8EE9BED338A4F047EDF5F90F638

Signing key Sebastien Rousseau <sebastian.rousseau@gmail.com>, ed25519, expires 2028-08-16.


Documentation

  • Architecture — Architectural design, directory structure, and invariants.
  • Development Guide — Toolchain prerequisites, task reproduction, and CI gates.
  • Governance — Maintainer-led project model and decision-making framework.
  • Support Guide — Channels for help, bug reports, and feature requests.
  • Ecosystem Suite — The @sebastienrousseau/config family repository.

Stability guarantees

  • SemVer Discipline: Versioning increments strictly by +0.0.1 following the repository lifecycle standard.
  • Output Stability: A rule change that alters linting or formatting output in consumer code is treated as a notable breaking event, clearly documented in CHANGELOG.md.
  • Deprecation Window: Deprecated options or configurations remain supported for at least two release cycles before removal.

Minimum-toolchain policy

The minimum supported Node.js version is 20.0.0. The floor may raise only when:

  1. An upstream LTS version reaches official End-of-Life (EOL).
  2. The reason is explicitly recorded in CHANGELOG.md and DEVELOPMENT.md.

License

Dual-licensed under either:

at your option.

SPDX-License-Identifier: Apache-2.0 OR MIT

About

Shareable Python configuration standards providing hardened Ruff, Black, Flake8, and MyPy rules.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages