Create your own Shit Happens playing cards!
Project description
It Happens
Create your own Shit Happens playing cards!
Go to the app »
Front | Back |
Ever wanted to play with your own Shit Happens playing cards? Now you can. Write down the most miserable situations you can think of and rank them. This project automatically outputs playing cards in pdf format.
This project is not related to the original card game. Open an issue in case of any objections.
Getting started
App
The tool is available as an online app.
CLI
The tool is also available as a command line interface (CLI), see Local installation. The tool requires an Excel or csv input file and optionally an expansion logo. The input files must have header "misery index" and "situation" and optional "image" for the front image. If an image name is given (stem + ext), it must live in the image dir, given by the optional third positional argument. See the examples directory for an example.
Usage: ithappens create [OPTIONS] INPUT_FILE OUTPUT_DIR [IMAGE_DIR]
Create cards.
Options:
-n, --name TEXT Expansion name. If no name is specified,
infers name from input_dir.
-m, --merge Merge output.
-s, --side [front|back|both] Side(s) to generate.
-e, --expansion_logo_path FILE Expansion logo path.
-f, --format [pdf|png] Output format.
-w, --workers INTEGER Number of workers.
--help Show this message and exit.
If the output folder does not exist, it will be created. The format of the expansion logo must be on this list.
Local installation
The app can be installed with pip install ithappens
.
Prerequisites
A virtual environment with python 3.9 or higher.
Installing for developers
Retrieve the latest version of the code
Developers should fork this repository and run
git clone https://github.com/<your-username>/ithappens.git
This will place the sources in a directory ithappens
below your current working directory, set up the origin
remote to point to your own fork, and set up the upstream
remote to point to the ithappens
main repository.
Change into this directory before continuing:
cd ithappens
Create a dedicated environment
You should set up a dedicated environment to decouple your ithappens development from other Python and ithappens installations on your system.
Installing ithappens in editable mode
Install ithappens in editable mode from the ithappens directory using the command
python -m pip install -e .[dev]
The 'editable/develop mode', builds everything and places links in your Python environment so that Python will be able to import ithappens from your development source directory. This allows you to import your modified version of ithappens without re-installing after every change.
Contributing
Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Built With
License
Distributed under the GPL-3.0 license. See LICENSE
for more information.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file ithappens-7.1.2.tar.gz
.
File metadata
- Download URL: ithappens-7.1.2.tar.gz
- Upload date:
- Size: 796.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fdb2cc86176b6b2ce2205de21e5e647ec5a6b2a1e641ea485deeaf3b74715a79 |
|
MD5 | 87a0b17012b83cfaefa0731dca18bf2c |
|
BLAKE2b-256 | 4ecb3e8ce12f5d23616cd0df527343d2a8178d814f7b47bca6681702064ef75a |
File details
Details for the file ithappens-7.1.2-py3-none-any.whl
.
File metadata
- Download URL: ithappens-7.1.2-py3-none-any.whl
- Upload date:
- Size: 783.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee2e4b9a8e53a00cd5a80addd17724e3aa668010a3cb6f133645310528d0b296 |
|
MD5 | 6404dc43386222f15a07b38ae2579a94 |
|
BLAKE2b-256 | d32f182c6b296f0f9828140070d79d4fc0dbe0990a664bf7311063c5cac45564 |