Add a custom Python README. #60
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
This comment was marked as outdated.
This comment was marked as outdated.
By default Hatch automatically includes the README.md file at the root of the project as the Python package's description, which shows up when looking at the package on PyPI. Since the README mostly contains information about the server this could lead to confusion, with users trying to start a server when what they really wanted was to be redirected to the main outpack-py package. This adds a minimal README with the Python specific information, and a link to the main package. The new file is referenced from `pyproject.toml`, ensuring this is what gets used as the description rather than the default one.
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.
By default Hatch automatically includes the README.md file at the root
of the project as the Python package's description, which shows up when
looking at the package on PyPI. Since the README mostly contains
information about the server this could lead to confusion, with users
trying to start a server when what they really wanted was to be
redirected to the main outpack-py package.
This adds a minimal README with the Python specific information, and a
link to the main package. The new file is referenced from
pyproject.toml, ensuring this is what gets used as the descriptionrather than the default one.