playingcards.py
An Advanced Python Playing Card Module that makes creating playing card games simple and easy!
Features
- Easy to Understand Class Objects
- ASCII Card Images
- Card Comparisons
- Duplicate Prevention within Decks
OptionalSeed Input for Custom Generation Sequences
Installation
Requires Python 3.6 and above
You can install the module from PyPI or by using pip.
# Linux/MacOS
pip3 install playingcards.py
# Windows
pip install playingcards.py
How To Use
This module introduces two class objects: Deck and Card.
The difference between the two classes is that the Deck class keeps track of all of the drawn cards to prevent duplicates from being generated.
Drawing Cards
The Deck class can be called with the draw_card() function to draw a card object.
Generating a card by only using the Card class happpens when you instantiate it.
Both Classes Have A Seed Argument To Modify The Random Number Generator
from playingcards import Deck, Card
# Card Generated Using Deck
player_deck = Deck()
player_card = player_deck.draw_card()
# Card Generated From Instantiation
player_card_2 = Card()
# Card Generated With A Seed
player_deck_2 = Deck(seed="abc")
player_card_3 = Card(seed="xyz")
Class Attributes
-
Deck Attributes
- drawn_cards
dict- Returns a dict of the values that were drawn from each corresponding suit. - cards
list- Returns a list containing the class objects of each drawn card. - drawn
int- Returns an integer of the amount of cards that have been drawn. - remaining
int- Returns an integer amount of the remaining cards that can be drawn.
- drawn_cards
-
Card Attributes
- deck
Deck- Returns a Deck object if the card was drawn from a deck. Default: None. - suit
int- Returns an integer that corresponds with the card's suit. - suit_name
str- Returns a string containing the converted suit name. - value
int- Returns an integer of the card's face value. - rank
str|int- Returns a string if the value can be converted into a word value (Ex. 11 -> Jack). Defaults to returning an integer if its not applicable (Ex. 2 -> 2). - name
str- Returns a string containing the full name of the card. This prints out the rank and the suit of the card. (Ex. Ace of Spades, 3 of Hearts) - img
str- Returns a string that contains an ASCII image of the card with the corresponding suit symbol.
- deck
Class Arguments
A card object can be instantiated with preconceived values instead of using a random generator.
-
Suits are ordered numerically from 0-3.
-
0: Spades
-
1: Clubs
-
2: Hearts
-
3: Diamonds
-
-
Values are ordered numerically from 1-13.
-
1: Ace
-
2-10: Face Value
-
11: Jack
-
12: Queen
-
13: King
-
player_card = Card(value=11, suit=1)
print(player_card)
>> Jack of Clubs
print(player_card.value)
>> 11
print(player_card.suit_name)
>> Clubs
print(player_card.rank)
>> Jack
print(player_card.img)
>> *- - -*
| ♣ |
| J |
| ♣ |
*- - -*
These arguments can also be used in the
draw_card()function apart of theDeckclass.
Card Comparisons
The card objects feature comparison features which allows their values to be compared.
When checking for equivalency, it only checks the value of the card, not the suits.
card_1 = Card(value=8, suit=0)
card_2 = Card(value=12, suit=2)
card_3 = Card(value=8, suit=3)
print(card_1 < card_2)
>> True
print(card_3 == card_1) # Returns True even if the suit is different
>> True
41 Jan 5, 2023
1 Dec 21, 2021
41 Nov 6, 2022
9 Nov 16, 2022
4 May 27, 2022
32 Oct 11, 2022
3 Oct 15, 2021
21 Dec 25, 2022
2 Feb 4, 2022
1 Jan 03, 2022
30 Jan 08, 2023
351 Jan 03, 2023
6.2k Dec 31, 2022
966 Dec 24, 2022
379 Dec 24, 2022
484 Jan 01, 2023
3 Oct 17, 2022
10 Mar 07, 2022
12 Dec 18, 2022
2 Nov 02, 2021
![Hüzünlü Artemis [HuzunluArtemis]](https://avatars.githubusercontent.com/u/84624971?v=4&s=60)
81 Jul 15, 2022
1 Oct 29, 2021
2 Oct 14, 2022
7 Jan 05, 2023
265 Dec 28, 2022
26 Dec 11, 2022
1 Oct 11, 2021
24 Dec 11, 2022
2 Nov 05, 2021