Development installation/contributing docs updates #1643
Merged
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
aldenks
commented
Jan 31, 2024
| $ git clone --recursive https://github.com/zarr-developers/zarr-python.git | ||
| $ cd zarr-python | ||
| $ python -m pip install -e . | ||
|
|
There was a problem hiding this comment.
This snippet was missing the pip install for dev requirements files. I realized the contributing.rst docs were much more complete and I propose just linking to those so theres a single source of truth
|
@aldenks - I wanted to also call out that @rabernat and others recently created this readme for v3 development: https://github.com/zarr-developers/zarr-python/blob/v3/README-v3.md |
jhamman
approved these changes
Apr 8, 2024
d-v-b
pushed a commit
to d-v-b/zarr-python
that referenced
this pull request
Apr 10, 2024
…ntributing.rst (zarr-developers#1643) Co-authored-by: Joe Hamman <joe@earthmover.io>
d-v-b
added a commit
that referenced
this pull request
Apr 22, 2024
* chore: add deprecation warnings to v3 classes / functions * Resolve Mypy erorrs in `v3` branch (#1692) * refactor(v3): Using appropriate types * fix(v3): Typing fixes + minor code fixes * fix(v3): _sync_iter works with coroutines * docs(v3/store/core.py): clearer comment * fix(metadata.py): Use Any outside TYPE_CHECKING for Pydantic * fix(zarr/v3): correct zarr format + remove unused method * fix(v3/store/core.py): Potential suggestion on handling str store_like * refactor(zarr/v3): Add more typing * ci(.pre-commit-config.yaml): zarr v3 mypy checks turned on in pre-commit * Specify hatch envs using GitHub actions matrix for v3 tests (#1728) * Specify v3 hatch envs using GitHub actions matrix * Update .github/workflows/test-v3.yml Co-authored-by: Joe Hamman <jhamman1@gmail.com> * Update .github/workflows/test-v3.yml Co-authored-by: Joe Hamman <jhamman1@gmail.com> * test on 3.12 too * no 3.12 --------- Co-authored-by: Joe Hamman <jhamman1@gmail.com> Co-authored-by: Joe Hamman <joe@earthmover.io> * black -> ruff format + cleanup (#1639) * black -> ruff + cleanup * format * Preserve git blame * pre-commit fix * Remove outdated dev install docs from installation.rst and link to contributing.rst (#1643) Co-authored-by: Joe Hamman <joe@earthmover.io> * chore: remove old v3 implementation * chore: remove more version-conditional logic * chore: remove v3_storage_transformers.py again --------- Co-authored-by: Daniel Jahn (dahn) <dahnjahn@gmail.com> Co-authored-by: Max Jones <14077947+maxrjones@users.noreply.github.com> Co-authored-by: Joe Hamman <jhamman1@gmail.com> Co-authored-by: Joe Hamman <joe@earthmover.io> Co-authored-by: Saransh Chopra <saransh0701@gmail.com> Co-authored-by: Alden Keefe Sampson <aldenkeefesampson@gmail.com>
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.
As I'm getting up to speed on development I'll update this PR with any polish/smoothing on documentation I run into.
Per @d-v-b's suggestion I'll also be keeping track of pain points and see if there's ways to improve them via the new hatch setup.