Metadata-Version: 2.1
Name: deck-of-cards
Version: 0.0.9
Summary: A module to create and interact with a deck of cards object
Home-page: https://github.com/SimonTheChain/deck_of_cards
Author: Simon Lachaîne
Author-email: simonthechain@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

# deck_of_cards
A module to create a deck of cards object with which you can interact.

### Documentation
https://deck-of-cards.readthedocs.io/en/latest/

### Example usage
**import the module**
`from deck_of_cards import deck_of_cards`

**create an instance of DeckOfCards**
`deck_obj = deck_of_cards.DeckOfCards()`

**add jokers**
`deck_obj.add_jokers()`

**sort the deck by card value**
```
deck_obj.order_deck()
print("\nDeck sorted\n")
deck_obj.print_deck()
```

**give out a random card**
`card = deck_obj.give_random_card()`

**card objects have the following attributes**
```
card.suit  # 0=spades, 1=hearts, 2=diamonds, 3=clubs, 4=joker
card.rank  # 1=Ace, 11=Jack, 12=Queen, 13=King, 14=B&W Joker, 15=Color Joker
card.value # defaults: same as rank
card.name  # string representation
card.image_path = ""  # path to an image file corresponding to the card
```

**insert a new card into the deck**
```
print(len(deck_obj.deck))
card = deck_of_cards.Card((2, 11))
print(card.name)
deck_obj.take_card(card)
print(len(deck_obj.deck))
```

**shuffle the deck**
```
deck_obj.shuffle_deck()
print("\nDeck shuffled\n")
deck_obj.print_deck()
```

**add a second deck of cards to the first one**
```
print(len(deck_obj.deck))
deck_obj.add_deck()
print(len(deck_obj.deck))
```

### Test coverage
```
============================= test session starts =============================
platform win32 -- Python 3.5.3, pytest-3.6.2, py-1.5.3, pluggy-0.6.0
rootdir: C:\Users\Smoky05\PycharmProjects\deck_of_cards, inifile:
plugins: cov-2.5.1
collected 12 items

deck_of_cards\test_deck_of_cards.py ............                         [100%]

----------- coverage: platform win32, python 3.5.3-final-0 -----------
Name                             Stmts   Miss  Cover
----------------------------------------------------
deck_of_cards\deck_of_cards.py     131     29    78%


========================== 12 passed in 0.15 seconds ==========================
```

