Skip to main content

Poetry Command Aliases Plugin

This plugin allows you to define aliases or shortcuts for commonly used commands in your Poetry projects. It simplifies command execution by providing custom aliases for complex or frequently used commands.

Usage

  1. Installation:

    Install the plugin using Poetry:

    pip install poetry-plugin-commands
    

    or

    pip install --user poetry-plugin-commands
    

    or at least

    poetry self add poetry-plugin-commands
    
  2. Define Aliases:

    Add your aliases to the pyproject.toml file under the [tool.poetry-plugin-commands] section:

    [tool.poetry-plugin-commands]
    stree = "tree src"
    test_var = "echo $VAR"
    run_app = "PYTHONPATH=src:. poetry run python src/app_launch/main.py"
    

    Here, stree, test_var, and run_app are the custom aliases, and their corresponding commands are specified.

  3. Execute Commands:

    Now you can use the defined aliases with Poetry:

    poetry stree
    
    poetry test_var
    
    poetry run_app
    

    These commands will execute the respective commands defined as aliases.

  4. List Available Commands:

    To get a list of available aliases along with their corresponding commands, run:

    poetry user-commands
    

    This will display a list of aliases and their associated commands:

    stree -> `tree src`
    test_var -> `echo $VAR`
    run_app -> `PYTHONPATH=src:. poetry run python src/app_launch/main.py`
    

Contributing

Feel free to contribute to this plugin by reporting issues, suggesting features, or submitting pull requests on GitHub.

License

This plugin is licensed under the Apache 2. License. See the LICENSE file for details.

Metadata

Release files for poetry-plugin-commands 0.0.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for poetry-plugin-commands 0.0.9
File Size Uploaded Provenance Actions
poetry_plugin_commands-0.0.9.tar.gz 7.7 kB Without provenance Details for poetry_plugin_commands-0.0.9.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for poetry-plugin-commands 0.0.9
File Interpreter ABI Platform Actions
poetry_plugin_commands-0.0.9-py3-none-any.whl Python 3 none any Details for poetry_plugin_commands-0.0.9-py3-none-any.whl

Total release size: 16.2 kB

Release files / poetry_plugin_commands-0.0.9.tar.gz

Download URL poetry_plugin_commands-0.0.9.tar.gz
Size 7.7 kB
Tags Source
SHA-256 checksum
How to use checksums
c4ceccf3a3c005ae670f3465d2b8f5490ea3998472a0400e55201e821db8e505
BLAKE2b-256 checksum
How to use checksums
3d6ee1cc71c843919f5942d461ac3a511afac782f1ca2677e66f522b20981f4d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.2 PyPy/7.3.10 Linux/5.10.194-1-MANJARO-TKG

Release files / poetry_plugin_commands-0.0.9-py3-none-any.whl

Download URL poetry_plugin_commands-0.0.9-py3-none-any.whl
Size 8.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7aa015785b2536552407fbaf325c4edd1334ccc04cfda73e355b9b9c56a671ff
BLAKE2b-256 checksum
How to use checksums
755c497454d599c102486e8d30771514c7d1bcdb74f7d8d81b198b9649569906
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.2 PyPy/7.3.10 Linux/5.10.194-1-MANJARO-TKG

Security for poetry-plugin-commands 0.0.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page