Adding glossary links

tradingstrategy-ai · Jul 22, 2023 · 9cdb25a · 9cdb25a
1 parent e415516
commit 9cdb25a
Show file tree

Hide file tree

Showing 6 changed files with 831 additions and 16 deletions.
diff --git a/docs/source/_static/logo-wall-2.svg b/docs/source/_static/logo-wall-2.svg
diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst
@@ -1,5 +1,7 @@
 .. meta::
-   :description: Uniswap and Aave Python APIs
+   :description: Uniswap, Aave and Defi Python APIs
+
+.. _api documentation:
 
 API documentation
 =================

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,22 +1,24 @@
-Web3-Ethereum-Defi package documentation
-========================================
+Web3-Ethereum-Defi for Python
+=============================
 
 .. meta::
    :description: Web3 and DeFi API for Python
 
-Welcome to the documentation for Python `web3-ethereum-defi <https://github.com/tradingstrategy-ai/web3-ethereum-defi>`__ package.
+.. image:: logo-wall-white.png
 
-The project contains high level Python API for smart contracts,
-DeFi trading, wallet management, automated test suites and backend integrations on EVM based blockchains.
-Supported blockchains include Ethereum, BNB Chain, Polygon, Avalanche C-chain, Arbitrum, others.
+Welcome to the documentation for Python `web3-ethereum-defi <https://github.com/tradingstrategy-ai/web3-ethereum-defi>`__ package.
 
-Supported DeFi protocols include Uniswap and its forks (PancakeSwap, Trader Joe, QuickSwap),
-Aave, Enzyme, dHEDGE, Chainlink.
+The :py:mod:`eth_defi` Python package contains high level API for smart contracts,
+DeFi trading, wallet management, JSON-RPC providers,
+automated test suites and backend integrations for EVM-based blockchains.
 
-The project builts on the top of `Web3.py library <https://web3py.readthedocs.io/en/stable/>`__,
-adding better developer experience through integrations, debug tools and documentation.
+- Supported `blockchains <https://tradingstrategy.ai/glossary>`__ include, but not limited to,
+  Ethereum, BNB Chain, Polygon, Avalanche C-chain, Arbitrum and other `EVM-compatible blockchains <https://tradingstrategy.ai/glossary/evm-compatible>`__.
 
-See `the project README for more information <https://github.com/tradingstrategy-ai/web3-ethereum-defi>`__.
+- Supported `DeFi <https://tradingstrategy.ai/glossary/decentralised-finance>`__ `protocols <https://tradingstrategy.ai/glossary/protocol>`__ include `Uniswap <https://tradingstrategy.ai/glossary/uniswap>`__
+  with its `clones <https://tradingstrategy.ai/glossary/fork>`__, `Aave <https://tradingstrategy.ai/glossary/aave>`__,
+  `USDC <https://tradingstrategy.ai/glossary/usdc>`__ and Circle `stablecoin tokens <https://tradingstrategy.ai/glossary/stablecoin>`__,
+  `Enzyme <https://tradingstrategy.ai/glossary/enzyme-protocol>`__, Chainlink and many others.
 
 Table of contents
 =================

diff --git a/docs/source/logo-wall-white.png b/docs/source/logo-wall-white.png
diff --git a/eth_defi/__init__.py b/eth_defi/__init__.py
@@ -1,17 +1,23 @@
+"""eth_defi package root.
+
+See :ref:`api documentation` for more details.
+
+"""
+
 import sys
 
 
-# Minimum required Python version
-_MIN_VERSION = (3, 9)
+#: Minimum required Python version to run this package
+MIN_PYTHON_VERSION = (3, 9)
 
 
 def _check_python_version():
     """Try early abort if the Python version is too old."""
 
     # Use Python tuple comparison for version numbers
     # https://stackoverflow.com/a/1093331/315168
-    if sys.version_info < _MIN_VERSION:
-        raise RuntimeError(f"web3-ethereum-defi needs Python {_MIN_VERSION[0]}.{_MIN_VERSION[1]} or later")
+    if sys.version_info < MIN_PYTHON_VERSION:
+        raise RuntimeError(f"web3-ethereum-defi needs Python {MIN_PYTHON_VERSION[0]}.{MIN_PYTHON_VERSION[1]} or later")
 
 
 _check_python_version()
diff --git a/eth_defi/hotwallet.py b/eth_defi/hotwallet.py
@@ -20,6 +20,7 @@
 
 from eth_defi.tx import decode_signed_transaction
 
+
 logger = logging.getLogger(__name__)