Skip to content

Commit

Permalink
Document schemes argument
Browse files Browse the repository at this point in the history
  • Loading branch information
sloria committed Feb 6, 2024
1 parent 40750fa commit 1f0ded4
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ It allows you to store configuration separate from your code, as per
- [Variable expansion](#variable-expansion)
- [Validation](#validation)
- [Deferred validation](#deferred-validation)
- [URL schemes](#url-schemes)
- [Serialization](#serialization)
- [Defining custom parser behavior](#defining-custom-parser-behavior)
- [Usage with Flask](#usage-with-flask)
Expand Down Expand Up @@ -257,6 +258,16 @@ env.seal()

`env.seal()` validates all parsed variables and prevents further parsing (calling a parser method will raise an error).

## URL schemes

`env.url()` supports non-standard URL schemes via the `schemes` argument.

```python
REDIS_URL = env.url(
"REDIS_URL", "redis://redis:6379", schemes=["redis"], require_tld=False
)
```

## Serialization

```python
Expand Down

0 comments on commit 1f0ded4

Please sign in to comment.