Replace Makefile with poe tasks in pyproject.yaml (#118)

https://github.com/nat-n/poethepoet
This commit is contained in:
nat
2020-07-25 20:54:40 +03:00
committed by GitHub
parent c1a76a5f5e
commit c513853301
5 changed files with 549 additions and 70 deletions

View File

@@ -328,10 +328,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
@@ -344,8 +343,6 @@ 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.
@@ -353,7 +350,7 @@ This project enforces [black](https://github.com/psf/black) python code formatti
Before committing changes run:
```sh
make format
poe format
```
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.
```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
@@ -416,7 +413,6 @@ protoc \
/usr/local/include/google/protobuf/*.proto
```
### TODO
- [x] Fixed length fields