Merge pull request #15 from aoki-h-jp/feature/1.0.4/importerror

Feature/1.0.4/importerror
aoki-h-jp · Aug 25, 2023 · 04965f5 · 04965f5
2 parents 3df7bf5 + fcddab9
commit 04965f5
Show file tree

Hide file tree

Showing 33 changed files with 58 additions and 52 deletions.
diff --git a/README.md b/README.md
@@ -14,22 +14,28 @@ pip install git+https://github.com/aoki-h-jp/binance-bulk-downloader
 
 ## Usage
 ### Download all klines 1m data (USDT-M futures)
+
 ```python
-from downloader import BinanceBulkDownloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
+
 downloader = BinanceBulkDownloader()
 downloader.run_download()
 ```
 
 ### Download all klines 1h data (Spot)
+
 ```python
-from downloader import BinanceBulkDownloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
+
 downloader = BinanceBulkDownloader(data_frequency='1h', asset='spot')
 downloader.run_download()
 ```
 
 ### Download all aggTrades data (USDT-M futures)
+
 ```python
-from downloader import BinanceBulkDownloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
+
 downloader = BinanceBulkDownloader(data_type='aggTrades')
 downloader.run_download()
 ```
@@ -48,7 +54,7 @@ python -m pytest
 ```
 
 ## Available data types
-✅: Implemented and tested. ❌:Not available on Binance.
+✅: Implemented and tested. ❌: Not available on Binance.
 
 ### by data_type
 

diff --git a/__init__.py b/__init__.py
diff --git a/downloader/__init__.py → binance_bulk_downloader/__init__.py b/downloader/__init__.py → binance_bulk_downloader/__init__.py
@@ -1,4 +1,5 @@
 """
 BinanceBulkDownloader: A library to efficiently and concurrently download historical data from Binance.
 """
-from .downloader import BinanceBulkDownloader
+import binance_bulk_downloader.downloader
+import binance_bulk_downloader.exceptions
diff --git a/downloader/downloader.py → binance_bulk_downloader/downloader.py b/downloader/downloader.py → binance_bulk_downloader/downloader.py
@@ -14,8 +14,8 @@
 from rich.progress import track
 
 # import my libraries
-from .exceptions import (BinanceBulkDownloaderDownloadError,
-                         BinanceBulkDownloaderParamsError)
+from binance_bulk_downloader.exceptions import (
+    BinanceBulkDownloaderDownloadError, BinanceBulkDownloaderParamsError)
 
 
 class BinanceBulkDownloader:

diff --git a/downloader/exceptions.py → binance_bulk_downloader/exceptions.py b/downloader/exceptions.py → binance_bulk_downloader/exceptions.py
diff --git a/example/__init__.py b/example/__init__.py
diff --git a/example/download_aggtrades.py b/example/download_aggtrades.py
@@ -1,5 +1,5 @@
-# import downloader
-from downloader import BinanceBulkDownloader
+# import binance_bulk_downloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 # generate instance
 downloader = BinanceBulkDownloader(data_type="aggTrades")

diff --git a/example/download_bookdepth.py b/example/download_bookdepth.py
@@ -1,5 +1,5 @@
-# import downloader
-from downloader import BinanceBulkDownloader
+# import binance_bulk_downloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 # generate instance
 downloader = BinanceBulkDownloader(data_type="bookDepth")

diff --git a/example/download_bookticker.py b/example/download_bookticker.py
@@ -1,5 +1,5 @@
-# import downloader
-from downloader import BinanceBulkDownloader
+# import binance_bulk_downloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 # generate instance
 downloader = BinanceBulkDownloader(data_type="bookTicker")

diff --git a/example/download_bvolindex.py b/example/download_bvolindex.py
@@ -1,5 +1,5 @@
-# import downloader
-from downloader import BinanceBulkDownloader
+# import binance_bulk_downloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 # generate instance
 downloader = BinanceBulkDownloader(data_type="BVOLIndex", asset="option")

diff --git a/example/download_eohsummary.py b/example/download_eohsummary.py
@@ -1,5 +1,5 @@
-# import downloader
-from downloader import BinanceBulkDownloader
+# import binance_bulk_downloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 # generate instance
 downloader = BinanceBulkDownloader(data_type="EOHSummary", asset="option")

diff --git a/example/download_fundingrate.py b/example/download_fundingrate.py
@@ -1,5 +1,5 @@
-# import downloader
-from downloader import BinanceBulkDownloader
+# import binance_bulk_downloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 # generate instance
 downloader = BinanceBulkDownloader(

diff --git a/example/download_indexpriceklines.py b/example/download_indexpriceklines.py
@@ -1,5 +1,5 @@
-# import downloader
-from downloader import BinanceBulkDownloader
+# import binance_bulk_downloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 # generate instance
 downloader = BinanceBulkDownloader(data_type="indexPriceKlines")

diff --git a/example/download_klines.py b/example/download_klines.py
@@ -1,5 +1,5 @@
-# import downloader
-from downloader import BinanceBulkDownloader
+# import binance_bulk_downloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 # generate instance
 downloader = BinanceBulkDownloader()

diff --git a/example/download_liquidationsnapshot.py b/example/download_liquidationsnapshot.py
@@ -1,5 +1,5 @@
-# import downloader
-from downloader import BinanceBulkDownloader
+# import binance_bulk_downloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 # generate instance
 downloader = BinanceBulkDownloader(data_type="liquidationSnapshot")

diff --git a/example/download_markpriceklines.py b/example/download_markpriceklines.py
@@ -1,5 +1,5 @@
-# import downloader
-from downloader import BinanceBulkDownloader
+# import binance_bulk_downloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 # generate instance
 downloader = BinanceBulkDownloader(data_type="markPriceKlines")

diff --git a/example/download_metrics.py b/example/download_metrics.py
@@ -1,5 +1,5 @@
-# import downloader
-from downloader import BinanceBulkDownloader
+# import binance_bulk_downloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 # generate instance
 downloader = BinanceBulkDownloader(data_type="metrics")

diff --git a/example/download_premiumindexklines.py b/example/download_premiumindexklines.py
@@ -1,5 +1,5 @@
-# import downloader
-from downloader import BinanceBulkDownloader
+# import binance_bulk_downloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 # generate instance
 downloader = BinanceBulkDownloader(data_type="premiumIndexKlines")

diff --git a/example/download_trades.py b/example/download_trades.py
@@ -1,5 +1,5 @@
-# import downloader
-from downloader import BinanceBulkDownloader
+# import binance_bulk_downloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 # generate instance
 downloader = BinanceBulkDownloader(data_type="trades")

diff --git a/setup.py b/setup.py
@@ -1,12 +1,12 @@
-from setuptools import find_packages, setup
+from setuptools import setup
 
 setup(
     name="binance-bulk-downloader",
-    version="1.0.2",
-    description="A Python library to efficiently and concurrently download historical data files from Binance. Supports multiple asset types (spot, futures, options) and various data frequencies.",
-    install_requires=[],
+    version="1.0.4",
+    description="A Python library to efficiently and concurrently download historical data files from Binance. Supports all asset types (spot, futures, options) and all frequencies.",
+    install_requires=["requests", "rich", "pytest"],
     author="aoki-h-jp",
     author_email="[email protected]",
     license="MIT",
-    packages=find_packages(include=["downloader"], exclude=["tests", "example"]),
+    packages=["binance_bulk_downloader"],
 )
diff --git a/tests/test_aggtrades.py b/tests/test_aggtrades.py
@@ -5,7 +5,7 @@
 import pytest
 
 # import my libraries
-from downloader import BinanceBulkDownloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 
 def dynamic_aggtrades_test_params():

diff --git a/tests/test_bookdepth.py b/tests/test_bookdepth.py
@@ -5,7 +5,7 @@
 import pytest
 
 # import my libraries
-from downloader import BinanceBulkDownloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 
 def dynamic_bookdepth_test_params():

diff --git a/tests/test_bookticker.py b/tests/test_bookticker.py
@@ -5,7 +5,7 @@
 import pytest
 
 # import my libraries
-from downloader import BinanceBulkDownloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 
 def dynamic_bookticker_test_params():

diff --git a/tests/test_bvolindex.py b/tests/test_bvolindex.py
@@ -5,7 +5,7 @@
 import pytest
 
 # import my libraries
-from downloader import BinanceBulkDownloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 
 def dynamic_bvolindex_test_params():

diff --git a/tests/test_eohsummary.py b/tests/test_eohsummary.py
@@ -5,7 +5,7 @@
 import pytest
 
 # import my libraries
-from downloader import BinanceBulkDownloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 
 def dynamic_eohsummary_test_params():

diff --git a/tests/test_fundingrate.py b/tests/test_fundingrate.py
@@ -5,7 +5,7 @@
 import pytest
 
 # import my libraries
-from downloader import BinanceBulkDownloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 
 def dynamic_fundingrate_test_params():

diff --git a/tests/test_indexpriceklines.py b/tests/test_indexpriceklines.py
@@ -5,7 +5,7 @@
 import pytest
 
 # import my libraries
-from downloader import BinanceBulkDownloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 
 def dynamic_indexpriceklines_test_params():

diff --git a/tests/test_klines.py b/tests/test_klines.py
@@ -5,7 +5,7 @@
 import pytest
 
 # import my libraries
-from downloader import BinanceBulkDownloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 
 def dynamic_klines_test_params():

diff --git a/tests/test_liquidationsnapshot.py b/tests/test_liquidationsnapshot.py
@@ -5,7 +5,7 @@
 import pytest
 
 # import my libraries
-from downloader import BinanceBulkDownloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 
 def dynamic_liquidationsnapshot_test_params():

diff --git a/tests/test_markpriceklines.py b/tests/test_markpriceklines.py
@@ -5,7 +5,7 @@
 import pytest
 
 # import my libraries
-from downloader import BinanceBulkDownloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 
 def dynamic_markpriceklines_test_params():

diff --git a/tests/test_metrics.py b/tests/test_metrics.py
@@ -5,7 +5,7 @@
 import pytest
 
 # import my libraries
-from downloader import BinanceBulkDownloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 
 def dynamic_metrics_test_params():

diff --git a/tests/test_premiumindexklines.py b/tests/test_premiumindexklines.py
@@ -5,7 +5,7 @@
 import pytest
 
 # import my libraries
-from downloader import BinanceBulkDownloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 
 def dynamic_premiumindexklines_test_params():

diff --git a/tests/test_trades.py b/tests/test_trades.py
@@ -5,7 +5,7 @@
 import pytest
 
 # import my libraries
-from downloader import BinanceBulkDownloader
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
 
 
 def dynamic_trades_test_params():