Migrate from Poetry 1.1 to Hatch

[br3ndonland]

Description

This PR will migrate inboard from Poetry 1.1 to Hatch. See #56 for more details and context around the motivations for this change.

Note that projects using inboard are not required to migrate to Hatch. The Docker images will retain Poetry 1.1 for backwards compatibility for now. Poetry 1.1 is unmaintained, and so it will eventually need to be removed, but there will be notice given at least one minor version ahead of time. If projects using inboard require poetry>1.2, they can add pipx upgrade poetry or pipx install poetry>1.2 --force to their Dockerfiles as described in the updated docs in this PR (on the Docker page, under "Docker and Poetry").

Changes

Update configuration files for Hatch

• Remove poetry.lock
• Remove poetry.toml
• Remove [tool.poetry] sections from pyproject.toml
• Update [build-system] section in pyproject.toml for Hatchling
• Move version number to inboard/__init__.py, which allows Python projects to import it with import inboard then inboard.__version__
• Add project metadata to new [project] section in pyproject.toml, bringing this project in line with Python project metadata standards
• Add optional dependencies to [project.optional-dependencies] groups
• Pin asgiref and mypy to avoid breaking changes to type checking that could be introduced by changes to mypy strict mode (2cbc99c) or by changes to asgiref TypedDict keys (d729fdf)
• Add environments to [tool.hatch.envs.*] tables, using features for optional dependency groups, and path = ".venv" for an in-project virtualenv in the same location as a Poetry in-project virtualenv
• Add Hatch environment names to .gitignore

Update Dockerfile for Hatch

• Remove poetry.lock and poetry.toml from COPY step
• Add README.md to COPY step (README.md is part of the Python package)
• Break ARG and ENV commands onto multiple lines for readability
• Add HATCH_VERSION build arg
• Set HATCH_ENV_TYPE_VIRTUAL_PATH=".venv" to ensure consistent in-project virtualenv location
• Install Hatch with pipx
• Continue installing Poetry 1.1 with pipx for backwards compatibility for now. Poetry 1.1 is unmaintained, and so it will eventually need to be removed, but there will be notice given at least one minor version ahead of time.
• Replace poetry install commands with hatch env create commands. There is no direct command to manually install or sync dependencies. The Hatch docs say, "You never need to manually create environments as spawning a shell or running commands within one will automatically trigger creation." The hatch env create command will create the virtual environment and install the appropriate dependencies. Note that commands for directly installing or syncing environments may be added in the future.
  • Is there no install command? pypa/hatch#593
  • Command to explicitly sync dependencies? pypa/hatch#650

Update GitHub Actions workflows for Hatch

• Update test that ensures pipx installs correct version of Hatch
• Update test for consistent in-project virtualenv directory (.venv)
• Update caching for pip so that GitHub Actions caches dependencies
• Update poetry run commands for Hatch, ensuring correct environment is selected with the HATCH_ENV environment variable
• Update package build and PyPI publish commands for Hatch

Update docs for Hatch

• 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

Related

• Closes Update poetry to 1.2.2 and regenerate lockfile #55
• Poetry 1.2 or Hatch? #56
• Closes Bump certifi from 2022.9.24 to 2022.12.7 #57
• I have reviewed the Guidelines for Contributing and the Code of Conduct.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
inboard	✅ Ready (Inspect)	Visit Preview	Dec 30, 2022 at 7:20PM (UTC)

[sourcery-ai]

Sourcery Code Quality Report

❌  Merging this PR will decrease code quality in the affected files by 0.48%.

Quality metrics	Before	After	Change
Complexity	2.00 ⭐	2.00 ⭐	0.00
Method Length	43.00 ⭐	46.00 ⭐	3.00 👎
Working memory	4.00 ⭐	4.00 ⭐	0.00
Quality	89.89% ⭐	89.41% ⭐	-0.48% 👎

Other metrics	Before	After	Change
Lines	24	26	2

Changed files	Quality Before	Quality After	Quality Change
inboard/__init__.py	89.89% ⭐	89.41% ⭐	-0.48% 👎

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Working Memory	Quality	Recommendation

Legend and Explanation

The emojis denote the absolute quality of the code:

• ⭐ excellent
• 🙂 good
• 😞 poor
• ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

---

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

[br3ndonland]

The Sourcery report from @sourcery-ai[bot] suggests that adding __version__ to inboard/__init__.py decreases code quality. It actually increases code quality, because the version number is now available directly.