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

The Python BingX API Client can be installed using either `pip` or `poetry`.

Prerequisites
-------------

- **Python 3.10 or higher**: The client is compatible with Python 3.10 and above.
- **pip**: The Python package installer. If you don't have it, install it by following the official guide: https://pip.pypa.io/en/stable/installation/.
- **poetry** (optional): A dependency management tool for Python. Install it by following the official guide: https://python-poetry.org/docs/#installation.

Using pip
---------

To install the Python BingX API Client using `pip`, run the following command:

.. code-block:: bash

   pip install bingx-py

To install a specific version:

.. code-block:: bash

   pip install bingx-py==1.0.0

Using poetry
------------

To add the Python BingX API Client to your project using `poetry`, run:

.. code-block:: bash

   poetry add bingx-py

To install a specific version:

.. code-block:: bash

   poetry add bingx-py@1.0.0

Upgrading the Client
--------------------

To upgrade to the latest version:

.. code-block:: bash

   pip install --upgrade bingx-py

Or, if using `poetry`:

.. code-block:: bash

   poetry update bingx-py

Uninstalling the Client
-----------------------

To uninstall the client:

.. code-block:: bash

   pip uninstall bingx-py

Or, if using `poetry`:

.. code-block:: bash

   poetry remove bingx-py