Skip to content

Commit 999c7ff

Browse files
committed
update docs and examples
1 parent c7d5c44 commit 999c7ff

File tree

3 files changed

+34
-25
lines changed

3 files changed

+34
-25
lines changed

README.md

Lines changed: 30 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -14,64 +14,71 @@ pip install pyqwe
1414
---
1515

1616
<!-- TOC -->
17+
1718
* [🏎️💨 pyqwe](#-pyqwe)
18-
* [Usage](#usage)
19-
* [Python commands](#python-commands)
20-
* [Package example](#package-example)
21-
* [Module example](#module-example)
22-
* [*:... commands (terminal)](#-commands-terminal)
23-
* [Run as shell](#run-as-shell)
24-
* [Change the working directory](#change-the-working-directory)
25-
* [Grouped commands](#grouped-commands)
26-
* [Waiting before starting a runner](#waiting-before-starting-a-runner)
27-
* [Using environment variables](#using-environment-variables)
28-
* [Clearing the terminal setting](#clearing-the-terminal-setting)
29-
* [Other commands](#other-commands)
30-
<!-- TOC -->
19+
* [Usage](#usage)
20+
* [Python commands](#python-commands)
21+
* [Package example](#package-example)
22+
* [Module example](#module-example)
23+
* [*:... commands (terminal)](#-commands-terminal)
24+
* [Run as shell](#run-as-shell)
25+
* [Change the working directory](#change-the-working-directory)
26+
* [Grouped commands](#grouped-commands)
27+
* [Waiting before starting a runner](#waiting-before-starting-a-runner)
28+
* [Using environment variables](#using-environment-variables)
29+
* [Clearing the terminal setting](#clearing-the-terminal-setting)
30+
* [Other commands](#other-commands)
3131

32+
<!-- TOC -->
3233

3334
## Usage
3435

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

38+
🚨**NOTE** - If you have both a pyproject.toml and a pyqwe.toml file, the pyqwe.toml
39+
file will be used and the pyproject.toml file will be ignored.
40+
3741
```toml
3842
[tool.pyqwe]
3943
flask = "flask_app:run"
4044
say_hello = "*:echo Hello World"
4145
```
4246

43-
**If you're using a pyqwe.toml file you can drop the `[tool.pyqwe]`**
47+
If you're using a pyqwe.toml file you can drop the `[tool.pyqwe]`
4448

4549
```toml
4650
flask = "flask_app:run"
4751
say_hello = "*:echo Hello World"
4852
```
4953

50-
🚨 **NOTE** 🚨
51-
52-
**If you have both a pyproject.toml and a pyqwe.toml file, the pyqwe.toml
53-
file will be used and the pyproject.toml file will be ignored.**
54-
55-
You will be able to see what commands you have set in the pyproject.toml file
56-
by running:
54+
To see information on the available commands in the toml file you can run:
5755

5856
```bash
5957
pyqwe list
6058
# or
6159
pyqwe ls
60+
# or
61+
qwe list
62+
# or
63+
qwe ls
6264
```
6365

6466
You can run the commands by using the command name:
6567

6668
```bash
6769
pyqwe flask
70+
# or
71+
qwe flask
6872
```
6973

70-
Running `pyqwe` without any option or command will show all available commands
74+
Running `pyqwe` or `qwe` without any option or command
75+
will show all available commands
7176
in a menu you can choose from.
7277

7378
```bash
7479
pyqwe
80+
# or
81+
qwe
7582
```
7683

7784
```text
@@ -264,7 +271,7 @@ This also works on module runs:
264271
flask = "~10~ flask_app:run"
265272
```
266273

267-
Each of the examples above will sleep for 10 seconds before the runner will
274+
Each of the examples above will sleep for 10 seconds before the runner will
268275
start.
269276

270277
## Using environment variables

pyproject.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@ output-format = "full"
2929
__clear_terminal__ = true
3030
__env_ignore__ = false
3131
__env_files__ = [".env.example"]
32-
js_example = "*(js_example):npm start"
32+
install_js_example = "*(js_example):npm install"
33+
install_flask_example = "*:pip install flask gunicorn"
34+
start_js_example = "*(js_example):npm start"
3335
gunicorn = "*:gunicorn flask_example.package:create_app()"
3436
cmd_mod_flask = "*:flask --app flask_example/module.py run"
3537
cmd_pac_flask = "*:flask --app flask_example/package run --port {{PORT}} --host {{HOST}}"

src/pyqwe/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
)
1818
from .parser import ArgumentParser
1919

20-
__version__ = "3.1.0"
20+
__version__ = "3.1.1"
2121

2222
CWD = Path().cwd()
2323
TOML_FILE, QWE = get_toml(CWD)

0 commit comments

Comments
 (0)