1- ================
2- Dataclass Wizard
3- ================
41
52.. image :: https://raw.githubusercontent.com/rnag/dataclass-wizard/main/images/logo.png
63 :alt: Dataclass Wizard logo
@@ -9,7 +6,7 @@ Dataclass Wizard
96
107**Simple, elegant wizarding tools for Python’s ** ``dataclasses ``.
118
12- 📘 Docs → `dataclass-wizard .ritviknag.com `_
9+ 📘 Docs → `dcw .ritviknag.com `_
1310
1411.. image :: https://github.com/rnag/dataclass-wizard/actions/workflows/dev.yml/badge.svg
1512 :target: https://github.com/rnag/dataclass-wizard/actions/workflows/dev.yml
@@ -27,9 +24,7 @@ Dataclass Wizard
2724 :target: https://pepy.tech/project/dataclass-wizard
2825 :alt: Downloads per Month
2926
30- Lightning-fast ⚡, pure Python, and lightweight — Dataclass Wizard makes it easy
31- to convert dataclass instances to and from JSON, with built-in support for
32- complex dataclass models.
27+ **Dataclass Wizard ** is a fast, well-tested serialization library for Python dataclasses.
3328
3429-------------------
3530
@@ -161,7 +156,7 @@ of *Dataclass Wizard* for unsupported Python versions (3.6 – 3.8):
161156.. _PyPI : https://pypi.org/project/dataclass-wizard/
162157.. _conda : https://anaconda.org/conda-forge/dataclass-wizard
163158.. _conda-forge : https://conda-forge.org/
164- .. _Changelog : https://dataclass-wizard .ritviknag.com/en/latest/history.html
159+ .. _Changelog : https://dcw .ritviknag.com/en/latest/history.html
165160
166161See the package on `PyPI `_ and the `Changelog `_ in the docs for the latest version details.
167162
@@ -377,7 +372,7 @@ debugging purposes. Whenever you invoke ``print(obj)`` or ``str(obj)``, for
377372example, it'll call this method which will format the dataclass object as
378373a prettified JSON string. If you prefer a ``__str__ `` method to not be
379374added, you can pass in ``str=False `` when extending from the Mixin class
380- as mentioned `here <https://dataclass-wizard .ritviknag.com/en/latest/common_use_cases/skip_the_str.html >`_.
375+ as mentioned `here <https://dcw .ritviknag.com/en/latest/common_use_cases/skip_the_str.html >`_.
381376
382377Note that the ``__repr__ `` method, which is implemented by the
383378``dataclass `` decorator, is also available. To invoke the Python object
@@ -1277,7 +1272,7 @@ Quick Examples
12771272
12781273 Combine these helpers for flexible serialization rules!
12791274
1280- .. _conditional skipping : https://dataclass-wizard .ritviknag.com/en/latest/common_use_cases/serialization_options.html#skip-if-functionality
1275+ .. _conditional skipping : https://dcw .ritviknag.com/en/latest/common_use_cases/serialization_options.html#skip-if-functionality
12811276
12821277Serialization Options
12831278---------------------
@@ -1426,7 +1421,7 @@ Easily map environment variables to Python dataclasses with ``EnvWizard``:
14261421 - **Configurable **: Customize variable names, prefixes, and dotenv files.
14271422 - **Validation **: Errors for missing or malformed variables.
14281423
1429- 📖 `Full Documentation <https://dataclass-wizard .ritviknag.com/en/latest/env_magic.html >`_
1424+ 📖 `Full Documentation <https://dcw .ritviknag.com/en/latest/env_magic.html >`_
14301425
14311426Advanced Example: Dynamic Prefix Handling
14321427~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -1592,42 +1587,42 @@ Credits
15921587
15931588This package was created with Cookiecutter _ and the `rnag/cookiecutter-pypackage `_ project template.
15941589
1595- .. _ dataclass-wizard .ritviknag.com : https://dataclass-wizard .ritviknag.com
1590+ .. _ dcw .ritviknag.com : https://dcw .ritviknag.com
15961591.. _Cookiecutter : https://github.com/cookiecutter/cookiecutter
15971592.. _`rnag/cookiecutter-pypackage` : https://github.com/rnag/cookiecutter-pypackage
1598- .. _`Contributing` : https://dataclass-wizard .ritviknag.com/en/latest/contributing.html
1593+ .. _`Contributing` : https://dcw .ritviknag.com/en/latest/contributing.html
15991594.. _`open an issue` : https://github.com/rnag/dataclass-wizard/issues
1600- .. _`JSONPyWizard` : https://dataclass-wizard .ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#jsonpywizard
1601- .. _`EnvWizard` : https://dataclass-wizard .ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#envwizard
1602- .. _`on EnvWizard` : https://dataclass-wizard .ritviknag.com/en/latest/env_magic.html
1603- .. _`JSONListWizard` : https://dataclass-wizard .ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#jsonlistwizard
1604- .. _`JSONFileWizard` : https://dataclass-wizard .ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#jsonfilewizard
1605- .. _`TOMLWizard` : https://dataclass-wizard .ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#tomlwizard
1606- .. _`YAMLWizard` : https://dataclass-wizard .ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#yamlwizard
1607- .. _`Container` : https://dataclass-wizard .ritviknag.com/en/latest/dataclass_wizard.html#dataclass_wizard.Container
1608- .. _`Supported Types` : https://dataclass-wizard .ritviknag.com/en/latest/overview.html#supported-types
1595+ .. _`JSONPyWizard` : https://dcw .ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#jsonpywizard
1596+ .. _`EnvWizard` : https://dcw .ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#envwizard
1597+ .. _`on EnvWizard` : https://dcw .ritviknag.com/en/latest/env_magic.html
1598+ .. _`JSONListWizard` : https://dcw .ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#jsonlistwizard
1599+ .. _`JSONFileWizard` : https://dcw .ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#jsonfilewizard
1600+ .. _`TOMLWizard` : https://dcw .ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#tomlwizard
1601+ .. _`YAMLWizard` : https://dcw .ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#yamlwizard
1602+ .. _`Container` : https://dcw .ritviknag.com/en/latest/dataclass_wizard.html#dataclass_wizard.Container
1603+ .. _`Supported Types` : https://dcw .ritviknag.com/en/latest/overview.html#supported-types
16091604.. _`Mixin` : https://stackoverflow.com/a/547714/10237506
1610- .. _`Meta` : https://dataclass-wizard .ritviknag.com/en/latest/common_use_cases/meta.html
1605+ .. _`Meta` : https://dcw .ritviknag.com/en/latest/common_use_cases/meta.html
16111606.. _`pydantic` : https://pydantic-docs.helpmanual.io/
1612- .. _`Using Field Properties` : https://dataclass-wizard .ritviknag.com/en/latest/using_field_properties.html
1613- .. _`field properties` : https://dataclass-wizard .ritviknag.com/en/latest/using_field_properties.html
1614- .. _`custom mapping` : https://dataclass-wizard .ritviknag.com/en/latest/common_use_cases/custom_key_mappings.html
1615- .. _`wiz-cli` : https://dataclass-wizard .ritviknag.com/en/latest/wiz_cli.html
1607+ .. _`Using Field Properties` : https://dcw .ritviknag.com/en/latest/using_field_properties.html
1608+ .. _`field properties` : https://dcw .ritviknag.com/en/latest/using_field_properties.html
1609+ .. _`custom mapping` : https://dcw .ritviknag.com/en/latest/common_use_cases/custom_key_mappings.html
1610+ .. _`wiz-cli` : https://dcw .ritviknag.com/en/latest/wiz_cli.html
16161611.. _`key limitations` : https://florimond.dev/en/posts/2018/10/reconciling-dataclasses-and-properties-in-python/
1617- .. _`more complete example` : https://dataclass-wizard .ritviknag.com/en/latest/examples.html#a-more-complete-example
1612+ .. _`more complete example` : https://dcw .ritviknag.com/en/latest/examples.html#a-more-complete-example
16181613.. _custom formats : https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes
1619- .. _`Patterned Date and Time` : https://dataclass-wizard .ritviknag.com/en/latest/common_use_cases/patterned_date_time.html
1614+ .. _`Patterned Date and Time` : https://dcw .ritviknag.com/en/latest/common_use_cases/patterned_date_time.html
16201615.. _Union : https://docs.python.org/3/library/typing.html#typing.Union
1621- .. _`Dataclasses in Union Types` : https://dataclass-wizard .ritviknag.com/en/latest/common_use_cases/dataclasses_in_union_types.html
1622- .. _`Cyclic or "Recursive" Dataclasses` : https://dataclass-wizard .ritviknag.com/en/latest/common_use_cases/cyclic_or_recursive_dataclasses.html
1616+ .. _`Dataclasses in Union Types` : https://dcw .ritviknag.com/en/latest/common_use_cases/dataclasses_in_union_types.html
1617+ .. _`Cyclic or "Recursive" Dataclasses` : https://dcw .ritviknag.com/en/latest/common_use_cases/cyclic_or_recursive_dataclasses.html
16231618.. _as milestones : https://github.com/rnag/dataclass-wizard/milestones
16241619.. _longstanding issue : https://github.com/rnag/dataclass-wizard/issues/62
1625- .. _Easier Debug Mode : https://dataclass-wizard .ritviknag.com/en/latest/common_use_cases/easier_debug_mode.html
1626- .. _Handling Unknown JSON Keys : https://dataclass-wizard .ritviknag.com/en/latest/common_use_cases/handling_unknown_json_keys.html
1627- .. _custom paths to access nested keys : https://dataclass-wizard .ritviknag.com/en/latest/common_use_cases/nested_key_paths.html
1620+ .. _Easier Debug Mode : https://dcw .ritviknag.com/en/latest/common_use_cases/easier_debug_mode.html
1621+ .. _Handling Unknown JSON Keys : https://dcw .ritviknag.com/en/latest/common_use_cases/handling_unknown_json_keys.html
1622+ .. _custom paths to access nested keys : https://dcw .ritviknag.com/en/latest/common_use_cases/nested_key_paths.html
16281623.. _annotations : https://docs.python.org/3/library/typing.html#typing.Annotated
16291624.. _typing : https://docs.python.org/3/library/typing.html
16301625.. _dataclasses : https://docs.python.org/3/library/dataclasses.html
1631- .. _V1 Opt-in documentation for Patterned Date and Time : https://dataclass-wizard .ritviknag.com/en/latest/common_use_cases/v1_patterned_date_time.html
1626+ .. _V1 Opt-in documentation for Patterned Date and Time : https://dcw .ritviknag.com/en/latest/common_use_cases/v1_patterned_date_time.html
16321627.. _`Field Guide to V1 Opt-in` : https://github.com/rnag/dataclass-wizard/wiki/Field-Guide-to-V1-Opt%E2%80%90in
1633- .. _V1 Alias : https://dataclass-wizard .ritviknag.com/en/latest/common_use_cases/v1_alias.html
1628+ .. _V1 Alias : https://dcw .ritviknag.com/en/latest/common_use_cases/v1_alias.html
0 commit comments