Add: Tutorial for migrating from setup.py to pyproject.toml using Hatch #229
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
…'s existing setup.py can be migrated to a pyproject.toml using Hatch. Update tutorials/installable-code.md to add a note about this specific use case for Hatch. Update tutorials/intro.md to add setup-py-to-pyproject-toml.md to toctree.
willingc
approved these changes
Apr 10, 2024
ucodery
reviewed
Apr 10, 2024
…his guide instead of pip install
…and running any preexisting tests.
ucodery
requested changes
Apr 11, 2024
Comment on lines
103
to
105
| ```bash | ||
| rm setup.py | ||
| ``` |
There was a problem hiding this comment.
IMO we don't need to add bash examples for every step. Especially as some readers won't want to do everything in the terminal.
There was a problem hiding this comment.
I agree. I removed some of these and left only a couple of hatch specific ones.
| @@ -88,3 +95,25 @@ Now, let's walk through the steps to use Hatch to create a `pyproject.toml` file | |||
| 3. **Review and Customize**: After running the previous command, Hatch will automatically generate a `pyproject.toml` file based on your existing project configuration. Take some time to review the contents of the generated `pyproject.toml` file. You may want to customize certain settings or dependencies based on your project's requirements (see [pyproject.toml tutorial](pyproject-toml.md) for more information about the `pyproject.toml`). | |||
|
|
|||
| 4. **Verify**: Verify that the `pyproject.toml` file accurately reflects your project configuration and dependencies. You can manually edit the file if needed, but be cautious and ensure that the syntax is correct. | |||
|
|
|||
| ### Step 5: Delete setup.py | |||
There was a problem hiding this comment.
This guide switches from an ordered list to numbered headers. Let's stick to one style.
There was a problem hiding this comment.
Good catch! Thanks for pointing it out. Just fixed it to be consistent
… the step-by-step guide and remove some of the more simple bash commands, only leaving the necessary ones.
lwasser
approved these changes
Apr 15, 2024
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.
Addresses #210 by creating the tutorial for migrating from setup.py to pyproject.toml using Hatch.