Skip to main content

No project description provided

Project description

Clean Py

Overview

A small CLI program designed to automatically lint .ipynb and .py source code. Tidy and remove redundant imports (via autoflake), sort imports (via isort), lint and format source code in a standardised way (via black). Additionally, clear all .ipynb cell outputs and execution counts. Forked from KwatMe's orginal repo.

Install

Via pip:

pip install clean-py

Or clone directly:

git clone https://github.com/samhardyhey/clean_py
cd clean_py
pip install .

Usage

Clean a single file:

clean_py a_single_notebook.ipynb
clean_py a_single_script.py

Or recurse within a input dir:

clean_py <input_dir>

Clean with specific features if necessary:

clean_py <input_dir> -py True -isort True -black False -autoflake False

Tests

Simple pytesting via:

pytest

Multi-venv tox testing via:

tox

Dist

  • Update version within setup.py
  • Create dist .whl and .tar archives via:
python setup.py sdist bdist_wheel

Push to main pypi repo via:

twine upload dist/*

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

clean_py-0.5.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

clean_py-0.5-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

Details for the file clean_py-0.5.tar.gz.

File metadata

  • Download URL: clean_py-0.5.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for clean_py-0.5.tar.gz
Algorithm Hash digest
SHA256 d70201a04f455114763c4714ebf322703586f6f5830da7203e2bff4db6027319
MD5 66f459e3648fa4daac8afd937e9aa0d5
BLAKE2b-256 7ab70dc1883bf2912b154b00383a43ac1925950b8a5076ffe9d08162f3568df7

See more details on using hashes here.

File details

Details for the file clean_py-0.5-py3-none-any.whl.

File metadata

  • Download URL: clean_py-0.5-py3-none-any.whl
  • Upload date:
  • Size: 5.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for clean_py-0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 af8dae559d852a05bb528cd311806e2c6823bda404fe6d5780d069df4e599a20
MD5 f9672b3b4053e8cc26e70530791093b2
BLAKE2b-256 c872b3ba5a2026bd9ad98ccda73f412e3ebac763443ed40dda41041da4ab5ed4

See more details on using hashes here.

Supported by

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