vincentarelbundock / pycountrycode

GNU General Public License v3.0
3 stars 3 forks source link

Issue/1 add workflows #2

Closed frank113 closed 1 year ago

frank113 commented 1 year ago

Summary

This PR addresses issue #1 by adding discrete linting and testing steps. The main.yml script is structured in a way that other steps can be added as needed.

Example of action summary: https://github.com/frank113/pycountrycode/actions/runs/5428515778

Issues Addressed

Changes Made

  1. Add flake8, black and isort to dependencies
  2. Update poetry.lock in accordance with updated pyproject.toml dependencies
  3. Update source code to pass linting and formatting checks
  4. Ignore flake8 E251 rule in replace_regex helper function
  5. Create lint.yml job to be used in the composite main.yml job
  6. Employed a matrix-based approach (looping through hyper parameters such as python-version) to testing in test.yml.
  7. Create a main.yml script that performs lint checks then tests the code

Considerations

Other

Looking forward to working on this package!

vincentarelbundock commented 1 year ago

This is absolutely fantastic! Thanks so much for your time and efforts, @frank113 !

Also, I'll copy a lot of this to my {marginaleffects} package port, so this is a 2-for-1 contribution :)