Update README with hatch based instructions #86

Closed

adina wants to merge 2 commits from readme into main

pull from: readme

merge into: inm7:main

inm7:main

inm7:contr

inm7:grant

inm7:contribute

inm7:make-invalid

inm7:make-invalid-wildcard

inm7:author

inm7:contrib

inm7:test-file-upload

inm7:short-link

inm7:studyact

inm7:reorder

Conversation 3 Commits 2 Files changed 1 +28 -4

adina commented 2025-07-23 13:55:33 +00:00

Owner

Copy link

I took a look at this repo with a contribution mindset for the first time, and the README felt as if it was not reflecting the most up to date state. This PR is a guestimate of what would be the way to do different things with this project, mostly based on the keys in pyproject.toml and the commands ran within the forgejo workflows.

I took a look at this repo with a contribution mindset for the first time, and the README felt as if it was not reflecting the most up to date state. This PR is a guestimate of what would be the way to do different things with this project, mostly based on the keys in ``pyproject.toml`` and the commands ran within the forgejo workflows.

adina added 1 commit 2025-07-23 13:55:33 +00:00

Update README with hatch based instructions 4fd82c66fd

msz approved these changes 2025-07-28 10:07:37 +00:00

msz left a comment

Owner

Copy link

The hatch commands work for me (not sure if the docs build works 100% right, but that's a separate issue), so I think this is an improvement.

Nb., hatch env show indicates that one can also check:examples in addition to check:models, but the README probably does not need to list all scripts.

The hatch commands work for me (~not sure if the docs build works 100% right, but that's a separate issue~), so I think this is an improvement. Nb., `hatch env show` indicates that one can also `check:examples` in addition to `check:models`, but the README probably does not need to list all scripts.

adina commented 2025-07-28 12:00:47 +00:00

Author

Owner

Copy link

thanks! I'll add a few more things I discovered along the way momentarily, thought

thanks! I'll add a few more things I discovered along the way momentarily, thought

adina added 1 commit 2025-07-28 12:06:44 +00:00

add hints how to run specific validation or model checks in hatch shell a85b43c1f3

adina referenced this pull request 2025-07-29 08:07:58 +00:00

Start a Contributing guide #88

adina commented 2025-07-29 08:42:04 +00:00

Author

Owner

Copy link

I will close this PR in favor of #88

I will close this PR in favor of #88

adina closed this pull request 2025-07-29 08:42:04 +00:00

All checks were successful

Hide all checks

Codespell / Check for spelling errors (pull_request) Successful in 22s

Details

Validate examples and verify unmodified conversion / lint (pull_request) Successful in 2m48s

Details

Model checks / lint (pull_request) Successful in 1m28s

Details

Pull request closed

Please reopen this pull request to perform a merge.

Sign in to join this conversation.

Reviewers

No reviewers

msz

Labels

Clear labels   

bug

Something isn't working

  

documentation

Improvements or additions to documentation

  

duplicate

This issue or pull request already exists

  

enhancement

New feature or request

  

good first issue

Good for newcomers

  

help wanted

Extra attention is needed

  

invalid

This doesn't seem right

  

question

Further information is requested

  

wontfix

This will not be worked on

No labels

bug

documentation

duplicate

enhancement

good first issue

help wanted

invalid

question

wontfix

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

2 participants

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

inm7/inm7-concepts!86

No description provided.