Skip to content

Commit

Permalink
fix: dependencies and documentation (#252)
Browse files Browse the repository at this point in the history
Co-authored-by: Marcos Schroh <marcos.schroh@kpn.com>
  • Loading branch information
marcosschroh and marcosschroh committed Mar 6, 2023
1 parent 00d73f5 commit de29b72
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 5 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ or with `pydantic` funcionalities
pip install 'dataclasses-avroschema[pydantic]'
```

or with command line [dc-avro](https://marcosschroh.github.io/dc-avro/)

```bash
pip install 'dataclasses-avroschema[cli]'
```

## Documentation

https://marcosschroh.github.io/dataclasses-avroschema/
Expand Down
8 changes: 7 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,13 @@ pip install dataclasses-avroschema
or with `pydantic` funcionalities

```bash
pip install dataclasses-avroschema[pydantic]
pip install 'dataclasses-avroschema[pydantic]'
```

or with command line [dc-avro](https://marcosschroh.github.io/dc-avro/)

```bash
pip install 'dataclasses-avroschema[cli]'
```

## Usage
Expand Down
4 changes: 2 additions & 2 deletions docs/model_generator.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The rendered result is a string that contains the proper identation, so the resu
In future releases it will be possible to generate models for other programming langagues like `java` and `rust`

!!! note
Soon with [dc-avro](https://github.com/marcosschroh/dc-avro) will be possible to generate the models from the command line
You can also use [dc-avro](https://github.com/marcosschroh/dc-avro)d to generate the models from the command line

## Usage

Expand Down Expand Up @@ -360,4 +360,4 @@ print(User.fake())
| timestamp-millis| datetime.datetime|
| timestamp-micros| types.DateTimeMicro|
| decimal | decimal.Decimal|
| uuid | uuid.uuid4 |
| uuid | uuid.UUID |
5 changes: 3 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,14 @@
"inflect>=5.3.0",
"fastavro>=1.7.0",
"pytz",
"dacite>=1.6.0",
"faker>=8.1.1",
"dacite>=1.8.0",
"faker>=17.6.0",
'typing_extensions>=3.7.4;python_version<"3.9"',
"stringcase>=1.2.0",
],
extras_require={
"pydantic": ["pydantic>=1.9.0"],
"cli": ["dc-avro>=0.6.1"],
},
author_email="schrohm@gmail.com",
url="https://github.com/marcosschroh/dataclasses-avroschema",
Expand Down

0 comments on commit de29b72

Please sign in to comment.