NationalCentreTruthReconciliation / Secure-Record-Transfer

A transfer portal incorporating CAAIS and BagIt Specifications
https://secure-record-transfer.readthedocs.io/en/latest/
4 stars 2 forks source link

Add Linting Configuration #191

Closed danloveg closed 1 month ago

danloveg commented 2 months ago

A linting configuration should be added to the application so that code style is enforced. These changes should be made:

If it's desired later on, we can enforce linting with GitHub actions, but for now there'll be tons of linting issues and fixing them all at once is not recommended.

danloveg commented 1 month ago

That could work, but where would you suggest we publish that file? The Python Development Guide is basically a ruff.toml file and nothing else.

But say we publish it to pypi.org - once it's installed, we would have to tell Ruff where to find the .toml file, which may (or may not?) be different depending on versions of Python or operating system.

Something you could try and test is publishing a package with the TOML file to Test PyPi, and then see where it's pulled in the repo when installed with Poetry.

I 100% agree that pulling the changes manually is tedious.

danloveg commented 1 month ago

Addressed in #202.