initialize structure of repository with tests, formatter #13
Conversation
This file contains hidden or 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
agoscinski
force-pushed
the
init-repo
branch
4 times, most recently
from
b12c52e to
b35576c
Compare
Using for testing, formatting, linting defaults from hatch. Set up simple CI that checks tests and formatting. Changed README to rst because built system cannot interpret org files. Set up simple sphinx documentation structure that includes the README install section. Updated README with usage of basic developer tools.
agoscinski
commented
Aug 15, 2024
DropD
reviewed
Sep 16, 2024
Co-authored-by: Rico Haeuselmann <[email protected]>
agoscinski
commented
Sep 17, 2024
agoscinski
force-pushed
the
init-repo
branch
from
0302111 to
5bed5e4
Compare
…change python versions to github context everywhere
agoscinski
commented
Sep 18, 2024
leclairm
requested changes
Sep 18, 2024
| authors = [ | ||
| {name = 'Matthieu Leclair', email = '[email protected]'}, | ||
| {name = 'Julian Geiger', email = '[email protected]'}, | ||
| {name = 'Alexander Goscinski', email = '[email protected]'}, |
There was a problem hiding this comment.
{name = 'Rico Haüselmann', email = '[email protected]' },There was a problem hiding this comment.
Suggested change
| {name = 'Alexander Goscinski', email = '[email protected]'}, | |
| {name = 'Alexander Goscinski', email = '[email protected]'}, | |
| {name = 'Rico Haüselmann', email = '[email protected]' }, |
| dynamic = ["version"] | ||
| description = 'WcFlow a library for creating weather and climate workflows.' | ||
| authors = [ | ||
| {name = 'Matthieu Leclair', email = '[email protected]'}, |
There was a problem hiding this comment.
[email protected] (trying to switch all my email addresses to this one)
There was a problem hiding this comment.
Suggested change
| {name = 'Matthieu Leclair', email = 'matthieu.leclair@env.ethz.ch'}, | |
| {name = 'Matthieu Leclair', email = 'matthieu.leclair@c2sm.ethz.ch'}, |
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.
Initialized the repo based on
hatchfor testing, formatting, linting, environment management, and as building system. We are using mostlyhatchdefaults to not make complicatedpyproject.tomlso it is easier to maintain which are ruff as formatter and linter and pytest for tests. For the documentation I set up sphinx. The idea would be use sphinx with MyST so it is easier to maintain as we can just write markdown files. Because hatch cannot interpret theorgfile I changed the README file torst, since we can integrate it better with the sphinx docs. Added basic developer information about developer tools to the README.TODOs/Issues:
But then it only gets active after this PR is merged, so might change this in a future PR