keibascraper 3.1.4
keibascraper is a simple scraping library for netkeiba.com

# Keiba Scraper

[![Test](https://github.com/new-village/keibascraper/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/new-village/keibascraper/actions/workflows/unittest.yaml)
[![PyPI](https://badge.fury.io/py/keibascraper.svg)](https://badge.fury.io/py/keibascraper)

**keibascraper** is a Python library designed to parse data from [netkeiba.com](https://www.netkeiba.com/), a prominent Japanese horse racing website. It allows users to programmatically extract detailed information about races, entries, results, odds, and horses. Please note that depending on your usage, this may impose a significant load on netkeiba.com.


## Table of Contents

- [Features](#features)
- [Installation](#installation)
- [Dependencies](#dependencies)
- [Usage](#usage)
  - [Loading Entry Data (出走データ)](#loading-entry-data)
  - [Loading Result Data (結果データ)](#loading-result-data)
  - [Loading Odds Data (オッズデータ)](#loading-odds-data)
  - [Loading Horse Data (血統データ/出走履歴データ)](#loading-horse-data)
  - [Bulk Data Loading](#bulk-data-loading)
- [API Reference](#api-reference)
  - [`load` Function](#load-function)
  - [`race_list` Function](#race_list-function)
- [Contributing](#contributing)
- [License](#license)


## Features

- **Flexible Data Loading**: Supports loading of various data types such as race entries, results, odds, and horse information.
- **Configurable Parsing**: Utilizes JSON configuration files to define parsing rules, making it easy to adapt to changes in the source website.
- **Error Handling**: Provides robust error handling to manage network issues and data inconsistencies.
- **Caching**: Implements caching mechanisms to improve performance and reduce redundant network requests.

## Installation

keibascraper is available on PyPI and can be installed using pip:

```bash
$ python -m pip install keibascraper
```

**Supported Python Versions**: keibascraper officially supports Python 3.8 and above.

## Dependencies

- [requests](https://pypi.org/project/requests/): For handling HTTP requests.
- [BeautifulSoup4](https://pypi.org/project/beautifulsoup4/): For parsing HTML content.
- [jq](https://pypi.org/project/jq/): For parsing JSON content using jq expressions.

## Usage

To use keibascraper, import the library and use the `load` function to fetch and parse data from netkeiba.com. The `load` function requires two parameters: the data type and the entity ID.

### Loading Entry Data (出走データ)

```python
>>> import keibascraper
>>> race, entry = keibascraper.load("entry", "201206050810")
>>> print(race)
[{'race_id': '201206050810', 'race_number': 10, 'race_name': '有馬記念', ... }]
>>> print(entry)
[{'bracket': 7, 'horse_number': 13, 'horse_name': 'ゴールドシップ', ...}, {...}, ...]

```

### Loading Result Data (結果データ)

```python
>>> import keibascraper
>>> race, entry = keibascraper.load("result", "201206050810")
>>> print(race)
[{'race_id': '201206050810', 'race_number': 10, 'race_name': '有馬記念', ... }]
>>> print(entry)
[{'rank': 1, 'horse_name': 'ゴールドシップ', 'rap_time': 151.9,...}, {...}, ...]
```

### Loading Odds Data (オッズデータ)

```python
>>> import keibascraper
>>> odds = keibascraper.load("odds", "201206050810")
>>> print(odds)
[{'horse_number': 13, 'win': 2.7, 'show_min': 1.3, 'show_max': 1.5, ...}, {...}, ...]
```

### Loading Horse Data (血統データ/出走履歴データ)

```python
>>> import keibascraper
>>> horse, result = keibascraper.load("horse", "2009102739")
>>> print(horse)
[{'horse_id': '2009102739', 'father_name': 'ステイゴールド', ... }]
>>> print(result)
[{'race_date': '20151227', 'race_name': '有馬記念', 'rank': 8, ...}, {...}, ...]
```

### Bulk Data Loading

To load multiple races in bulk, you can use the `race_list` function to retrieve a list of race IDs for a specific year and month.

```python
import keibascraper

# Get list of race IDs for July 2022
race_ids = keibascraper.race_list(2022, 7)

# Loop through race IDs and load entry data
for race_id in race_ids:
    race_info, entry_list = keibascraper.load("entry", race_id)
    # Process the data as needed
```

### Create table query generation for SQLite

The `create_table_sql` function generates an SQL query string for creating a table in an SQLite database. The table structure is dynamically defined based on the configuration file corresponding to the provided `data_type` like `race`, `entry`, `result` and etc. This function ensures that the table is created only if it does not already exist and assigns a primary key to the first column.

```python
>>> import keibascraper
>>> query = keibascraper.create_table_sql("entry")
>>> print(query)
CREATE TABLE IF NOT EXISTS entry (bracket text, ... weight_diff integer);
```

## API Reference

### `load` Function

```python
keibascraper.load(data_type, entity_id)
```

- **Description**: Loads data from netkeiba.com based on the specified data type and entity ID.
- **Parameters**:
  - `data_type` (str): Type of data to load. Supported types are `'entry'`, `'result'`, `'odds'`, and `'horse'`.
  - `entity_id` (str): Identifier for the data entity (e.g., race ID, horse ID).
- **Returns**:
  - For `'entry'` and `'result'`: Returns a list of `[{race}]` and list of `[{entry1}, {entry2}...]`.
  - For `'odds'`: Returns a list of `[{odds1}, {odds2}...]`.
  - For `'horse'`: Returns a list of `[{horse}]` and list of `[{result1}, {result2}...]`.
- **Raises**:
  - `ValueError`: If an unsupported data type is provided.
  - `RuntimeError`: If data loading or parsing fails.

### `race_list` Function

```python
keibascraper.race_list(year, month)
```

- **Description**: Retrieves a list of race IDs for the specified year and month.
- **Parameters**:
  - `year` (int): The target year.
  - `month` (int): The target month.
- **Returns**:
  - A list of race IDs (list).


## Contributing

Contributions are welcome! If you have suggestions or find bugs, please open an issue or submit a pull request on the [GitHub repository](https://github.com/new-village/keibascraper).

When contributing, please follow these guidelines:

- **Coding Standards**: Follow PEP 8 style guidelines.
- **Testing**: Ensure that your code passes existing tests and add new tests for your changes.
- **Documentation**: Update documentation and docstrings as needed.


## License

This project is licensed under the terms of the Apache-2.0 license. See the [LICENSE](https://github.com/new-village/keibascraper/blob/main/LICENSE) file for details.


**Disclaimer**: This library is intended for personal use and educational purposes. Scraping data from websites may violate their terms of service. Please ensure that you comply with netkeiba.com's terms and conditions when using this library.