# PokerHistoryReader
## Description
`PokerHistoryReader` est une bibliothèque Python conçue pour extraire et analyser des informations à partir d'historiques de mains de poker. Le package vous permet d'obtenir des données détaillées sur chaque main, comme les joueurs impliqués, les actions prises, les cartes tirées, et bien plus encore.
## Fonctionnalités
- Extraction du type de jeu (CashGame ou Tournoi)
- Identification des joueurs (Siège, Pseudo, Stack, Bounty)
- Actions des joueurs (Mise, Relance, Check, etc.)
- Extraction des cartes (Flop, Turn, River)
- Identification des gagnants et des pots remportés
- ... et bien d'autres !
## Prérequis
- Python 3.x
- AWS S3 (si vous souhaitez utiliser les fonctionnalités liées à S3)
## Installation
Pour installer le package, vous pouvez utiliser pip :
```
pip install pkrhistoryreader
```
Ou, si vous avez cloné le dépôt :
```
cd PokerHistoryReader
pip install .
```
## Utilisation
Après l'installation, vous pouvez utiliser le package comme suit :
```python
from pkrhistoryreader.reader import HistoryReader
# Initialisez l'objet
reader = HistoryReader()
# Utilisez les méthodes pour extraire des informations
game_type = reader.extract_game_type(hand_txt)
players_info = reader.extract_players(hand_txt)
# ... et ainsi de suite
```
## Documentation
Une documentation complète est à venir
## Contribution
Si vous souhaitez contribuer au projet, n'hésitez pas à ouvrir des issues ou à proposer des pull requests.
## Licence
Ce projet est sous licence MIT. Voir le fichier [LICENSE.txt](LICENSE.txt) pour plus de détails.
Raw data
{
"_id": null,
"home_page": "https://github.com/manggy94/PokerHistoryreader",
"name": "pkrhistoryreader",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "poker pkrhistory history pkr pkrhistoryreader pokerhistory reader",
"author": "Alexandre MANGWA",
"author_email": "alex.mangwa@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ce/c8/de99dba882163b9ab658b81ccf56ce916f297b67ce1f7229a8e557914747/pkrhistoryreader-0.2.1.tar.gz",
"platform": null,
"description": "\n# PokerHistoryReader\n\n## Description\n\n`PokerHistoryReader` est une biblioth\u00e8que Python con\u00e7ue pour extraire et analyser des informations \u00e0 partir d'historiques de mains de poker. Le package vous permet d'obtenir des donn\u00e9es d\u00e9taill\u00e9es sur chaque main, comme les joueurs impliqu\u00e9s, les actions prises, les cartes tir\u00e9es, et bien plus encore.\n\n## Fonctionnalit\u00e9s\n\n- Extraction du type de jeu (CashGame ou Tournoi)\n- Identification des joueurs (Si\u00e8ge, Pseudo, Stack, Bounty)\n- Actions des joueurs (Mise, Relance, Check, etc.)\n- Extraction des cartes (Flop, Turn, River)\n- Identification des gagnants et des pots remport\u00e9s\n- ... et bien d'autres !\n\n## Pr\u00e9requis\n\n- Python 3.x\n- AWS S3 (si vous souhaitez utiliser les fonctionnalit\u00e9s li\u00e9es \u00e0 S3)\n\n## Installation\n\nPour installer le package, vous pouvez utiliser pip :\n\n```\npip install pkrhistoryreader\n```\n\nOu, si vous avez clon\u00e9 le d\u00e9p\u00f4t :\n\n```\ncd PokerHistoryReader\npip install .\n```\n\n## Utilisation\n\nApr\u00e8s l'installation, vous pouvez utiliser le package comme suit :\n\n```python\nfrom pkrhistoryreader.reader import HistoryReader\n\n# Initialisez l'objet\nreader = HistoryReader()\n\n# Utilisez les m\u00e9thodes pour extraire des informations\ngame_type = reader.extract_game_type(hand_txt)\nplayers_info = reader.extract_players(hand_txt)\n# ... et ainsi de suite\n```\n\n## Documentation\n\nUne documentation compl\u00e8te est \u00e0 venir\n## Contribution\n\nSi vous souhaitez contribuer au projet, n'h\u00e9sitez pas \u00e0 ouvrir des issues ou \u00e0 proposer des pull requests.\n\n## Licence\n\nCe projet est sous licence MIT. Voir le fichier [LICENSE.txt](LICENSE.txt) pour plus de d\u00e9tails.\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A Poker Package to read poker history files from S3 bucket",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/manggy94/PokerHistoryreader"
},
"split_keywords": [
"poker",
"pkrhistory",
"history",
"pkr",
"pkrhistoryreader",
"pokerhistory",
"reader"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fc4a462e67873db6341d16a6b8defb7b74e369185824f7f08fbec704898f8a37",
"md5": "9fc3e6c1d8cf4c75d0534e470f281d2f",
"sha256": "713a0eaf40927a622d60145cf7f53c046b1fc47694f4a78addaa9f3d7e54fef8"
},
"downloads": -1,
"filename": "pkrhistoryreader-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9fc3e6c1d8cf4c75d0534e470f281d2f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7204,
"upload_time": "2023-11-06T22:09:11",
"upload_time_iso_8601": "2023-11-06T22:09:11.830306Z",
"url": "https://files.pythonhosted.org/packages/fc/4a/462e67873db6341d16a6b8defb7b74e369185824f7f08fbec704898f8a37/pkrhistoryreader-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cec8de99dba882163b9ab658b81ccf56ce916f297b67ce1f7229a8e557914747",
"md5": "2b032c077f94b47001c4ac49696ca779",
"sha256": "19ebc01c68b95db03299b51536cb68ee5850927937b07c2bd13255a829f42dfb"
},
"downloads": -1,
"filename": "pkrhistoryreader-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "2b032c077f94b47001c4ac49696ca779",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7198,
"upload_time": "2023-11-06T22:09:13",
"upload_time_iso_8601": "2023-11-06T22:09:13.675548Z",
"url": "https://files.pythonhosted.org/packages/ce/c8/de99dba882163b9ab658b81ccf56ce916f297b67ce1f7229a8e557914747/pkrhistoryreader-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-06 22:09:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "manggy94",
"github_project": "PokerHistoryreader",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "pkrhistoryreader"
}
JSON
