feat: Updated Package Structure and Developer Tools

[cdcore09]

The purpose of this PR is to update the package structure to modern Python development standards and add developer tools. These changes should allow the package to be more sustainable and extensible while encouraging more open source contribution over time.

Features

Package Structure

• Pre-commit (including Black, Ruff, Pylint, Codespell and Prettier support)
• Pyproject.toml + hatchling for modern Python installation instructions
• Added a Requirements.txt
• Framework for JupyterBook deployment
• CI to ensure pkg compatibility using...
  • Python: 3.8 to 3.11
  • Windows, Mac, and Linux OS
• Dependabot to update GitHub Action dependencies
• Community Health files

Developer Tools

• Codespaces support (devcontainer.json with postBuild.sh support)
• Auto-building Docker image (from Dockerfile)
• Conda environment (environment.yml)
• Added __init__.py files for local package importing
• Nox framework to enable CLI testing of multiple Python versions

[kapilt]

Umm.. may not appropriate here

[cdcore09]

Gotcha @kapilt! I can remove the .devcontainer. I had added it because it makes open source contribution and trying out the package easier and faster.

[cdcore09]

In addition, if you would like me to keep the devcontainer but adjust the Docker image, I can create an auto-building Docker image in your org, so you don't have to reference my organization.

[kapilt]

Clarifying, this is a drive my comment, I’m not a maintainer on this repo.

…

On Fri, May 17, 2024 at 5:26 PM Cordero Core ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In .devcontainer/devcontainer.json <#20 (comment)>: > @@ -0,0 +1,14 @@ +// For format details, see https://aka.ms/devcontainer.json. For config options, see the +{ + "image": "ghcr.io/swarm-io-internal/docker:latest", In addition, if you would like me to keep the devcontainer but adjust the Docker image, I can create an auto-building Docker image in your org, so you don't have to reference my organization. — Reply to this email directly, view it on GitHub <#20 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAFJERQGFZMHNU3QC7LTI3ZCZYYTAVCNFSM6AAAAABGP7KXXSVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDANRUGQYTMNZYGA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[cdcore09]

Oh okay! Would you recommend that I just remove the Codespaces functionality?

[kapilt]

Either that or reference a public image

…

On Fri, May 17, 2024 at 5:58 PM Cordero Core ***@***.***> wrote: Oh okay! Would you recommend that I just remove the Codespaces functionality? — Reply to this email directly, view it on GitHub <#20 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAFJEWL7R7M3AHRE3IAIC3ZCZ4QNAVCNFSM6AAAAABGP7KXXSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMJYGQZDQNZSGY> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[cdcore09]

Done.

[vprelovac]

Thank you @uwcdc and @kapilt

This is a pretty large PR that is hard to review so trying to find some time to do it.

[cdcore09]

@vprelovac definitely understandable. A lot of the changes are just updating to modern packaging standards. I also added in some framework, so you can create a readthedocs (JupyterBook) implementation for rendering the documentation. The Codespaces is for more convenient package testing and contribution. I hope that helps. If you have any questions, feel free to reach out to me anytime.