statelyai / xstate-python

XState for Python
MIT License
177 stars 18 forks source link

Improve development workflow #33

Closed NixBiks closed 3 years ago

NixBiks commented 3 years ago

I'm considering making a PR that improves the workflow like

  1. adding static type-checker like mypy - you can freely mix static and dynamic typing
  2. a linter flake8
  3. formatters like black and isort
  4. add GitHub Actions, e.g. CodeCoverage
  5. improve dependency management with poetry - might want to skip this since there aren't really any dependencies.
  6. add docs using something like sphinx - or some alternative?

Let me know what you think of the different suggestions - with VS Code Remote Containers in place it is easy to streamline the development environment.

davidkpiano commented 3 years ago

Those suggestions sound great; I'm not strongly opinionated on any; just opinionated on the existence of them (they should exist in the project) 👍