<commit_before>pokercore
=========

A poker engine core, in Python
------------------------------

pokercore provides 3 classes to be used in a poker engine.
Card (a playing card), Hand (a poker hand consisting of Cards,
with evaluation capabilities) and Deck (a deck of Cards).

Its is a simple starter, mainly written for exploring purposes,
but can be extended and/or used to build something bigger. It is
released under the MIT licensre.

Example
-------
.. code-block:: python

    >>> from pokercore import Deck, Hand
    >>> deck = Deck()
    >>> first = Hand(deck.draw(5))
    >>> first
    Hand(one pair: Card(9c), Card(9h), Card(Ac), Card(Jh), Card(2h))
    >>> second = Hand(deck.draw(5))
    >>> second
    Hand(high card: Card(As), Card(Kc), Card(9s), Card(7h), Card(4h))
    >>> first > second
    True<commit_msg>Added example<commit_after>pokercore
=========

A poker engine core, in Python
------------------------------

pokercore provides 3 classes to be used in a poker engine.
Card (a playing card), Hand (a poker hand consisting of Cards,
with evaluation capabilities) and Deck (a deck of Cards).

Its is a simple starter, mainly written for exploring purposes,
but can be extended and/or used to build something bigger. It is
released under the MIT licensre.

Example
-------

.. code-block:: python

    >>> from pokercore import Deck, Hand
    >>> deck = Deck()
    >>> first = Hand(deck.draw(5))
    >>> first
    Hand(one pair: Card(9c), Card(9h), Card(Ac), Card(Jh), Card(2h))
    >>> second = Hand(deck.draw(5))
    >>> second
    Hand(high card: Card(As), Card(Kc), Card(9s), Card(7h), Card(4h))
    >>> first > second
    True
{'fraction_non_alphanumeric': 0.17139408569704284, 'fraction_numerical': 0.010863005431502716, 'mean_word_length': 3.034063260340633, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 47, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1712122', 'n_tokens_mistral': 509, 'n_tokens_neox': 498, 'n_words': 196}