Metadata-Version: 2.4
Name: dexsnake
Version: 0.1.0
Summary: A Python package for trading on decentralized exchanges like Uniswap.
Author-email: Leevi Kerkelä <leevi.kerkela@protonmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/kerkelae/dexsnake
Project-URL: Documentation, https://dexsnake.readthedocs.io/
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: web3<8,>=7
Dynamic: license-file

Dexsnake
========

Dexsnake is a lightweight Python package that makes it easy to make trades on
decentralized exchanges (DEXs) like `Uniswap <https://uniswap.org/>`_. The package is
designed for Python developers, quants, data scientists, algorithmic traders, and others
who are used to working in Python but may not have in-depth knowledge about blockchains
and decentralized apps. The code is organized to closely follow the structure of the
smart contracts, ensuring that by using Dexsnake, users also gain an understanding of
the underlying protocols.

Installation
############

.. note::

   Dexsnake is under active development. Its API may change before version 1.0.
   Review transaction parameters carefully before trading with real funds.

The most recent release can be installed with `pip <https://pip.pypa.io/>`_:

.. code-block::

   pip install dexsnake

The development version can be installed from GitHub:

.. code-block::

   pip install git+https://github.com/kerkelae/dexsnake.git

Contributing
############

See the `Contributing guide <https://dexsnake.readthedocs.io/en/latest/contributing.html>`_
for development setup and tests.
