-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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.
- Loading branch information
Showing
3 changed files
with
20 additions
and
9 deletions.
There are no files selected for viewing
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 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# outpack_query_parser | ||
|
||
Python bindings for the outpack query parser. The bindings can be installed | ||
directly from PyPI using `pip install outpack_query_parser`. | ||
|
||
This package provides a low-level building block for the Python version of | ||
outpack/orderly. Most users shouldn't need to use this package and should | ||
instead install [outpack-py](https://github.com/mrc-ide/outpack-py), which | ||
provides the high-level functionality. | ||
|
||
## Development | ||
|
||
``` | ||
hatch run python # Start a Python interpreter with the bindings installed | ||
hatch run test # Run the bindings test-suite | ||
hatch run develop # Rebuild the bindings. Necessary whenever changes to Rust code is made. | ||
``` |
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