Skip to content

Commit 94e7acc

Browse files
nat-nGobot1234
authored andcommitted
Replace Makefile with poe tasks in pyproject.yaml (danielgtaylor#118)
https://github.com/nat-n/poethepoet
1 parent eda8035 commit 94e7acc

File tree

5 files changed

+549
-70
lines changed

5 files changed

+549
-70
lines changed

.github/workflows/ci.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424
- name: Install dependencies
2525
run: poetry install
2626
- name: Run black
27-
run: make check-style
27+
run: poetry run poe check-style
2828

2929
run-tests:
3030
runs-on: ubuntu-latest
@@ -53,8 +53,8 @@ jobs:
5353
poetry install
5454
- name: Run tests
5555
run: |
56-
make generate
57-
make test
56+
poetry run poe generate
57+
poetry run poe test
5858
5959
build-release:
6060
runs-on: ubuntu-latest

Makefile

-43
This file was deleted.

README.md

+7-11
Original file line numberDiff line numberDiff line change
@@ -328,10 +328,9 @@ datetime.datetime(2019, 1, 1, 11, 59, 58, 800000, tzinfo=datetime.timezone.utc)
328328
- [poetry](https://python-poetry.org/docs/#installation)
329329
*Needed to install dependencies in a virtual environment*
330330

331-
- make ([ubuntu](https://www.howtoinstall.me/ubuntu/18-04/make/), [windows](https://stackoverflow.com/questions/32127524/how-to-install-and-use-make-in-windows), [mac](https://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/))
332-
333-
*Needed to conveniently run development tasks.*
334-
*Alternatively, manually run the commands defined in the [Makefile](./Makefile)*
331+
- [poethepoet](https://github.com/nat-n/poethepoet) for running development tasks as defined in pyproject.toml
332+
- Can be installed to your host environment via `pip install poethepoet` then executed as simple `poe`
333+
- or run from the poetry venv as `poetry run poe`
335334

336335
### Setup
337336

@@ -344,16 +343,14 @@ poetry install
344343
poetry shell
345344
```
346345

347-
Run `make help` to see all available development tasks.
348-
349346
### Code style
350347

351348
This project enforces [black](https://github.com/psf/black) python code formatting.
352349

353350
Before committing changes run:
354351

355352
```sh
356-
make format
353+
poe format
357354
```
358355

359356
To avoid merge conflicts later, non-black formatted python code will fail in CI.
@@ -387,15 +384,15 @@ Here's how to run the tests.
387384

388385
```sh
389386
# Generate assets from sample .proto files required by the tests
390-
make generate
387+
poe generate
391388
# Run the tests
392-
make test
389+
poe test
393390
```
394391

395392
To run tests as they are run in CI (with tox) run:
396393

397394
```sh
398-
make full-test
395+
poe full-test
399396
```
400397

401398
### (Re)compiling Google Well-known Types
@@ -416,7 +413,6 @@ protoc \
416413
/usr/local/include/google/protobuf/*.proto
417414
```
418415

419-
420416
### TODO
421417

422418
- [x] Fixed length fields

0 commit comments

Comments
 (0)