Skip to content

Commit

Permalink
fix: extra option with cli added in pyproject. Requirements fixed. Cl…
Browse files Browse the repository at this point in the history
…oses #711 (#718)
  • Loading branch information
marcosschroh authored Aug 13, 2024
1 parent 83725cc commit 0f6056e
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 35 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ jobs:
strategy:
fail-fast: false
matrix:
python-version: ["3.8", "3.9", "3.10", "3.11"]
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
steps:
- uses: actions/checkout@v4
- name: Setup python
- name: Setup pythonß
uses: actions/setup-python@v5
with:
cache: "pip"
Expand Down
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,9 @@ with `pip` or `poetry`:
- [pydantic](https://docs.pydantic.dev/): `pip install 'dataclasses-avroschema[pydantic]'` or `poetry add dataclasses-avroschema --extras "pydantic"`
- [faust-streaming](https://github.com/faust-streaming/faust): `pip install 'dataclasses-avroschema[faust]'` or `poetry add dataclasses-avroschema --extras "faust"`
- [faker](https://github.com/joke2k/faker): `pip install 'dataclasses-avroschema[faker]'` or `poetry add dataclasses-avroschema --extras "faker"`
- [dc-avro](https://marcosschroh.github.io/dc-avro/): `pip install 'dataclasses-avroschema[cli]'` or `poetry add dataclasses-avroschema --with cli`

*Note*: You can install all extra dependencies with `pip install dataclasses-avroschema[faust, pydantic, faker]` or `poetry add dataclasses-avroschema --extras "pydantic faust faker"`

### CLI

To install `avro schemas cli` install [dc-avro](https://marcosschroh.github.io/dc-avro/)

`pip install 'dataclasses-avroschema[cli]'` or `poetry add dataclasses-avroschema --with cli`
*Note*: You can install all extra dependencies with `pip install dataclasses-avroschema[faust,pydantic,faker,cli]` or `poetry add dataclasses-avroschema --extras "pydantic faust faker cli"`

## Documentation

Expand Down
9 changes: 2 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,9 @@ with `pip` or `poetry`:
- [pydantic](https://docs.pydantic.dev/): `pip install 'dataclasses-avroschema[pydantic]'` or `poetry add dataclasses-avroschema --extras "pydantic"`
- [faust-streaming](https://github.com/faust-streaming/faust): `pip install 'dataclasses-avroschema[faust]'` or `poetry add dataclasses-avroschema --extras "faust "`
- [faker](https://github.com/joke2k/faker): `pip install 'dataclasses-avroschema[faker]'` or `poetry add dataclasses-avroschema --extras "faker"`
- [dc-avro](https://marcosschroh.github.io/dc-avro/): `pip install 'dataclasses-avroschema[cli]'` or `poetry add dataclasses-avroschema --with cli`

*Note*: You can install all extra dependencies with `pip install dataclasses-avroschema[faust, pydantic, faker]` or `poetry add dataclasses-avroschema --extras "pydantic faust faker"`

### CLI

To install `avro schemas cli` install [dc-avro](https://marcosschroh.github.io/dc-avro/)

`pip install 'dataclasses-avroschema[cli]'` or `poetry add dataclasses-avroschema --with cli`
*Note*: You can install all extra dependencies with `pip install dataclasses-avroschema[faust,pydantic,faker,cli]` or `poetry add dataclasses-avroschema --extras "pydantic faust faker cli"`

## Usage

Expand Down
33 changes: 17 additions & 16 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 4 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ casefy = "^0.1.7"
typing-extensions = "^4.2.0"
pydantic = {version = "^2.4.2", optional = true, extras = ["email"]}
python-dateutil = "^2.9.0.post0"
dc-avro = {version =">=0.6.4,<0.9.0", optional = true}

[tool.poetry.group.dev.dependencies]
mypy = "^1.8.0"
Expand All @@ -45,9 +46,6 @@ mkdocs-material = "^9"
mkdocstrings = {version = ">=0.24,<0.26", extras = ["python"]}
mktestdocs = "^0.2.2"

[tool.poetry.group.cli.dependencies]
dc-avro = ">=0.6.4,<0.9.0"

[tool.poetry.group.ci-publish.dependencies]
commitizen = "^3.2.2"

Expand All @@ -61,6 +59,9 @@ faust = [
faker = [
"faker"
]
cli = [
"dc-avro"
]

[build-system]
requires = ["poetry-core"]
Expand Down

0 comments on commit 0f6056e

Please sign in to comment.