Skip to content

Commit f119d55

Browse files
committed
Move fastavro to extras group
1 parent 9f701b5 commit f119d55

File tree

3 files changed

+12
-6
lines changed

3 files changed

+12
-6
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,17 @@ Clone this repository and install it:
3333
python setup.py install -e .
3434
```
3535

36-
This library includes opt-in extra dependencies that enable support for certain features. For example, to use the schema registry with [kafka-python](https://pypi.org/project/kafka-python/), you should install the `kafka-python` extra:
36+
You most likely want to install one or more extras. For example, to use the schema registry with Avro schemas and [kafka-python](https://pypi.org/project/kafka-python/), you should install the `avro` and `kafka-python` extra:
3737

3838
```
39-
python setup.py install -e .[kafka-python]
39+
python setup.py install -e .[avro, kafka-python]
4040
```
4141

42+
Extra name | Purpose
43+
:--------- | :------
44+
avro | Allows using Apache Avro schemas, using `fastavro` as a backend
45+
kafka-python | Provides adapter classes to plug into `kafka-python`
46+
4247
## Usage
4348

4449
First use `boto3` to create a low-level AWS Glue client:

setup.cfg

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ classifiers =
1919
Programming Language :: Python :: 3.9
2020
Topic :: Software Development :: Libraries
2121
Typing :: Typed
22-
keywords = aws, glue, schema, registry
22+
keywords = aws, glue, schema, registry, avro
2323
project_urls =
2424
Source=https://github.com/DisasterAWARE/aws-glue-schema-registry-python
2525

@@ -32,7 +32,6 @@ package_dir =
3232
python_requires = >=3.7
3333
install_requires =
3434
boto3>=1.18.48
35-
fastavro>=1.4.5
3635
typing-extensions>=3.10.0.2;python_version<"3.8"
3736
setup_requires =
3837
setuptools
@@ -41,6 +40,8 @@ setup_requires =
4140
dev =
4241
pytest>=6
4342
flake8>=3
43+
avro =
44+
fastavro>=1.4.5
4445
kafka-python =
4546
kafka-python>=2
4647

tox.ini

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ python =
1010
[testenv]
1111
deps = pytest
1212
commands =
13-
pip install . .[dev]
13+
pip install . .[dev] .[avro] .[kafka-python]
1414
python -m pytest --ignore tests/integration
1515

1616
[testenv:flake8]
@@ -20,7 +20,7 @@ commands = flake8
2020
[testenv:mypy]
2121
deps = mypy
2222
commands =
23-
pip install . .[dev]
23+
pip install . .[dev] .[avro] .[kafka-python]
2424
python -m mypy
2525

2626
[pytest]

0 commit comments

Comments
 (0)