Update dotfiles #190
Closed
Update dotfiles #190
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- updated pyproject.toml to properly store package data and configuration options - moved tools from setup.cfg to pyproject.toml where possible - replaced setup.py with minimal version - added tests/requirements.txt for easy installation of packages required to test coxeter - added dynamic reading of doc build and test packages from requirements.txt files - updated README.rst with proper install directions for requirements
Codecov Report
@@ Coverage Diff @@
## master #190 +/- ##
==========================================
- Coverage 54.78% 54.76% -0.03%
==========================================
Files 26 25 -1
Lines 2621 2593 -28
==========================================
- Hits 1436 1420 -16
+ Misses 1185 1173 -12
|
|
This PR has been split into the appropriate separate pull requests. I will be closing this branch for now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note: this PR will be split into a number of more focused pull requests.
OUTSTANDING QUESTIONS / TODOs
Should I set up GitHub actions in this PR? Or should that be broken into a separate pull request.- I think it makes sense to do this in a separate PRDescription
This change aims to bring the coxeter dot files up to spec with PEP621. A few fixes are made regarding the proper operation of bumpversion, and deprecated pre-commit hooks are added.
Changed and Added
setup.pyandsetup.cfgtopyproject.toml1requirements.txtto tests folder to allow for dynamic install of required modules 2.bumpversion.cfg. bumpversion should now work by default, with no further configuration..DS_Storefiles, plus configuration files for a few common IDEs and codecov/coverageFixed
requirements.txtREADME.rstto properly comply with PEP621. Previous documentation does not work due to thesetup.py installdeprecation--nqba-mutateflag from pre-commit hooksdoc/requirements.txtto install the proper sphinx version and theme1 flake8 configuration cannot be achieved in a pyproject.toml without additional tools. For this reason, the setup.cfg remains.
2 Setting up the requirements in this manner allows for a GitHub direct download of hbf/miniball, which could help address #179 in the future.
Motivation and Context
I plan to migrate coxeter from CircleCI to Github Actions to bring it into line with other glotzerlab packages. This will also speed up test runs, and will allow for more flexibility with future automations if desired.
Types of Changes
3The change breaks (or has the potential to break) existing functionality.
Checklist: