Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(build): add license & remove litestar from dependencies #8

Merged
merged 2 commits into from
Nov 29, 2024

Conversation

cofin
Copy link
Member

@cofin cofin commented Nov 29, 2024

Description

There have been a number of complaints about circular dependencies with this package. This change make litestar only required for tests.

Litestar will be updated to have a minimum pin of 0.4.0 here.

Closes

Summary by Sourcery

Remove 'litestar' from the project dependencies, addressing circular dependency issues, and update the project version to '0.4.0'. Update the 'ruff-pre-commit' hook version in the pre-commit configuration.

Build:

  • Remove 'litestar' from the project dependencies in 'pyproject.toml', making it only required for tests.

Chores:

  • Update the version of the 'ruff-pre-commit' hook from 'v0.7.0' to 'v0.8.1' in the pre-commit configuration.

Copy link

sourcery-ai bot commented Nov 29, 2024

Reviewer's Guide by Sourcery

This PR removes Litestar as a direct dependency and makes it test-only, addressing circular dependency complaints. The changes include dependency updates, code reorganization, and version updates. The implementation primarily involves modifying the project configuration and reordering some imports.

Updated class diagram for litestar_htmx module exports

classDiagram
    class litestar_htmx {
        +ClientRedirect
        +ClientRefresh
        +EventAfterType
        +HTMXConfig
        +HTMXDetails
        +HTMXHeaders
        +HTMXPlugin
        +HTMXRequest
        +HTMXTemplate
        +HXLocation
        +HXStopPolling
        +HtmxHeaderType
        +LocationType
        +PushUrl
        +PushUrlType
        +ReSwapMethod
        +ReplaceUrl
        +Reswap
        +Retarget
        +TriggerEvent
        +TriggerEventType
    }
Loading

File-Level Changes

Change Details Files
Remove Litestar as a direct dependency
  • Remove 'litestar' from project dependencies
  • Bump package version from 0.3.0 to 0.4.0
pyproject.toml
Update development tooling configuration
  • Update ruff-pre-commit from v0.7.0 to v0.8.1
  • Update ruff lint rules by renaming 'TCH' to 'TC'
.pre-commit-config.yaml
pyproject.toml
Code cleanup and organization improvements
  • Reorder all exports alphabetically
  • Add type annotation for nitpick_ignore
  • Reorder all exports in multiple modules
litestar_htmx/__init__.py
litestar_htmx/__metadata__.py
litestar_htmx/request.py
litestar_htmx/types.py
docs/conf.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.

@cofin cofin changed the title chore(build): remove litestar from dependencies chore(build): add license & remove litestar from dependencies Nov 29, 2024
@cofin
Copy link
Member Author

cofin commented Nov 29, 2024

Closes #7

@cofin cofin merged commit 9736d5c into main Nov 29, 2024
14 checks passed
@cofin cofin deleted the relax-deps branch November 29, 2024 19:15
@cofin cofin linked an issue Nov 29, 2024 that may be closed by this pull request
@cofin cofin mentioned this pull request Nov 29, 2024
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.

Enhancement: Add a LICENSE
1 participant