Skip to content

Commit

Permalink
Merge branch 'master' into release-prep
Browse files Browse the repository at this point in the history
  • Loading branch information
clay committed Mar 2, 2023
2 parents 7ddc20a + e8842c7 commit 81c234d
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,9 @@ Commands:

### Installation

`esque` is available at [pypi.org](https://pypi.org/project/esque/) and can be installed with `pip install esque`. `esque` requires Python 3.6+ to run.
`esque` is available at [pypi.org](https://pypi.org/project/esque/) and can be installed with `pip install esque`.

`esque` requires Python 3.8+ to run (Python 3.11 is not yet supported).

#### Installation on Alpine Linux

Expand All @@ -91,6 +93,19 @@ There are no wheels for Alpine Linux, so `esque` requires a few extra dependenci
apk add python3-dev py3-pip librdkafka librdkafka-dev g++
```

#### Installation on Apple Silicon

The installation for Kafka is slightly different for Apple Silicon devices, so simply running `pip install esque` may
result in errors.

The fix for this is to first install the librdkafka library with `brew install librdkafka` (make note of which version is installed).
Then, add the following to the `.zshrc` file with the correct version of librdkafka:
```bash
export C_INCLUDE_PATH=/opt/homebrew/Cellar/librdkafka/X.X.X/include/
export LIBRARY_PATH=/opt/homebrew/Cellar/librdkafka/X.X.X/lib/
```
After starting a new shell (or `source ~/.zshrc`), you will be able to install `esque` normally with pip.

### Autocompletion

The autocompletion scripts for `bash` and `zsh` can be generated by running `esque config autocomplete`.
Expand Down Expand Up @@ -156,7 +171,7 @@ topics:

## Development

To setup your development environment, make sure you have at least Python 3.6 & [poetry](https://github.com/sdispater/poetry) installed, then run
To setup your development environment, make sure you have at least Python 3.8 & [poetry](https://github.com/sdispater/poetry) installed, then run

```bash
poetry install
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ esque = "esque.cli.commands:esque"

# Dependencies
[tool.poetry.dependencies]
python = "^3.8"
python = ">=3.8,<3.11"

avro-python3 = "^1.9"
click = "8.1.3"
Expand Down

0 comments on commit 81c234d

Please sign in to comment.