Skip to content

Commit 6b2fc2f

Browse files
committed
chore: use poe tasks runner
1 parent d695fe7 commit 6b2fc2f

File tree

3 files changed

+85
-2
lines changed

3 files changed

+85
-2
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,12 @@ poetry shell
4949
shiny run --reload signature/app.py
5050
```
5151

52+
or shortcut:
53+
54+
```bash
55+
poe runshiny
56+
```
57+
5258
## Modify the theme
5359

5460
This app uses Bootstrap `5.3.3`.
@@ -62,6 +68,8 @@ cd signature
6268
sass scss/signature.scss css/signature.css
6369
```
6470

71+
or shi
72+
6573
## How the redirection banner works?
6674

6775
The redirection banner is a JavaScript function that redirects the user to the specified URL.
@@ -101,7 +109,32 @@ poetry run pytest
101109
or
102110

103111
```bash
104-
poetry run pytest --github-report -vvv
112+
poetry run pytest --github-report --verbose
113+
```
114+
115+
or shortcut:
116+
117+
```bash
118+
poe test
119+
```
120+
121+
## Poe commands
122+
123+
This project uses the `poe` command to run the app, tests, and other commands.
124+
125+
To see the available commands, run:
126+
127+
```bash
128+
poe
129+
```
130+
131+
All the commands are defined in the `pyproject.toml` file.
132+
133+
Create a new command by adding a new entry in the `tasks` section of the `pyproject.toml` file.
134+
135+
```toml
136+
[tool.poe.tasks]
137+
hello = "echo 'Hello, world!'"
105138
```
106139

107140
## You love this project?
@@ -127,3 +160,7 @@ What you can do:
127160
- share the app with your colleagues.
128161

129162
- enjoy the app!
163+
164+
```
165+
166+
```

poetry.lock

Lines changed: 41 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,14 @@ pathlib = "^1.0.1"
1818
jinja2 = "^3.1.4"
1919
rsconnect-python = "^1.24.0"
2020
pytest-github-report = "^0.0.1"
21+
poethepoet = "^0.27.0"
2122

2223

2324
[build-system]
2425
requires = ["poetry-core"]
2526
build-backend = "poetry.core.masonry.api"
27+
28+
[tool.poe.tasks]
29+
hello = "echo 'Hello, World!'"
30+
test = "poetry run pytest --github-report --verbose"
31+
runshiny = "shiny run --reload signature/app.py"

0 commit comments

Comments
 (0)