Metadata-Version: 2.4
Name: pyCardDeck
Version: 1.5.0
Summary: Logic for decks with cards
Project-URL: Homepage, https://github.com/djetelina/pyCardDeck
Project-URL: Documentation, https://pycarddeck.readthedocs.io
Author-email: David Jetelina <david@djetelina.cz>
License-Expression: MIT
License-File: LICENSE
Keywords: card,cards,deck,discard,draw,game,shuffle
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: jsonpickle>=3.0
Requires-Dist: pyyaml>=6.0
Description-Content-Type: text/markdown

# pyCardDeck

[![MIT License](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](https://opensource.org/licenses/MIT)
[![PyPI](https://badge.fury.io/py/pyCardDeck.svg)](https://badge.fury.io/py/pyCardDeck)

Library aimed at anyone who wants to do any kind of deck manipulation in python.
So probably game developers. The goal is to have the ultimate library for all of this,
supporting all kinds of game types with clean and beautiful API - kind of like requests :)

## How to use

First, install with pip:

```
pip install pyCardDeck
```

Then use in your code:

```python
import pyCardDeck

my_deck = pyCardDeck.Deck(cards=[1, 2, 3], name='My Awesome Deck')

my_deck.shuffle()

card = my_deck.draw()
```

For more elaborate examples check out [GitHub](https://github.com/djetelina/pyCardDeck/tree/master/examples)

Full documentation is available on [ReadTheDocs](https://pycarddeck.readthedocs.io).

## For developers

The library supports Python 3.10+.

This library should be very easy to contribute to for first timers. Nothing is sacred, file issues, contribute
where you feel it's useful and fun for you! If you need help, just ask.

Always aim to write clean and readable code, make sure the tests are passing, document in docstrings (rst format)
and when writing new modules, classes or functions, add them to docs (we are using Sphinx autodocs)

### Running tests

To run tests enter the pyCardDeck directory and run:

```
uv run pytest
```
