Skip to main content

A script to analyze and clean Python files

Project description

pystreamliner

Automatically clean up messy Python files — without breaking anything.

pystreamliner uses Python's AST (abstract syntax tree) to safely detect and fix common code issues. It operates on two tiers: things it can fix automatically with zero risk, and things it flags for you to review manually.


What it does

Auto-fixes (Tier 1 — applied immediately):

  • Removes unused imports, or trims partially unused from x import y statements
  • Removes consecutive duplicate lines
  • Caps excessive blank lines

Warnings (Tier 2 — reported, never auto-changed):

  • Unused variables
  • Unused top-level functions
  • Vague variable names (x, tmp, foo, bar, etc.)

pystreamliner never touches code it isn't certain about. If there's any doubt, it warns you instead.


Install

git clone https://github.com/Supe232323/PyStreamliner.git
cd PyStreamliner

No dependencies. Runs on Python 3.10+.


Usage

python streamliner.py your_file.py

This will:

  1. Analyze your_file.py
  2. Write the cleaned version in-place
  3. Print a full report of what was changed and what needs manual review
  4. Show a diff of every modification

Preview changes without modifying anything:

python streamliner.py --dry-run your_file.py

Example output

══════════════════════════════════════════
  PyStreamliner Report
══════════════════════════════════════════
  File:                        main.py
  Lines analyzed:                   312

  Auto-fixes applied:
    Unused imports removed:           3
    Duplicate lines removed:          1
    Blank lines reduced:              2

  Warnings (manual review needed):
    Unused variables detected:        2
    Unused functions detected:        1
    Vague variable names:             1
──────────────────────────────────────────

  Unused imports removed:
    • line 4:  import os
    • line 5:  import sys
    • line 7:  from pathlib import Path, PurePath  (partially cleaned: kept 'Path')

  Unused variables:
    ⚠ line 42:  result
    ⚠ line 87:  temp_val

  Vague variable names:
    ⚠ line 23:  tmp
══════════════════════════════════════════

Why not just use Black / isort / autoflake?

Those are great tools and pystreamliner doesn't replace them. The difference:

  • Black formats style. pystreamliner removes dead code.
  • autoflake removes unused imports but doesn't warn about unused variables, vague names, or dead functions.
  • pystreamliner combines lightweight static analysis with conservative auto-fixing and a human-readable report — in a single file with zero dependencies.

Contributing

See CONTRIBUTING.md.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pystreamliner-1.12.1.tar.gz (2.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pystreamliner-1.12.1-py3-none-any.whl (2.6 kB view details)

Uploaded Python 3

File details

Details for the file pystreamliner-1.12.1.tar.gz.

File metadata

  • Download URL: pystreamliner-1.12.1.tar.gz
  • Upload date:
  • Size: 2.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pystreamliner-1.12.1.tar.gz
Algorithm Hash digest
SHA256 6fdcdcaae95df4e0e3d725049e4b2a2c920b9816ffc85ded8206a0a3c0d4a504
MD5 801080b2e2721e9bea9502edc6067b16
BLAKE2b-256 53018ae53533b417cfb03dad14e28276c0909dac57a2f14fe50556a2264d0ae5

See more details on using hashes here.

Provenance

The following attestation bundles were made for pystreamliner-1.12.1.tar.gz:

Publisher: main.yml on Supe232323/pystreamliner

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pystreamliner-1.12.1-py3-none-any.whl.

File metadata

  • Download URL: pystreamliner-1.12.1-py3-none-any.whl
  • Upload date:
  • Size: 2.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pystreamliner-1.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9ae9e34577da2012ae68b300c2e62a41c3eee963e1db6564f4a1ff7d0676d062
MD5 bc78686697f6f256f6779658aa207d2a
BLAKE2b-256 4ee6de20ba3584378583f54f161962d81a521d5b0c2f9d0640e7419ca2dbcdcf

See more details on using hashes here.

Provenance

The following attestation bundles were made for pystreamliner-1.12.1-py3-none-any.whl:

Publisher: main.yml on Supe232323/pystreamliner

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page