Skip to content

Commit 7dd308e

Browse files
committed
Replace Makefile with poe tasks in pyproject.yaml
1 parent 0ba0692 commit 7dd308e

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
@@ -52,8 +52,8 @@ jobs:
5252
poetry install
5353
- name: Run tests
5454
run: |
55-
make generate
56-
make test
55+
poetry run poe generate
56+
poetry run poe test
5757
5858
build-release:
5959
runs-on: ubuntu-latest

Makefile

-43
This file was deleted.

README.md

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

317-
- 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/))
318-
319-
*Needed to conveniently run development tasks.*
320-
*Alternatively, manually run the commands defined in the [Makefile](./Makefile)*
317+
- [poethepoet](https://github.com/nat-n/poethepoet) for running development tasks as defined in pyproject.toml
318+
- Can be installed to your host environment via `pip install poethepoet` then executed as simple `poe`
319+
- or run from the poetry venv as `poetry run poe`
321320

322321
### Setup
323322

@@ -329,16 +328,14 @@ poetry install
329328
poetry shell
330329
```
331330

332-
Run `make help` to see all available development tasks.
333-
334331
### Code style
335332

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

338335
Before committing changes run:
339336

340337
```sh
341-
make format
338+
poe format
342339
```
343340

344341
To avoid merge conflicts later, non-black formatted python code will fail in CI.
@@ -372,15 +369,15 @@ Here's how to run the tests.
372369

373370
```sh
374371
# Generate assets from sample .proto files required by the tests
375-
make generate
372+
poe generate
376373
# Run the tests
377-
make test
374+
poe test
378375
```
379376

380377
To run tests as they are run in CI (with tox) run:
381378

382379
```sh
383-
make full-test
380+
poe full-test
384381
```
385382

386383
### (Re)compiling Google Well-known Types
@@ -401,7 +398,6 @@ protoc \
401398
/usr/local/include/google/protobuf/*.proto
402399
```
403400

404-
405401
### TODO
406402

407403
- [x] Fixed length fields

0 commit comments

Comments
 (0)