Skip to content

Commit

Permalink
Update docs for Hatch
Browse files Browse the repository at this point in the history
- Add new user words to `cspell.json`
- Add Hatch description and instructions to contributing.md
- Update Poetry references in docs for Hatch
- Move instructions for code quality checks below instructions for Hatch
  so that contributors understand how to set up the project prior to
  running code quality checks
  • Loading branch information
br3ndonland committed Dec 30, 2022
1 parent 0905aff commit b8a96ca
Show file tree
Hide file tree
Showing 6 changed files with 254 additions and 169 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This repository provides [Docker images](https://github.com/br3ndonland/inboard/

_Why use this project?_ You might want to try out inboard because it:

- **Offers a Python package and Docker images that work together**. Python packages and Docker images don't automatically share the same versioning systems, but inboard can help with this. You might install a minor release of the Python package with `pip install 'inboard>=0.28,<0.29[fastapi]'` or `poetry add inboard@'^0.28' -E fastapi`. You can also pull the corresponding Docker image `FROM ghcr.io/br3ndonland/inboard:0.28`.
- **Offers a Python package and Docker images that work together**. Python packages and Docker images don't automatically share the same versioning systems, but inboard can help with this. You might install the Python package with a minor version constraint. You can also pull the corresponding Docker image by specifying the minor version in the Docker tag (`FROM ghcr.io/br3ndonland/inboard:<version>`).
- **Tests everything**. inboard performs unit testing of 100% of the Python code, and also runs smoke tests of the Docker images each time they are built.
- **Sets sane defaults, but allows configuration**. Configure a variety of settings with environment variables. Or run it as-is and it just works.
- **Configures logging extensibly**. inboard simplifies logging by handling all its Python log streams with a single logging config. It also offers the ability to filter health check endpoints out of the access logs. Don't like it? No problem. You can easily extend or override the logging behavior.
Expand Down
2 changes: 2 additions & 0 deletions cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
"words": [
"anyio",
"asgi",
"asgiref",
"asyncio",
"autoformat",
"autoformatter",
Expand Down Expand Up @@ -62,6 +63,7 @@
"noqa",
"pipx",
"postinstallation",
"prereleases",
"prestart",
"prettier",
"prettierignore",
Expand Down
Loading

0 comments on commit b8a96ca

Please sign in to comment.