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.4.tar.gz
(4.9 kB
view hashes)
Built Distribution
clean_py-0.4-py3-none-any.whl
(5.4 kB
view hashes)