Skip to content

Commit

Permalink
Don't write configzen in italic
Browse files Browse the repository at this point in the history
  • Loading branch information
bswck committed Feb 20, 2024
1 parent 63f8b66 commit 61bdfb5
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
Manage configuration with pydantic.

> [!Warning]
> _configzen_ is currently under huge refactoring to work with pydantic v2.
> configzen is currently under huge refactoring to work with pydantic v2.
> The API is subject to change.
It's important to keep your configuration safe and consistent. Give a shot to _configzen_, because it:
It's important to keep your configuration safe and consistent. Give a shot to configzen, because it:

⭐ Supports **Python 3.8 or above**,<br>
⭐ Is **fully typed**,<br>
Expand All @@ -20,7 +20,7 @@ It's important to keep your configuration safe and consistent. Give a shot to _c
⭐ Supports **synchronous and asynchronous file operations**,<br>
⭐ Supports loading configuration from **environment variables and secret files**.<br>

While being built on top of [pydantic](https://docs.pydantic.dev/2.6/), _configzen_ inherits most of its features, including
While being built on top of [pydantic](https://docs.pydantic.dev/2.6/), configzen inherits most of its features, including
[data validation](https://docs.pydantic.dev/2.6/concepts/models/#validation), [schema generation](https://docs.pydantic.dev/2.6/api/base_model/#pydantic.BaseModel.model_json_schema),
[custom data types](https://docs.pydantic.dev/2.6/api/config/#pydantic.config.ConfigDict.arbitrary_types_allowed), good integration with [Rich](https://docs.pydantic.dev/2.6/integrations/rich/), and more.

Expand All @@ -39,7 +39,7 @@ port: 5432
user: postgres
```
You can create a _configzen_ configuration model for it like this:
You can create a configzen configuration model for it like this:
```python
# model.py
Expand Down Expand Up @@ -75,7 +75,7 @@ for more information.
Configuration models inherit from the `pydantic.BaseSettings` class, so you can use all of its features:
schema generation, type conversion, validation, etc.

There are additional features brought to you by _configzen_ worth checking out, though.
There are additional features brought to you by configzen worth checking out, though.

You can use the `db_config` object defined above to access the configuration values:

Expand Down
4 changes: 2 additions & 2 deletions configzen/errors.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""`configzen.errors`: Specialized exceptions raised by _configzen_."""
"""`configzen.errors`: Specialized exceptions raised by configzen."""
from __future__ import annotations

from typing import TYPE_CHECKING
Expand All @@ -19,7 +19,7 @@


class ConfigurationError(Exception):
"""Base class for all errors related to _configzen_."""
"""Base class for all errors related to configzen."""

def __init__(self, message: str) -> None:
super().__init__(message)
Expand Down
3 changes: 2 additions & 1 deletion configzen/formats/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""`configzen.formats`: Data formats supported natively by _configzen_."""
"""`configzen.formats`: Data formats supported natively by configzen."""
from __future__ import annotations

from . import std_json, std_plist, toml, yaml
from .std_json import * # noqa: F403
Expand Down

0 comments on commit 61bdfb5

Please sign in to comment.