Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve code quality using common tools #368

Closed
khaeru opened this issue Sep 14, 2020 · 0 comments
Closed

Improve code quality using common tools #368

khaeru opened this issue Sep 14, 2020 · 0 comments
Assignees
Labels
ci Continuous integration docs Documentation, tutorials, etc. enh New features & functionality
Milestone

Comments

@khaeru
Copy link
Member

khaeru commented Sep 14, 2020

Following the example of other high-quality scientific Python packages like xarray and sdmx1, we should use some common tools to ensure that existing & new code is uniform and high-quality:

  • black for code style.
  • isort for sorting imports.
  • mypy for static type checking.

Configuration & integration in CI (.github/workflows/lint.yaml) can be copied from those other projects.

At the same time, we could:

Parallel to iiasa/message_ix#397.

@khaeru khaeru added enh New features & functionality docs Documentation, tutorials, etc. ci Continuous integration labels Sep 14, 2020
@khaeru khaeru added this to the 3.2 milestone Sep 14, 2020
@khaeru khaeru self-assigned this Sep 17, 2020
@khaeru khaeru closed this as completed Nov 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Continuous integration docs Documentation, tutorials, etc. enh New features & functionality
Projects
None yet
Development

No branches or pull requests

1 participant