Albert launcher extension Poem

Background

I was looking for a Command palette which can easily remember cmds and have the possibility to add some basic prompts to some scripts and to recall them later.

Solution Poe-Manager

Poem is able to

• index shell scripts or python poetry tasks
• define paths where to crawl for the files
• pyproject.toml working with python / poe:
  • parsed parameters: name, command, helptext
  • activate virtual environment before execution
  • all tasks from poetry get listed as commands
• shell scripts:
  • all usages in the header get listed as commands
  • parsed parameters: name, command
• create a new shell script from template (type "poem new script")
• create a complete new python project with venv and configurations (type "poem new project")
• execute the commands in albert launcher
• creates aliases so that you can use commands in shell: ~/.poem-aliases

in union the benefits of:

• albert launcher to provide the GUI
• python extension for easeness to extend the plugin
• poetry to maintain pip packages and pyproject.toml
• pyproject.toml to maintain metadata and pip packages
• poethepoet to organize the tasks for python project
• click to create a python cli and to prompt for missing arguments

Todo

• explain how to setup poe
• check for icon in the same folder
• check for icon by path
• update python projects
• option to reindex and rewrite the alias file (currently only at startup)
• add gitignore for the projects

Documentation

Using bash aliases

The extension can write a static alias file in the location you define in the settings. Limitation: At the moment the file is only written once at startup.

Then add the following line in your ~/.bashrc to source the file: . <your filename>

Afterwards you can refresh the shell and use:

poem <your command> <your arguments>

Using Poetry tasks for python projects

The project needs to use a virtual environment and poetry and poethepoet

If you do need to install the virtual environment yourself follow the basic steps (even it is recommended to use the script to initiate a new project)_

1. Initiate the virtual environment with your favorite tool

There are different styles how to add your tasks to the pyproject.toml

Update this extension

Changelog

Release 0.16

• Add confirmation for creating projects for poetry and main.py
• Add .gitignore if wanted for projects

Release 0.15

• Initial