.. highlight:: shell

============
Installation
============


Stable release
--------------

To install Dataclass Wizard, run this command in your terminal:

.. code-block:: console

    $ pip install dataclass-wizard

This is the preferred method to install Dataclass Wizard, as it will always install the most recent stable release.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

Dataclass Wizard is also available `on conda`_ under the `conda-forge`_ channel:

.. code-block:: console

    $ conda install dataclass-wizard -c conda-forge

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
.. _conda: https://www.anaconda.com/
.. _conda-forge: https://conda-forge.org/
.. _on conda: https://anaconda.org/conda-forge/dataclass-wizard

From sources
------------

The sources for Dataclass Wizard can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone git://github.com/rnag/dataclass-wizard

Or download the `tarball`_:

.. code-block:: console

    $ curl -OJL https://github.com/rnag/dataclass-wizard/tarball/main

Once you have a copy of the source, you can install it with:

.. code-block:: console

    $ python setup.py install


.. _Github repo: https://github.com/rnag/dataclass-wizard
.. _tarball: https://github.com/rnag/dataclass-wizard/tarball/main
