Starting a repo with basic python code best practices

[gonuke]

This PR is not complete but provides a good starting point for many projects today.

Closes #2, Closes #4, Closes #5, Closes #6, Closes #7

[connoramoreno]

Added a thought about including something about custom loggers. Not sure if this is already planned, but we might consider adding a pyproject.toml to this repository as an example. This seems very useful for beginning projects though! Good idea.

[gonuke]

Added a thought about including something about custom loggers. Not sure if this is already planned, but we might consider adding a pyproject.toml to this repository as an example. This seems very useful for beginning projects though! Good idea.

see #3

[MicahGale]

I like hyperlinks.

Side note: only gitlab supports Closes #1, #2, ... GitHub you have to do: closes #1, closes #2...

I fixed that for you.

[MicahGale]

LGTM for a first pass.

[connoramoreno]

It would probably be good to include a reference to PEP8 styling and auto-formatters

[MicahGale]

It would probably be good to include a reference to PEP8 styling and auto-formatters

See #8. I was thinking of tackling this as a separate PR.

[MicahGale]

Is mentioning snake case appropriate?

[gonuke]

I think the list could grow - see our previous discussion about where to put this. I put a few examples, but let's discuss where to keep more details. This PR doesn't have to depend on it - we can make additions/changes later.

[MicahGale]

What's the plan for merging this? Are you thinking after tomorrow's meeting maybe? This is self-serving as I want to merge #11 by early next week.

[gonuke]

What's the plan for merging this? Are you thinking after tomorrow's meeting maybe? This is self-serving as I want to merge #11 by early next week.

I'd be happy to see it merged before tomorrow's meeting

[MicahGale]

Good point. The responsibility of who merges is group specific; I appreciate setting clear rules on that.