ci,build: Add flake8, black, isort (and wire into CI) #42

tony · 2022-09-03T19:16:51Z

Requires #41 (pyproject.toml)

Changes

Add [lint] (pip install -e '.[lint]') for flake8, isort, black

This assures that normal packaging isn't bloated, but the dependencies can still be installed by developers
Add 3 lint tools
- flake8: python linting rules
- black: formatting
- isort: import order
Lint configurations

The configurations are stock, except isort and flake8 both have black profiles (docs)
CI
- tests: Add lint tools to test workflow
- tests and pypi upload: actions/setup-python
  - v3 -> v3
  - Add pip cache

See also: https://peps.python.org/pep-0621/

ERROR: pyproject.toml file found. To use a PEP 517 build-backend you are required to configure tox to use an isolated_build: https://tox.readthedocs.io/en/latest/example/package.html

See also: https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#flake8

./tests/test_text_files.py:210:1: W293 blank line contains whitespace ./tests/test_text_files.py:227:1: W293 blank line contains whitespace

See also: https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#isort

…ncies See also: https://github.com/actions/setup-python#caching-packages-dependencies

twmr · 2022-09-04T06:59:41Z

Thx a lot for that! I wanted to add a black/isort CI setup long ago!

tony · 2022-09-04T12:25:14Z

@Thisch This is a nice one!

tony added 3 commits September 3, 2022 13:57

build(deps): Remove setup.py

890f028

build(deps): Add PEP-621 pyproject.toml

e8907d5

See also: https://peps.python.org/pep-0621/

ci(tox): Add isolated_build = true for pyproject.toml support

1f7eebe

ERROR: pyproject.toml file found. To use a PEP 517 build-backend you are required to configure tox to use an isolated_build: https://tox.readthedocs.io/en/latest/example/package.html

tony force-pushed the black-flake8-isort branch 4 times, most recently from 4322934 to 0c10360 Compare September 3, 2022 19:40

tony added 6 commits September 3, 2022 14:41

build(deps): Add lint dependencies (pip install -e '.[lint]')

a5cc669

Add flake8: Ignore virtualenvs

3d45bee

ci(flake8): black compatibility

551f887

See also: https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#flake8

chore: Run black on codebase

fa88bae

chore(flake8): Fix whitespacing

62c0000

./tests/test_text_files.py:210:1: W293 blank line contains whitespace ./tests/test_text_files.py:227:1: W293 blank line contains whitespace

build(isort): Use black profile

17d42cd

See also: https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#isort

tony force-pushed the black-flake8-isort branch from 0c10360 to 4f81f62 Compare September 3, 2022 19:41

tony added 2 commits September 3, 2022 14:48

ci(test): Lint with flake8, black, isort

9fd590c

ci(test,pypi-upload): actions/setup.py v3 -> v4 and cache pip depende…

6b9c2de

…ncies See also: https://github.com/actions/setup-python#caching-packages-dependencies

tony force-pushed the black-flake8-isort branch from 4f81f62 to 6b9c2de Compare September 3, 2022 19:48

Merge branch 'master' into black-flake8-isort

61447bf

twmr merged commit 110a0cd into twmr:master Sep 4, 2022

tony deleted the black-flake8-isort branch September 4, 2022 12:24

tony mentioned this pull request Sep 4, 2022

PEP621 / pyproject.toml for easier optional dependencies #40

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci,build: Add flake8, black, isort (and wire into CI) #42

ci,build: Add flake8, black, isort (and wire into CI) #42

tony commented Sep 3, 2022 •

edited

Loading

twmr commented Sep 4, 2022

tony commented Sep 4, 2022

ci,build: Add flake8, black, isort (and wire into CI) #42

ci,build: Add flake8, black, isort (and wire into CI) #42

Conversation

tony commented Sep 3, 2022 • edited Loading

Changes

twmr commented Sep 4, 2022

tony commented Sep 4, 2022

tony commented Sep 3, 2022 •

edited

Loading