Deploy v0.4.0 (#25)

* feat: unified trading data class * fix: defillama wrong parameter name * feat: bump up version to v0.4.0
Bisonai · Jun 4, 2024 · 6f267d2 · 6f267d2
1 parent 00ec17e
commit 6f267d2
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 4 deletions.
diff --git a/datamaxi/__version__.py b/datamaxi/__version__.py
@@ -1 +1 @@
-__version__ = "0.3.0"
+__version__ = "0.4.0"
diff --git a/datamaxi/defillama/__init__.py b/datamaxi/defillama/__init__.py
@@ -155,11 +155,11 @@ def mcap(self, protocol: str, pandas: bool = True) -> Union[List, pd.DataFrame]:
         <https://docs.datamaxiplus.com/defillama/mcap>
 
         Args:
-            protocols (str): Protocol name
+            protocol (str): Protocol name
             pandas (bool): Return data as pandas DataFrame
 
         Returns:
-            Timeseries of market cap for given protocols
+            Timeseries of market cap for given protocol
         """
         check_required_parameter(protocol, "protocol")
         params = {

diff --git a/docs/datamaxi.md b/docs/datamaxi.md
@@ -0,0 +1,6 @@
+# Unified Trading Data
+
+::: datamaxi.datamaxi
+    options:
+      show_submodules: false
+      show_source: false
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -30,6 +30,7 @@ markdown_extensions:
 nav:
   - Main: index.md
   - API: api.md
+  - Unified Trading Data: datamaxi.md
   - CEX:
       - Binance: binance.md
       - Bithumb: bithumb.md

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "datamaxi"
-version = "0.3.0"
+version = "0.4.0"
 authors = [
   { name="Bisonai", email="[email protected]" },
 ]