Replace Makefile with poe tasks in pyproject.yaml

danielgtaylor · Jul 12, 2020 · c92506f · c92506f
1 parent 0ba0692
commit c92506f
Show file tree

Hide file tree

Showing 5 changed files with 550 additions and 70 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -24,7 +24,7 @@ jobs:
       - name: Install dependencies
         run: poetry install
       - name: Run black
-        run: make check-style
+        run: poetry run poe check-style
 
   run-tests:
     runs-on: ubuntu-latest
@@ -52,8 +52,8 @@ jobs:
           poetry install
       - name: Run tests
         run: |
-          make generate
-          make test
+          poetry run poe generate
+          poetry run poe test
 
   build-release:
     runs-on: ubuntu-latest

diff --git a/Makefile b/Makefile
diff --git a/README.md b/README.md
@@ -314,10 +314,9 @@ datetime.datetime(2019, 1, 1, 11, 59, 58, 800000, tzinfo=datetime.timezone.utc)
 - [poetry](https://python-poetry.org/docs/#installation)
   *Needed to install dependencies in a virtual environment*
 
-- 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/))
-
-  *Needed to conveniently run development tasks.*
-  *Alternatively, manually run the commands defined in the [Makefile](./Makefile)*
+- [poethepoet](https://github.com/nat-n/poethepoet) for running development tasks as defined in pyproject.toml
+  - Can be installed to your host environment via `pip install poethepoet` then executed as simple `poe`
+  - or run from the poetry venv as `poetry run poe`
 
 ### Setup
 
@@ -329,16 +328,14 @@ poetry install
 poetry shell
 ```
 
-Run `make help` to see all available development tasks.
-
 ### Code style
 
 This project enforces [black](https://github.com/psf/black) python code formatting.
 
 Before committing changes run:
 
 ```sh
-make format
+poe format
 ```
 
 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.
 
 ```sh
 # Generate assets from sample .proto files required by the tests
-make generate
+poe generate
 # Run the tests
-make test
+poe test
 ```
 
 To run tests as they are run in CI (with tox) run:
 
 ```sh
-make full-test
+poe full-test
 ```
 
 ### (Re)compiling Google Well-known Types
@@ -401,7 +398,6 @@ protoc \
     /usr/local/include/google/protobuf/*.proto
 ```
 
-
 ### TODO
 
 - [x] Fixed length fields