pyqwe 3.1.0

Run commands quickly from the pyproject.toml (or pyqwe.toml) file.

🏎️💨 pyqwe

The Quick Work Environment for Python.

Run commands quickly from the pyproject.toml (or pyqwe.toml) file.

pip install pyqwe

---

• 🏎️💨 pyqwe
  • Usage
  • Python commands
    • Package example
    • Module example
  • *:... commands (terminal)
    • Run as shell
    • Change the working directory
  • Grouped commands
  • Waiting before starting a runner
  • Using environment variables
  • Clearing the terminal setting
  • Other commands

Usage

Add commands to the pyproject.toml or pyqwe.toml file.

[tool.pyqwe]
flask = "flask_app:run"
say_hello = "*:echo Hello World"

If you're using a pyqwe.toml file you can drop the [tool.pyqwe]

flask = "flask_app:run"
say_hello = "*:echo Hello World"

🚨 NOTE 🚨

If you have both a pyproject.toml and a pyqwe.toml file, the pyqwe.toml file will be used and the pyproject.toml file will be ignored.

You will be able to see what commands you have set in the pyproject.toml file by running:

pyqwe list
# or
pyqwe ls

You can run the commands by using the command name:

pyqwe flask

Running pyqwe without any option or command will show all available commands in a menu you can choose from.

pyqwe

🚥|🏎️
0 : Exit
1 : flask
2 : say_hello
Select a command to run [0]:

Choosing 1 will run the flask command.

Python commands

For Python, the commands are structured like (package &/ module):function

Package example

project/
    flask_app/
        __init__.py

[tool.pyqwe]
flask = "flask_app:run"

This command will run the function run() from the __init__.py file in the flask_app package.

Module example

project/
    app.py

[tool.pyqwe]
flask = "app:run"

This command will run the function run() from the app.py file.

Now run the pyqwe command:

pyqwe flask

This will start the Flask app.

*:... commands (terminal)

Any command that starts with * will be run using subprocess.

For example:

[tool.pyqwe]
say_hello = "*:echo Hello World"

Now running the pyqwe command:

pyqwe say_hello

Will print Hello World.

Run as shell

To run the command as a subprocess shell command, add the shell key to the command.

[tool.pyqwe]
say_hello = "*shell:echo Hello World"

Change the working directory

You can change the working directory of a subprocess by adding the folder within parentheses to the command, (node_app) for example.

The folder must be relative to the pyproject.toml file.

Absolute paths are not supported.

Moving up directories is not supported, ../node_app for example.

[tool.pyqwe]
npm_install = "*(node_app):npm install"

The shell key is still available when changing the directory.

[tool.pyqwe]
npm_install = "*shell(node_app):npm i"

Grouped commands

You can group commands together in a list to have one pyqwe command run multiple commands.

Grouped commands can also be run in Step, Sync, or Async mode. Async being the default.

This will run the commands in the group in sequence, pausing for confirmation between each command:

[tool.pyqwe]
group = [
    "@step",
    "*:echo 'Hello, World! 1'",
    "*:echo 'Hello, World! 2'",
    "*:echo 'Hello, World! 3'"
]

This will run the commands in the group in sequence, one after the other:

[tool.pyqwe]
group = [
    "@sync",
    "*:echo 'Hello, World! 1'",
    "*:echo 'Hello, World! 2'",
    "*:echo 'Hello, World! 3'"
]

This will run the commands in the group in parallel:

[tool.pyqwe]
group = [
    "@async",
    "*:echo 'Hello, World! 1'",
    "*:echo 'Hello, World! 2'",
    "*:echo 'Hello, World! 3'"
]

Of course, you can leave out the @step, @sync or @async to use the default async mode.

For example, this will also run the commands in the group in parallel:

[tool.pyqwe]
group = [
    "*:echo 'Hello, World! 1'",
    "*:echo 'Hello, World! 2'",
    "*:echo 'Hello, World! 3'"
]

Waiting before starting a runner

Sometimes you might need to have a runner wait before starting. This might be the case if you have a group of runners in async mode but one runner connects to another.

You can tell a runner to sleep for a number of seconds by using the sleep for marker:

[tool.pyqwe]
group = [
    "@async",
    "*:~10~ echo 'Hello, World! 1'",
    "*:echo 'Hello, World! 2'",
    "*:echo 'Hello, World! 3'"
]

This also works on module runs:

[tool.pyqwe]
flask = "~10~ flask_app:run"

Each of the examples above will sleep for 10 seconds before the runner will start.

Using environment variables

To use environment variables in the command, use the {{ }} markers.

pyqwe will evaluate any environment variables that are set before running any commands.

If pyqwe detects an environment variable that is not set, it will raise an error. An error will also be raised if environment variables are detected, and you do not have python-dotenv installed.

Here's an example of setting an environment variable in a command:

[tool.pyqwe]
talk = "*shell:echo {{MESSAGE}}"

pyqwe uses load_dotenv() from python-dotenv to load the .env file. You can change the name of the file to load, or add multiple env files by setting the __env_files__ settings key.

[tool.pyqwe]
__env_files__ = [".env", ".env.local"]
talk = "*shell:echo {{MESSAGE}}"

This is the same as running load_dotenv(".env") and load_dotenv(".env.local").

If you want to disable pyqwe from doing anything with environment variables, you can set the __env_ignore__ settings key to true.

[tool.pyqwe]
__env_ignore__ = true
talk = "*shell:echo {{MESSAGE}}"

This will disable the environment variable evaluation and loading of the .env file, and result in {{MESSAGE}} being printed to the console in this case.

Clearing the terminal setting

Setting the __clear_terminal__ setting option to true will clear the terminal immediately after the pyqwe command is run. Results may very on this setting between terminals and OS platforms.

This option is set to false by default.

[tool.pyqwe]
__clear_terminal__ = true
talk = "*shell:echo {{MESSAGE}}"

Other commands

pyqwe -h or --help will display help information.

pyqwe --version or -v will display the version of pyqwe.