trebek / pydealer Goto Github PK

A simple package containing classes/methods for constructing decks of playing cards (standard 'French deck'). Could be used for a CLI game, or even a graphical game as well.

Home Page: http://pydealer.rtfd.org

License: GNU General Public License v3.0

Makefile 6.61% Shell 6.31% Python 87.07%

pydealer's Introduction

PyDealer: Playing Card Package

PyDealer is a simple to use Python package for "simulating" decks of standard playing cards (also known as a French Deck). PyDealer let's you easily create Deck instances, each containing a full 52 card deck of playing cards. Each card is a separate Card instance, with a name, value, suit, and abbreviation. There is also the Stack class, which is useful for creating hands, or discard piles, etc. It is the backbone of the PyDealer package, and actually the Deck class is just a subclass of the Stack class.

PyDealer could possibly be used as part of a CLI (command line interface) card-based game, or even a graphical game as well, I suppose. It may also be of interest to beginner Python programmers, since it's a relatively simple package, which I created as a way to learn Python, packaging, testing, documentation (Sphinx), etc. I even ended up learning how to use Git a bit, which I must say was slightly frustrating at first. This package has taught me a lot, and maybe someone else can benefit from it as well. Or maybe not. Either way, here it is.

The PyDealer package can be found at the Python Package Index, and should be downloaded from there, and, ideally, installed with pip.

Note to Developers

If you want to work on this project, please make sure you are working on the latest version of the dev branch, and make your pull requests to that branch. Thanks.

Documentation

Full documentation for PyDealer can be found on readthedocs.org:

http://pydealer.readthedocs.org/en/latest/

Quick Usage Example

Here is a quick example, using IDLE, demonstrating how to construct a new Deck instance, representing a full French Deck of cards, as well as how to shuffle the deck, and deal some cards (7 of them) from it, to a hand. Then we'll print a listing of the contents of the hand, in a human readable way, with a simple print statement.

>>> import pydealer
>>> deck = pydealer.Deck()
>>> deck.shuffle()
>>> hand = deck.deal(7)
>>> hand.sort()
>>> print hand
2 of Diamonds
5 of Hearts
9 of Hearts
9 of Spades
Jack of Spades
King of Clubs
Ace of Clubs

Install/Update/Uninstall with pip

I recommend downloading and installing pip, if you haven't already, and using that to install PyDealer, from the Python Package Index.

Enter one of the following commands into your *nix Bash or Windows Command Prompt (after installing pip).

Install

$ pip install pydealer

Update

$ pip install pydealer -U

Uninstall

$ pip uninstall pydealer

Relevant Links

Standard 52-card deck Wikipedia Article

Playing card Wikipedia Article

pydealer's People

Contributors

Stargazers

Watchers

Forkers

lucasmroberts cdcformatc pokoli antiface wujingchen mkokotovich tazjel olimasters archertech jamesalbert ageekinside tyjch camzach aaronliftig tkdennis erkenyigit tjkirchmann rhartman93

pydealer's Issues

Inheritance from Stack or Deck class has surprising addition behaviour

When one adds instances of a subclass of Stack or Deck, a Stack or Deck is returned instead of the expected subclass.

Name a random card (without pulling from deck)

I'm trying to simulate some magic tricks and I need a function that just names a random card without dealing it from the deck. Do you have a suggestion for the best way to do this?

A little more detail

create deck
shuffle deck
deal 1 card from deck
name and random card and see if it is the same as the dealt card (this is the function I need)

Thanks

deal() calls build_deck(), which doesn't exist

You probably mean build()...

Can't use pydealer from Python3

I have installed pydealer using pip. It works well using python2. However, when I try to use it using python3, I have the following error:
AttributeError: 'module' object has no attribute 'Deck'
>>> import pydealer
>>> dir(pydealer)
['builtins', 'cached', 'doc', 'file', 'loader', 'name', 'package', path', 'spec']

Multiple Deck options?

Any thoughts on supporting a multiple deck feature? I'm looking at doing a blackjack sort of simulator, but want to have a dealer that has done a multiple deck shuffle (e.g. double deck BJ, 6 pack, 8 pack, etc).

Thanks!

add str, repr, hash, and eq to Card class

I saw this project /r/python, and it looks really solid. Got a small recommendation: add __str__, __repr__, __hash__, and __eq__ to the Card class. This will allow me to do this:

c = Card('Ace', 'Spades')
print(c)
c2 = Card('Ace', 'Diamonds')
print(c == c2)

I suggest something like this:

def __str__(self):
    return '%s' % (self.name)

def __repr__(self):
    return 'Card(value=%r, suit=%r)' % (self.value, self.suit)

def __hash__(self):
    return hash((self.value, self.suit))

def __eq__(self, other):
    return isinstance(other, Card) and self.value == other.value and self.suit == other.suit

I'm a big fan of implementing these 4 methods for base classes like Card because then I can use them in data structures (set, dict, etc.) without having to worry about unexpected behavior. I can also print a card and print card-related errors and get meaningful information.

Stack.find(..., sort=True) is broken, complains of a undefined function

Pull request #20 fixes this.

Thanks

stack.get(-1) does not remove card from the stack

Upload to pypi

Will be great if the package is available from pypi,

Here is a good doc how it works.

http://guide.python-distribute.org/contributing.html

Then in the readme you can explaing that to download the last stable version the following command can be used:

pip install pydealer

Add support for spanish card stack

In spain we are a quite different an we use the Spanish Stack (Called baraja in spanish [1]) instead of the French One.

I'm curious if you wan't to support this stack also, as a lot of code can be shared with the French one.

http://en.wikipedia.org/wiki/Baraja_%28playing_cards%29

I can provide the code if you want.

stack.empty() does not return a list of cards

import pydealer
deck = pydealer.Deck()
hand = pydealer.Stack()
hand.add(deck.deal(5))
test = hand.empty()
print(test)
# this gives None