.. _install:

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

This section of the documentation explains how to install **BrazilCEP**.

Supported Python Versions
-------------------------

**BrazilCEP** supports the following Python versions:

.. image:: https://img.shields.io/pypi/pyversions/brazilcep.svg
    :target: https://pypi.org/project/brazilcep/
    :alt: Python Version Support Badge

Install from PyPI
-----------------

To install **BrazilCEP** from PyPI, run the following command in your terminal::

     pip install brazilcep

Install from Source Code
------------------------

The source code for **BrazilCEP** is hosted on GitHub and is always available for download.

1. Clone the public repository::

         git clone https://github.com/mstuttgart/brazilcep.git

Or download the `tarball <https://github.com/mstuttgart/brazilcep/tarball/main>`_::

         curl -OL https://github.com/mstuttgart/brazilcep/tarball/main

2. Navigate to the project directory::

         cd brazilcep

3. Install the package in editable mode::

         pip install -e .

You can now use **BrazilCEP** in your Python projects.