Skip to content

Commit

Permalink
chore: add instruction how to install with toml and yaml support
Browse files Browse the repository at this point in the history
Signed-off-by: Sami Jaghouar <[email protected]>
  • Loading branch information
samsja committed Sep 2, 2024
1 parent 5a12ba8 commit e505030
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,16 @@ python main.py --train @train_config.yaml

**Note:pydantic_config will look at the file extension to determine the file type.**

If you want to use `toml` or `yaml` file you need to install using
```
pip install .[toml]
```
or

```
pip install .[yaml]
```

# Development

This project use [uv](https://github.com/astral-sh/uv) to manage python.
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ requires-python = ">= 3.10"
[project.optional-dependencies]
yaml = ["pyyaml"]
toml = ["tomli"]
all = ["pyyaml", "tomli"]

[tool.ruff]
line-length = 120
Expand Down
6 changes: 6 additions & 0 deletions uv.lock

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

0 comments on commit e505030

Please sign in to comment.