Fix: use hatch for workflow #178

lwasser · 2024-01-29T23:21:07Z

This is what the intro looks like fully committing to hatch. Setting up that config.toml file for default hatch settings is important as a starting point.

To see the specific tasks where the Asana app for GitHub is being used, see below:
- https://app.asana.com/0/0/1206595156181300

JacksonBurns

This is a great tutorial! I just have some small mainly grammar things and a comment or two.

JacksonBurns · 2024-01-30T15:10:05Z

package-structure-code/python-package-build-tools.md

 Dependency management|✖| Currently you have to add dependencies manually with Hatch. However a feature to support dependencies management may be added in a future release.
 Environment Management |✅ | Hatch supports Python virtual environments. If you wish to use other types of environments such as Conda, you will need to [install a plugin such as hatch-conda for conda support](https://github.com/OldGrumpyViking/hatch-conda).
 Publish to PyPI and test PyPI|✅|Hatch supports publishing to both test PyPI and PyPI
 Version Control based versioning|✅ | Hatch offers `hatch_vcs` which is a plugin that uses setuptools_scm to support versioning using git tags. The workflow with `hatch_vcs` is the same as that with `setuptools_scm`.
 Version bumping| ✅ | Hatch supports you bumping the version of your package using standard semantic version terms patch; minor; major
 Follows current packaging standards|✅|Hatch supports current packaging standards for adding metadata to the **pyproject.toml** file.
-Install your package in editable mode|✖✅| You can install your package in editable mode using `pip install -e .` Hatch mentions [editable installs](https://hatch.pypa.io/latest/config/build/#dev-mode) but refers to pip in its documentation.
+Install your package in editable mode|✅| Hatch will install your package into any of it's environments by default in editable mode. You can install your package in editable mode manually using `pip install -e .` Hatch mentions [editable installs](https://hatch.pypa.io/latest/config/build/#dev-mode) but refers to pip in its documentation.


"it's" -> "its"

very good catch ! fixed. this page has actually been reviewed many times by many people and no one else caught this! :)

i actually just discovered that the caption for the graphic also has a note to myself that no one caught! i'm going to pull this page out and merge it separately with all of these typo fixes!

tutorials/1-installable-code.md

JacksonBurns · 2024-01-30T15:11:44Z

tutorials/1-installable-code.md

-# View the current file structure
-ls
+➜ hatch new pyospackage
+pyospackage


Love these diagrams

tutorials/1-installable-code.md

JacksonBurns · 2024-01-30T15:13:36Z

tutorials/1-installable-code.md

+
+:::{note}
+You will learn how to automate defining a package
+version using git tags in the version and release your package lesson.


Quotes around "Version and Release Your Package"? Could help with clarity

Actually I see later on in this document there is a link to the lesson, can that be put here also?

great suggestion. the actual tutorial on doing this with hatch isn't created ... yet! maybe i'll make this a TODO so it's hidden until we actually build and publish that lesson. that might be a good middle ground for now!

tutorials/get-to-know-hatch.md

JacksonBurns · 2024-01-30T15:16:50Z

tutorials/get-to-know-hatch.md

+[terminal.styles]
+```
+
+Also notice that the default license option is MIT. While we will discuss license in more detail in a later lesson... the MIT license is the recommended permissive license from choosealicense.com and as such we will use it for this tutorial series.


I like suggesting the MIT license

perfect! it does seem like a simpler choice.

JacksonBurns · 2024-01-30T15:17:36Z

tutorials/get-to-know-hatch.md

+
+A few features that hatch offers
+
+1. it will convert metadata stored in a setup.py or setup.cfg  file to a pyproject.toml file for you. While we haove not extensively tested this feature yet, please let us know if you try it!


Could be nice to include some contact info on this line to encourage more interaction!

lwasser · 2024-01-30T17:03:53Z

@all-contributors please add @JacksonBurns for code, review, tutorials

allcontributors · 2024-01-30T17:04:02Z

@lwasser

I've put up a pull request to add @JacksonBurns! 🎉

ucodery · 2024-01-31T17:55:44Z

tutorials/1-installable-code.md

+* Use the shell `cd` command to navigate in your shell to the location where you'd like your package directory to live. Hatch will create the package directory for you
+* Choose a name for your package. The name should:
+    * Have no spaces (*Required*)
+    * Use all lowercase characters (*Recommended*). For this tutorial we will use `pyospackage`.


It might be good to say that no symbols should be used except for _ or -.

Edit: I had originally written out a bit of a post about how some prefer the project name to use all -, while some prefer all _ (which will always match the package name then) and that it's generally a bad and confusing idea to use.. But it looks like Hatch already has stong opinions about this! After running some tests, hatch new will normalize the project name to all - and the package name to all _ (even spaces get normalized to this). IME this is a fine and popular naming scheme - we should maybe just keep it in mind when crafting examples.

oh @ucodery gosh i had no idea that hatch normalized file names.

i just ran some tests too:

❯ hatch new test-me-foreee test-me-foreee ├── src │ └── test_me_foreee │ ├── __about__.py │ └── __init__.py ├── LICENSE.txt ├── README.md └── pyproject.toml

so its rules are

dashes for the top level directory

dashes for the project name in the pyproject.toml

underscores for the package directory name

I wonder why it chose underscores only for that directory? that always confused me when i was newer to packaging - where the final name is pulled from and how the final package name could be different from the directory name.

Ok this may be a bit too much. but i suspect the project directory name thing will trip users up. Mostly because it did so for me for a long time.

Personally, I think a call out that hatch makes some decisions for you is enough. having that much example output is just a wall of text, especially for those that might not care about the admonition.

I wonder why it chose underscores only for that directory?

This is the one name choice that is not really a choice. The package directory becomes the final python package, the thing that gets imported, and so must follow python variable naming rules.

I suspect that hatch is running the standard name normalization on the new name, using that for the package directory, then using a .replace('_', '-') for all other names it defines.

ucodery · 2024-01-31T18:08:23Z

tutorials/get-to-know-hatch.md

+If you are comfortable using [pipx](https://pipx.pypa.io/stable/) to install hatch, we encourage you to do so. pipx will ensure that your package is available across all of your Python environments on your computer rather than just in the environment that you install it into.
+
+However if you are not sure about pipx, you can install hatch using pip or conda.


I love this new pipx tip!

yay! pipx is really growing on me. i still don't fully understand how it works on the back end but as a user, having hatch and nox, etc available to me in "all the pythons" 😆 , is really nice.

tutorials/get-to-know-hatch.md

lwasser · 2024-02-15T01:54:14Z

Ok y'all. this PR has been open for a few weeks and we haven't gotten a tremendous amount of additional feedback! thank you so much @ucodery and @JacksonBurns for the feedback! i think i've addressed all of the comments! I'm going to go ahead and merge it.

JacksonBurns reviewed Jan 30, 2024

View reviewed changes

lwasser marked this pull request as ready for review January 30, 2024 17:01

allcontributors bot mentioned this pull request Jan 30, 2024

docs: add JacksonBurns as a contributor for code, review, and tutorial #179

Merged

lwasser mentioned this pull request Jan 30, 2024

Fix: typos throughout the packaging build page and add targets to docs #180

Merged

lwasser added 2 commits January 30, 2024 11:15

Fix: use hatch for workflow

4eb21e5

Fix: Edits from review

4e1d595

lwasser force-pushed the hatch-init branch from 6f45f02 to 4e1d595 Compare January 30, 2024 18:15

ucodery reviewed Jan 31, 2024

View reviewed changes

lwasser added 2 commits February 14, 2024 18:37

Fix: edits from review

4b923a4

Fix: spelling and grammar

be44491

lwasser merged commit d146fdb into pyOpenSci:main Feb 15, 2024
4 checks passed

lwasser deleted the hatch-init branch February 15, 2024 01:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: use hatch for workflow #178

Fix: use hatch for workflow #178

lwasser commented Jan 29, 2024 •

edited

Loading

JacksonBurns left a comment

JacksonBurns Jan 30, 2024

lwasser Jan 30, 2024

lwasser Jan 30, 2024

JacksonBurns Jan 30, 2024

JacksonBurns Jan 30, 2024

JacksonBurns Jan 30, 2024

lwasser Feb 15, 2024

JacksonBurns Jan 30, 2024

lwasser Feb 15, 2024

JacksonBurns Jan 30, 2024

lwasser commented Jan 30, 2024

allcontributors bot commented Jan 30, 2024

ucodery Jan 31, 2024

lwasser Feb 15, 2024

lwasser Feb 15, 2024

ucodery Feb 15, 2024

ucodery Jan 31, 2024

lwasser Feb 15, 2024

lwasser commented Feb 15, 2024


		A few features that hatch offers

		1. it will convert metadata stored in a setup.py or setup.cfg file to a pyproject.toml file for you. While we haove not extensively tested this feature yet, please let us know if you try it!

		If you are comfortable using [pipx](https://pipx.pypa.io/stable/) to install hatch, we encourage you to do so. pipx will ensure that your package is available across all of your Python environments on your computer rather than just in the environment that you install it into.

		However if you are not sure about pipx, you can install hatch using pip or conda.

Fix: use hatch for workflow #178

Fix: use hatch for workflow #178

Conversation

lwasser commented Jan 29, 2024 • edited Loading

JacksonBurns left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lwasser commented Jan 30, 2024

allcontributors bot commented Jan 30, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lwasser commented Feb 15, 2024

lwasser commented Jan 29, 2024 •

edited

Loading