Merge pull request #25 from aoki-h-jp/release/1.1.0

Release/1.1.0
aoki-h-jp · Jan 4, 2025 · ef23648 · ef23648
2 parents 18dea21 + 4428137
commit ef23648
Show file tree

Hide file tree

Showing 10 changed files with 609 additions and 154 deletions.
diff --git a/.github/workflows/Formatter.yml b/.github/workflows/Formatter.yml
diff --git a/.github/workflows/pytest.yaml b/.github/workflows/pytest.yaml
@@ -13,15 +13,15 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v2
       with:
-        python-version: 3.9  # 使用するPythonのバージョンを指定してください
+        python-version: 3.9
 
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install pipenv
         pip install git+https://github.com/aoki-h-jp/binance-bulk-downloader
-        pipenv install --dev  # Pipenvを使用して依存関係をインストール
+        pipenv install --dev
 
     - name: Run pytest
       run: |
-        pipenv run pytest -v -s  # pytestを実行するコマンドを指定
+        pipenv run pytest -v -s
diff --git a/README.md b/README.md
@@ -1,19 +1,21 @@
 # binance-bulk-downloader
+
 [![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/release/python-3110//)
-[![Format code](https://github.com/aoki-h-jp/binance-bulk-downloader/actions/workflows/Formatter.yml/badge.svg?branch=main)](https://github.com/aoki-h-jp/binance-bulk-downloader/actions/workflows/Formatter.yml)
 [![pytest](https://github.com/aoki-h-jp/binance-bulk-downloader/actions/workflows/pytest.yaml/badge.svg)](https://github.com/aoki-h-jp/binance-bulk-downloader/actions/workflows/pytest.yaml)
 [![Github All Releases](https://img.shields.io/github/downloads/aoki-h-jp/binance-liquidation-feeder/total.svg)]()
 
 ## Python library for bulk downloading Binance historical data
+
 A Python library to efficiently and concurrently download historical data files from Binance. Supports all asset types (spot, USDT-M, COIN-M, options) and all data frequencies.
 
 ## Installation
 
 ```bash
-pip install git+https://github.com/aoki-h-jp/binance-bulk-downloader
+pip install binance-bulk-downloader
 ```
 
 ## Usage
+
 ### Download all klines 1m data (USDT-M futures)
 
 ```python
@@ -32,6 +34,31 @@ downloader = BinanceBulkDownloader(data_frequency='1h', asset='spot')
 downloader.run_download()
 ```
 
+### Download specific symbols only
+
+```python
+from binance_bulk_downloader.downloader import BinanceBulkDownloader
+
+# Download single symbol
+downloader = BinanceBulkDownloader(
+    data_type="klines",
+    data_frequency="1h",
+    asset="spot",
+    timeperiod_per_file="daily",
+    symbols="BTCUSDT",
+)
+downloader.run_download()
+
+# Download multiple symbols
+downloader = BinanceBulkDownloader(
+    data_type="trades",
+    asset="spot",
+    timeperiod_per_file="daily",
+    symbols=["BTCUSDT", "ETHUSDT"],
+)
+downloader.run_download()
+```
+
 ### Download all aggTrades data (USDT-M futures)
 
 ```python
@@ -42,6 +69,7 @@ downloader.run_download()
 ```
 
 ### Other examples
+
 Please see /example directory.
 
 ```bash
@@ -55,25 +83,26 @@ python -m pytest
 ```
 
 ## Available data types
+
 ✅: Implemented and tested. ❌: Not available on Binance.
 
 ### by data_type
 
-| data_type           | spot | um   | cm   | options | 
-| :------------------ | :--: | :--: | :--: | :-----: | 
-| aggTrades           | ✅   | ✅   | ✅ | ❌      | 
-| bookDepth           | ❌   | ✅   | ✅ | ❌      | 
-| bookTicker          | ❌   | ✅   | ✅ | ❌      | 
-| fundingRate         | ❌   | ✅   | ✅ | ❌      | 
-| indexPriceKlines    | ❌   | ✅   | ✅ | ❌      | 
-| klines              | ✅   | ✅   | ✅ | ❌      | 
-| liquidationSnapshot | ❌   | ✅   | ✅ | ❌      | 
-| markPriceKlines     | ❌   | ✅   | ✅ | ❌      | 
-| metrics             | ❌   | ✅   | ✅ | ❌      | 
-| premiumIndexKlines  | ❌   | ✅   | ✅ | ❌      | 
-| trades              | ✅   | ✅   | ✅ | ❌      | 
-| BVOLIndex           | ❌   | ❌   | ❌ | ✅      | 
-| EOHSummary          | ❌   | ❌   | ❌ | ✅      | 
+| data_type           | spot | um   | cm   | options |
+| :------------------ | :--: | :--: | :--: | :-----: |
+| aggTrades           | ✅   | ✅   | ✅ | ❌      |
+| bookDepth           | ❌   | ✅   | ✅ | ❌      |
+| bookTicker          | ❌   | ✅   | ✅ | ❌      |
+| fundingRate         | ❌   | ✅   | ✅ | ❌      |
+| indexPriceKlines    | ❌   | ✅   | ✅ | ❌      |
+| klines              | ✅   | ✅   | ✅ | ❌      |
+| liquidationSnapshot | ❌   | ✅   | ✅ | ❌      |
+| markPriceKlines     | ❌   | ✅   | ✅ | ❌      |
+| metrics             | ❌   | ✅   | ✅ | ❌      |
+| premiumIndexKlines  | ❌   | ✅   | ✅ | ❌      |
+| trades              | ✅   | ✅   | ✅ | ❌      |
+| BVOLIndex           | ❌   | ❌   | ❌ | ✅      |
+| EOHSummary          | ❌   | ❌   | ❌ | ✅      |
 
 ### by data_frequency (klines, indexPriceKlines, markPriceKlines, premiumIndexKlines)
 
@@ -97,9 +126,11 @@ python -m pytest
 | 1mo            | ✅   | ✅   | ✅ | ❌      |
 
 ## If you want to report a bug or request a feature
+
 Please create an issue on this repository!
 
 ## Disclaimer
+
 This project is for educational purposes only. You should not construe any such information or other material as legal,
 tax, investment, financial, or other advice. Nothing contained here constitutes a solicitation, recommendation,
 endorsement, or offer by me or any third party service provider to buy or sell any securities or other financial

diff --git a/binance_bulk_downloader/__init__.py b/binance_bulk_downloader/__init__.py
@@ -1,5 +1,6 @@
 """
 BinanceBulkDownloader: A library to efficiently and concurrently download historical data from Binance.
 """
+
 import binance_bulk_downloader.downloader
 import binance_bulk_downloader.exceptions