A poker package to parse Hand histories into json objects
Project description
PokerHistoryParser
Description
A poker package to parse Hand histories into json objects
PokerHistoryParser is a powerful tool for analyzing and extracting data from poker hand histories.
This project is designed to help poker players and analysts better understand their performance by providing detailed
analyses of hands played.
Table of Contents
Introduction
Welcome to the PokerHistoryParser documentation.
This tool allows you to analyze poker hand histories.
It is designed to be easy to use and integrate into your projects.
It returns data as a dictionary or JSON file for easy use in your programs.
Installation
To install the package, use the following command:
pip install pkrhistoryparser
Usage
Base Examples
Here are some simple examples of using PokerHistoryParser:
Parse a poker hand history to a dict to be used in a program:
from pkrhistoryparser.parser import HandHistoryParser
parser = HandHistoryParser()
hand_text = parser.get_raw_text("path/to/hand/history.txt")
hand_info = parser.parse_hand(hand_text)
Parse a poker hand history to a JSON file:
from pkrhistoryparser.parser import HandHistoryParser
parser = HandHistoryParser()
parser.parse_to_json('path/to/hand/history.txt', 'path/to/save/json/file.json')
For more details on usage, please refer to the documentation.
Supported Poker Sites
Currently, PokerHistoryParser supports the following poker sites:
- Winamax
Upcoming Features
Here are some features we plan to add in future versions:
- Analysis of tournament summary files
- Analysis of CashGame files
- Support for more poker sites
Contributing
All contributions are welcome! To contribute, please follow these steps:
- Fork the repository
- Create a branch for your feature (
git checkout -b feature/AmazingFeature
) - Commit your changes (
git commit -m 'Add some AmazingFeature'
) - Push to the branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
This project is licensed under the MIT license. See the LICENSE file for more details.
Authors
- Alexandre MANGWA a.k.a Manggy94 on GitHub - Main dev -
Associated Projects
For any questions or issues, feel free to open an issue in the repository or contact us directly.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pkrhistoryparser-3.0.1.tar.gz
.
File metadata
- Download URL: pkrhistoryparser-3.0.1.tar.gz
- Upload date:
- Size: 15.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 15ed2c094cdcb2b08817abc8cf324ee7b8623b1c94de1c771b7e0a21d4b75312 |
|
MD5 | e1780aadc4ef385f8c9e6dd6cea02267 |
|
BLAKE2b-256 | 46096d1903b638ace947993cfd1b101b57f0b489af4b54616677afd6a0b40a5a |
File details
Details for the file pkrhistoryparser-3.0.1-py3-none-any.whl
.
File metadata
- Download URL: pkrhistoryparser-3.0.1-py3-none-any.whl
- Upload date:
- Size: 3.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0032fff414716b79b52d169a90de17831ac7162ad85892248d235743cbadd8e3 |
|
MD5 | 0349788e6acb3ea036961fd57d804933 |
|
BLAKE2b-256 | 5eb575878cb7d5ecc64979ec59f8c485cb63b1254a7afb275dd7f894ef90b31d |