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

Move to pyproject.toml approach #16

Merged
merged 22 commits into from
Sep 18, 2024
Merged

Move to pyproject.toml approach #16

merged 22 commits into from
Sep 18, 2024

Conversation

jwallwork23
Copy link
Member

Closes #15.
Closes #13.

The best practice for Python packaging these days is to use a pyproject.toml file rather than setup.py and requirements.txt files. This PR sets that up.

The PR also sets up automatic linting and formatting and applies it across the codebase. (The vast majority of the changes are formatting changes.)

To review this, it is sufficient to check:

  • pyproject.toml
  • .github/workflows/test_warpmesh.yml

@jwallwork23 jwallwork23 added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 14, 2024
@jwallwork23 jwallwork23 self-assigned this Sep 14, 2024
@jwallwork23 jwallwork23 requested a review from erizmr September 14, 2024 11:27
@jwallwork23
Copy link
Member Author

Also dropped some "old" configuration files and "backup" versions of scripts. They are all under version control so multiple versions are unnecessary.

@jwallwork23
Copy link
Member Author

@erizmr Please could you review that you are happy with the following?

  • the pyproject.toml file.
  • the updated test suite test_warpmesh.yml.
  • Dropping configs/configs_old.
  • Dropping warpmesh/generator/swirl_solver_backup.py and warpmesh/generator/swirl_solver_backupbackup.py.

The rest of the changes are just formatting and linting changes.

@jwallwork23
Copy link
Member Author

I tried to put both @erizmr and @chunyang-w down as reviewers but it appears that you can only request one reviewer on a private repo.

Copy link
Collaborator

@erizmr erizmr left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks!

Remove submodules and update installation process
@jwallwork23
Copy link
Member Author

Thanks @erizmr!

@jwallwork23 jwallwork23 merged commit c959b4f into main Sep 18, 2024
1 check passed
@jwallwork23 jwallwork23 deleted the pyproject branch September 18, 2024 12:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cut down requirements Set up linting and automatic formatting
2 participants