Skip to content

Add 'sherlock-project' executable alias for uvx users #2759

@BarbaricDuck

Description

@BarbaricDuck

Description

When using modern Python tool installers like uvx (from uv), the default behavior is to assume the executable name matches the package name.

Running:

> uvx sherlock-project

Fails because the executable is named sherlock.

uvx sherlock-project    
An executable named `sherlock-project` is not provided by package `sherlock-project`.
The following executables are available:
- sherlock

Use `uvx --from sherlock-project sherlock` instead.

While the suggested workaround (uvx --from sherlock-project sherlock) works, it's not intuitive and creates a bit more friction for new users.

My feature request is a single line addition to the pyproject.toml file

[tool.poetry.scripts]
sherlock = 'sherlock_project.sherlock:main'
sherlock-project = 'sherlock_project.sherlock:main'  # <<<

Which would make running through uvx (and pipx) simpler

> uvx sherlock-project --version
Sherlock v0.16.0

This seems like a simple, non-breaking change that would be a great quality-of-life improvement, thanks for considering.

Code of Conduct

  • I agree to follow this project's Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions