Add black and isort across the repo

[ntjohnson1]

An initial follow up to #54 to run autoformatting to bundle some churn together.
Run black and isort then enforce them for automated testing.

[dmdunla]

@ntjohnson1 Can you document the steps for manually running black and isort (and anything else for formatting you’re working on)? I know you’re moving toward an automated solution, but please document the steps. Either in the dev doc discussion or in a dev readme.

[nick-cerebras]

Ya. I can probably put together a quick contributing guide with some notes then we can iterate on that. As for how to run black and isort. We probably have a few options (can do all of them): add a make target, add a precommot hook, or just documenting that it will be enforced with how to run it manually. I would probably defer to what's easiest for your workflow to start.

The instructions for most of these is just to run the tool from root since the pyproject has the config. I started with black and isort since they just do the fix. For pylint and mypy they'll highlight if there is a bug that needs manual intervention.

Isort pyttb/ tests/
black pyttb/ tests/

[dmdunla]

Cool thanks! I like the idea of a pre-commit hook, but dev docs for manually running the formatting would be good to have on hand.

…

________________________________ From: Nick Johnson ***@***.***> Sent: Friday, February 24, 2023 6:27:37 PM To: sandialabs/pyttb ***@***.***> Cc: Dunlavy, Daniel M ***@***.***>; Comment ***@***.***> Subject: [EXTERNAL] Re: [sandialabs/pyttb] Add black and isort across the repo (Issue #59) Ya. I can probably put together a quick contributing guide with some notes then we can iterate on that. As for how to run black and isort. We probably have a few options (can do all of them): add a make target, add a precommot hook, or just documenting that it will be enforced with how to run it manually. I would probably defer to what's easiest for your workflow to start. The instructions for most of these is just to run the tool from root since the pyproject has the config. I started with black and isort since they just do the fix. For pylint and mypy they'll highlight if there is a bug that needs manual intervention. Isort pyttb/ tests/ black pyttb/ tests/ — Reply to this email directly, view it on GitHub<https://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fsandialabs%2Fpyttb%2Fissues%2F59%23issuecomment-1444871510&data=05%7C01%7Cdmdunla%40sandia.gov%7C7941e1de4f8a4813d80f08db16cf7d0b%7C7ccb5a20a303498cb0c129007381b574%7C1%7C0%7C638128852637426811%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=WCK3uy9q%2BDGeuBPCnnViNsarehdqZZMKikyNgAFglvg%3D&reserved=0>, or unsubscribe<https://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAHIY2IQAU6HYRD7EOJ3SY3LWZFNYTANCNFSM6AAAAAAVHPFLNY&data=05%7C01%7Cdmdunla%40sandia.gov%7C7941e1de4f8a4813d80f08db16cf7d0b%7C7ccb5a20a303498cb0c129007381b574%7C1%7C0%7C638128852637426811%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=aK4wLM8eqU%2F4NeAffW0gsS1B6WdTgFDIqzhVZU%2FpCl0%3D&reserved=0>. You are receiving this because you commented.Message ID: ***@***.***>

[ntjohnson1]

I added the dev doc to the open PR for now. The workflow is pretty simple so I punted on the pre-commit hook. It should be fairly simple to setup pip install pre-commit then add a yml file for configuring it (both isort and black have copy paste for it). I just saw on a quick google that sometime pycharm doesn't play nice with pre-commit so didn't have the motivation to verify it today.