Nox Sessions #175
Merged
Nox Sessions #175
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
- added `noxfile.py` to automate linting, testing, coverage, and doc building - moved `requirements/core.txt` to `requirements.txt` - update optional-dependencies within `pyproject.toml` to decompose dev dependency group - added `compile_readme_and_arrange_docs.py` to sphinx `Makefile` - added pypandoc as dependency to make pandoc python package installable - edited `compile_readme_and_arrange_docs.py` and `sphinx/Makefile` to use pypandoc - added `docs/pandoc` where pypandoc install pandoc to `.gitignore` - added pandoc pathing variables to `sphinx/conf.py`
- Updated Issue and PR templates
- Updated `CONTRIBUTING.md` to latest recommended usage
- Linting changes
- Added `.coveragerc` to configure coverage report
- Added `pytest` options to `pyproject.toml`
- Added filter warnings to pytest options.
- Modified `tabulation.py` for `DeprecationWarning` with use of `.drop()`
- Future TODO: add version bump nox session
- Future TODO: use nox in GH actions?
- Future TODO: increase coverage to 95%+.
- Update `CONTRIBUTING.MD`, `PULL_REQUEST_TEMPLATE.md` ,and `.coveragerc` to reflect this requirement.
- removed `MIN_COVERAGE_PERC` within `noxfile.py`
GregoryPetrochenkov-NOAA
approved these changes
Dec 29, 2023
|
|
||
|
|
||
| ''' | ||
| @nox.session(python=LINTING_VERSION, tags=["linting"]) |
There was a problem hiding this comment.
Is there a reason to leave in this commented function?
There was a problem hiding this comment.
I went ahead and added a comment noting this code block as a PLACEHOLDER for future work.
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.
This PR implements nox sessions to automate pre-commit hooks (linting), tests, coverage, and doc building. It closes #172.
Additions
.coveragercto configure coverage reportpytestoptions topyproject.tomlas to just usepytestto run memray, coverage, etcnoxfile.pyto automate linting, testing, coverage, and doc buildingcompile_readme_and_arrange_docs.pyto sphinxMakefiledocs/pandocwhere pypandoc install pandoc to.gitignoresphinx/conf.pyRemovals
Changes
compile_readme_and_arrange_docs.pyandsphinx/Makefileto use pypandocrequirements/core.txttorequirements.txtpyproject.tomlto decompose dev dependency groupCONTRIBUTING.mdto latest recommended usagetabulation.pyforDeprecationWarningwith use of.drop()MIN_COVERAGE_PERC = 5due to nox and gh actions coverage issueTesting
Todos
pyrightstatic type check (or similiar) to project. Then a nox sesssion and updateCONTRIBUTING.MD.setup.cfgcontents topyproject.toml. Consolidate any other configurations topyproject.toml.config.pyis needed or if it can moved withinsrc/gvalto be used elsewhere.sphinx/conf.pyordocs/compile_readme_and_arrange_docs.py.coveragercto 90-95 once completeChecklist