binypt-cli


Namebinypt-cli JSON
Version 1.0.4 PyPI version JSON
download
home_pagehttps://github.com/Tejaromalius/Binypt-cli
SummaryCommand line tool for downloading data charts from Binance
upload_time2024-01-02 12:05:02
maintainer
docs_urlNone
authorilia tayefi
requires_python>=3.10,<4.0
licenseMIT
keywords crypto binance cli
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Binypt - Cryptocurrency Chart Data Downloader

[![PyPI - Version](https://img.shields.io/pypi/v/binypt-cli?color=pink)](https://github.com/Tejaromalius/Binypt-cli/blob/main/pyproject.toml)
[![PyPI - License](https://img.shields.io/pypi/l/binypt-cli?color=blue)](https://github.com/Tejaromalius/Binypt-cli/blob/main/LICENSE)
[![PyPI - Status](https://img.shields.io/pypi/status/binypt-cli?color=%20%23239b56%20)](https://pypi.org/project/binypt-cli/)

## Overview

**Binypt** is a versatile Python command-line utility tool that allows you to effortlessly download historical cryptocurrency chart data from the Binance exchange. Whether you're a trader, researcher, or just a crypto enthusiast, Binypt simplifies the process of collecting and exporting candlestick data for your preferred trading pairs and time intervals.

## Installation

Before using Binypt, make sure you have the required dependencies installed:

```bash
pip install binypt-cli
```

## Usage

Binypt offers a range of options to tailor your data collection. Here's how to use it:

```bash
$ binypt -p <TRADING_PAIR> -i <INTERVAL> -od <OPEN_DATE> -cd <CLOSE_DATE> [OPTIONS]
```

### Required Arguments

- `-p`, `--trading-pair`: Specify the trading pair symbol (e.g., BTCUSDT).
- `-i`, `--interval`: Set the candlestick interval (e.g., 1h, 1d, 1w).
- `-od`, `--open-date`: Define the start date for data collection (YYYY-MM-DD/HH:mm:ss).
- `-cd`, `--close-date`: Define the end date for data collection (YYYY-MM-DD/HH:mm:ss).

### Optional Arguments

- `-o`, `--output-path`: Path to the output file for data storage. Supported formats: .csv, .excel, .pkl. (Default: binypt_data.csv)
- `-hr`, `--add-hr-time`: Include human-readable time format in the output data.
- `-v`, `--verbose`: Enable verbose logging for debugging purposes.

## Examples

### Basic Usage

Download 1-hour candlestick data for the BTCUSDT trading pair from January 1, 2023, to January 10, 2023, and save it as "btc_data.csv":

```bash
$ binypt -p BTCUSDT -i 1h -od 2023-01-01/00:00:00 -cd 2023-01-10/23:59:59 -o btc_data.csv
```

### Verbose Mode

Enable verbose logging to get detailed information during data retrieval:

```bash
$ binypt -p BTCUSDT -i 1h -od 2023-01-01/00:00:00 -cd 2023-01-10/23:59:59 -v
```

### Human-Readable Time Format

Include human-readable time format in the output data:

```bash
$ binypt -p BTCUSDT -i 1h -od 2023-01-01/00:00:00 -cd 2023-01-10/23:59:59 -hr
```

## Output

Binypt will download the requested data and save it in the specified format and file path. The data will be ready for further analysis or visualization.

## License

This software is distributed under the MIT License. You are free to use, modify, and distribute it as needed. Please refer to the LICENSE file for more details.

**Happy trading, and may your charts always be green!** 🚀💰

---
[![Generated by ChatGPT](https://img.shields.io/badge/Generated%20by-ChatGPT-45b39d.svg)](https://chat.openai.com/)
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Tejaromalius/Binypt-cli",
    "name": "binypt-cli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<4.0",
    "maintainer_email": "",
    "keywords": "crypto,binance,cli",
    "author": "ilia tayefi",
    "author_email": "tayefi.ilia@protonmail.com",
    "download_url": "https://files.pythonhosted.org/packages/d0/88/825edf32a328d13037d9b9ba8d15b4b60acd7b1142fa2360a5b6bdc855fc/binypt_cli-1.0.4.tar.gz",
    "platform": null,
    "description": "# Binypt - Cryptocurrency Chart Data Downloader\n\n[![PyPI - Version](https://img.shields.io/pypi/v/binypt-cli?color=pink)](https://github.com/Tejaromalius/Binypt-cli/blob/main/pyproject.toml)\n[![PyPI - License](https://img.shields.io/pypi/l/binypt-cli?color=blue)](https://github.com/Tejaromalius/Binypt-cli/blob/main/LICENSE)\n[![PyPI - Status](https://img.shields.io/pypi/status/binypt-cli?color=%20%23239b56%20)](https://pypi.org/project/binypt-cli/)\n\n## Overview\n\n**Binypt** is a versatile Python command-line utility tool that allows you to effortlessly download historical cryptocurrency chart data from the Binance exchange. Whether you're a trader, researcher, or just a crypto enthusiast, Binypt simplifies the process of collecting and exporting candlestick data for your preferred trading pairs and time intervals.\n\n## Installation\n\nBefore using Binypt, make sure you have the required dependencies installed:\n\n```bash\npip install binypt-cli\n```\n\n## Usage\n\nBinypt offers a range of options to tailor your data collection. Here's how to use it:\n\n```bash\n$ binypt -p <TRADING_PAIR> -i <INTERVAL> -od <OPEN_DATE> -cd <CLOSE_DATE> [OPTIONS]\n```\n\n### Required Arguments\n\n- `-p`, `--trading-pair`: Specify the trading pair symbol (e.g., BTCUSDT).\n- `-i`, `--interval`: Set the candlestick interval (e.g., 1h, 1d, 1w).\n- `-od`, `--open-date`: Define the start date for data collection (YYYY-MM-DD/HH:mm:ss).\n- `-cd`, `--close-date`: Define the end date for data collection (YYYY-MM-DD/HH:mm:ss).\n\n### Optional Arguments\n\n- `-o`, `--output-path`: Path to the output file for data storage. Supported formats: .csv, .excel, .pkl. (Default: binypt_data.csv)\n- `-hr`, `--add-hr-time`: Include human-readable time format in the output data.\n- `-v`, `--verbose`: Enable verbose logging for debugging purposes.\n\n## Examples\n\n### Basic Usage\n\nDownload 1-hour candlestick data for the BTCUSDT trading pair from January 1, 2023, to January 10, 2023, and save it as \"btc_data.csv\":\n\n```bash\n$ binypt -p BTCUSDT -i 1h -od 2023-01-01/00:00:00 -cd 2023-01-10/23:59:59 -o btc_data.csv\n```\n\n### Verbose Mode\n\nEnable verbose logging to get detailed information during data retrieval:\n\n```bash\n$ binypt -p BTCUSDT -i 1h -od 2023-01-01/00:00:00 -cd 2023-01-10/23:59:59 -v\n```\n\n### Human-Readable Time Format\n\nInclude human-readable time format in the output data:\n\n```bash\n$ binypt -p BTCUSDT -i 1h -od 2023-01-01/00:00:00 -cd 2023-01-10/23:59:59 -hr\n```\n\n## Output\n\nBinypt will download the requested data and save it in the specified format and file path. The data will be ready for further analysis or visualization.\n\n## License\n\nThis software is distributed under the MIT License. You are free to use, modify, and distribute it as needed. Please refer to the LICENSE file for more details.\n\n**Happy trading, and may your charts always be green!** \ud83d\ude80\ud83d\udcb0\n\n---\n[![Generated by ChatGPT](https://img.shields.io/badge/Generated%20by-ChatGPT-45b39d.svg)](https://chat.openai.com/)",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Command line tool for downloading data charts from Binance",
    "version": "1.0.4",
    "project_urls": {
        "Homepage": "https://github.com/Tejaromalius/Binypt-cli",
        "Repository": "https://github.com/Tejaromalius/Binypt-cli"
    },
    "split_keywords": [
        "crypto",
        "binance",
        "cli"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b1505d40c6060df1c02981a3a30d6825fb5033f6912baf5560269b172e3bccaf",
                "md5": "29bfa21d3a4bb83274f363c6c52d2e36",
                "sha256": "f1a446da0a71edb9e7fd62d0a9951b66d71cd45d94dcc8dbb0a8e242f36355be"
            },
            "downloads": -1,
            "filename": "binypt_cli-1.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "29bfa21d3a4bb83274f363c6c52d2e36",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<4.0",
            "size": 5566,
            "upload_time": "2024-01-02T12:05:00",
            "upload_time_iso_8601": "2024-01-02T12:05:00.285584Z",
            "url": "https://files.pythonhosted.org/packages/b1/50/5d40c6060df1c02981a3a30d6825fb5033f6912baf5560269b172e3bccaf/binypt_cli-1.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d088825edf32a328d13037d9b9ba8d15b4b60acd7b1142fa2360a5b6bdc855fc",
                "md5": "f647eaef55436c802b6080c8301647f4",
                "sha256": "fc00abb44b740ce6d3e9570976b1fae513d3501697a344f9e65e14b8fb2d29f7"
            },
            "downloads": -1,
            "filename": "binypt_cli-1.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "f647eaef55436c802b6080c8301647f4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<4.0",
            "size": 4050,
            "upload_time": "2024-01-02T12:05:02",
            "upload_time_iso_8601": "2024-01-02T12:05:02.384981Z",
            "url": "https://files.pythonhosted.org/packages/d0/88/825edf32a328d13037d9b9ba8d15b4b60acd7b1142fa2360a5b6bdc855fc/binypt_cli-1.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-02 12:05:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Tejaromalius",
    "github_project": "Binypt-cli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "binypt-cli"
}
        
Elapsed time: 0.15293s