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

Implements the QA system #32

Merged
merged 7 commits into from
Nov 6, 2023
Merged

Implements the QA system #32

merged 7 commits into from
Nov 6, 2023

Conversation

dalonsoa
Copy link
Collaborator

@dalonsoa dalonsoa commented Nov 4, 2023

It implements pre-commit hooks with the main tooling we normally used, except that we are using ruff instead of flake8 and isort. Configuration for this has been included in the pyproject.toml file. The workflow file has been updated to run the QA as well as all test in several OS and python versions.

A LOT of files appear as modified since running the linters/formatters have modified them, but the functionality remains unchanged. The main files to review are:

  • pyproject.toml
  • ci.yml
  • pre-commit-config.yaml

As the code was not following any specific style, I had to:

@dalonsoa dalonsoa linked an issue Nov 4, 2023 that may be closed by this pull request
- name: Install and build
run: pip install -r requirements-dev.txt
run: python -m pip install -r requirements-dev.txt
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just curious what's the difference between pip install and python -m pip install?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have a look at https://stackoverflow.com/questions/25749621/whats-the-difference-between-pip-install-and-python-m-pip-install

We might not need it in this case, but it is becoming more common practice to ensure consistency.

Copy link
Member

@tsmbland tsmbland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

Copy link

@AdrianDAlessandro AdrianDAlessandro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Sensible to ignore the line lengths and docstrings for now. How did using Ruff for automatically fixing some of the problems go?

@dalonsoa dalonsoa merged commit 199e664 into main Nov 6, 2023
21 checks passed
@dalonsoa dalonsoa deleted the qa branch November 6, 2023 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement QA tooling
3 participants