Skip to content

djetelina/pyCardDeck

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

141 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pyCardDeck

MIT License PyPI

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:

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

Full documentation is available on ReadTheDocs.

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

About

Deck of cards with all the logic, so you don't have to!

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages