Skip to content

Conversation

@nickmoreton
Copy link
Collaborator

@nickmoreton nickmoreton commented Dec 25, 2024

This pull request introduces several updates to dependencies, development tooling, and documentation, as well as a migration to using the UV tool for managing Python environments and commands.

Dependency and Tooling Updates:

  • Updated pre-commit hooks in .pre-commit-config.yaml to the latest versions of isort (6.0.1), black (25.1.0), flake8 (7.2.0), and pymarkdown (v0.9.29). Also updated the blacken-docs dependency to match the new black version. [1] [2]
  • Added a requires-python field (>=3.9) and reorganized dependencies in pyproject.toml to use dependency-groups for better separation of development and testing dependencies. Replaced setuptools with hatchling for the build system.

Migration to UV Tool:

  • Replaced direct Python commands in the Makefile with uv commands for tasks like migrations, running the server, and testing. This ensures consistency in environment management.
  • Updated the development setup documentation in docs/contrubute.md to reflect the use of UV for creating virtual environments and running commands.

Documentation Improvements:

  • Enhanced the development setup guide in docs/contrubute.md by adding clearer instructions for setting up the environment, running the app, and testing email functionality with MailHog. Removed redundant docs/mailhog.md as its content was integrated into docs/contrubute.md. [1] [2]

Miscellaneous Changes:

  • Added Python 3.13 to .python-version for compatibility testing.
  • Added a note in CHANGELOG.md about transitioning to UV for dependency management.

@nickmoreton nickmoreton changed the base branch from release to main May 16, 2025 21:35
@nickmoreton nickmoreton self-assigned this May 16, 2025
@nickmoreton nickmoreton requested a review from Copilot May 16, 2025 21:55
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR migrates the project to use the UV tool for managing Python environments and commands while updating dependency versions and improving development documentation.

  • Updated dependency configuration in pyproject.toml to use Hatchling and dependency groups.
  • Replaced direct Python invocations in the Makefile with corresponding uv commands.
  • Consolidated MailHog instructions into docs/contrubute.md and updated development setup documentation.

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.

Show a summary per file
File Description
pyproject.toml Reorganized dependencies, added requires-python, and switched to Hatchling.
docs/mailhog.md Removed redundant documentation now merged into the development guide.
docs/contrubute.md Updated setup instructions to use UV commands and consolidated MailHog setup.
Makefile Replaced Python commands with uv commands for migrations, tests, and server runs.
CHANGELOG.md Added a note about the transition to UV for dependency management.
.python-version Updated Python version for compatibility testing.
.pre-commit-config.yaml Updated hook revisions to the latest versions.
Comments suppressed due to low confidence (1)

docs/contrubute.md:1

  • The filename 'contrubute.md' appears to be misspelled; consider renaming it to 'contribute.md' for clarity.
docs/contrubute.md

@nickmoreton nickmoreton requested a review from Copilot May 16, 2025 21:58
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request converts the project to use the UV tool for dependency management and development tasks, while also updating dependencies, development tooling, and documentation.

  • Updated dependency management in pyproject.toml with dependency groups for development and testing and switched the build system to hatchling
  • Migrated command executions in the Makefile to use UV and updated the contributing documentation accordingly
  • Removed outdated documentation files (docs/contrubute.md and docs/mailhog.md) and updated references in README.md and docs/contribute.md

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
pyproject.toml Updated dependencies and introduced dependency groups with hatchling
docs/mailhog.md Removed redundant MailHog documentation
docs/contrubute.md Removed outdated contributing guide
docs/contribute.md Added updated contributing instructions leveraging UV
README.md Updated link reference to the new contributing guide
Makefile Migrated commands from python to uv run for consistency
CHANGELOG.md Documented the migration to UV for dependency management
.python-version Upgraded Python version to 3.13
.pre-commit-config.yaml Updated revisions for isort, black, flake8, and pymarkdown

@nickmoreton nickmoreton requested a review from Copilot May 16, 2025 22:01
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request updates dependency versions and tooling configurations, migrates to using the UV tool for environment management, and revises setup documentation.

  • Updated dependency definitions and added dependency groups in pyproject.toml
  • Migrated Python commands in the Makefile to UV commands and updated pre-commit hooks
  • Revised documentation by replacing an outdated contribute file and removing redundant mailhog documentation

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

Show a summary per file
File Description
pyproject.toml Updated dependency versions and reorganized dependency groups
docs/mailhog.md Removed redundant mailhog documentation
docs/contrubute.md Removed outdated contribute documentation (file name updated)
docs/contribute.md Added updated instructions for development setup using UV
README.md Updated reference link to the new contribute file
Makefile Replaced Python commands with UV commands and adjusted workflow steps
CHANGELOG.md Documented changes to dependency management with UV
.python-version Updated Python version for compatibility testing
.pre-commit-config.yaml Updated pre-commit hook versions
Comments suppressed due to low confidence (2)

docs/contrubute.md:1

  • The file 'docs/contrubute.md' appears to be misnamed; it has been replaced with 'docs/contribute.md'. Please ensure that all internal links and references have been updated accordingly.
# Contributing

Makefile:23

  • The removal of '@make run' from the 'mail' target could affect the workflow if restarting the server was intended after starting the mail server. Please confirm that this change is deliberate or update the workflow accordingly.
@make run

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants