search

cjcodeproj / medialibrary

Python code to read XML media files
MIT License
2 stars 0 forks source link

Code styling updates (PEP8, PEP257) #44

Open cjcodeproj opened 2 years ago

cjcodeproj commented 2 years ago

Right now I'm using pycodestyle and pylint to enforce style consistency across the code-base, with minor exceptions declared at the source file level.

I should look into additional tools like pydocstyle, flake8, and maybe black to do more style checking. I should also look into pyproject.toml integrations, because when the project started the configurations were pretty lacking.

Caveats:

  1. I don't want automatic corrections, so black is probably out.
  2. These will be gradual changes across the code-base, so this ticket won't be closed immediately.
cjcodeproj commented 1 year ago

Update:

  1. Black is probably a non-starter. There was some weird convention where it insists on changing single-quoted strings to double-quoted strings, despite style conventions that recommend the practice.