Marie-Joseph
/
dungeon-maid
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
42 Commits
2 Branches
0 Tags
14 MiB
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'main'
${ noResults }
Go to file
J. Sims 5d6386aea4
dice: various cleanups/refinements 		1 year ago
.vscode Added tests for dice (some failing) 1 year ago
data Import 5etools data directory 1 year ago
dungeon_maid dice: various cleanups/refinements 1 year ago
.gitignore Add .pytest_cache to .gitignore 1 year ago
.gitlab-ci.yml Update .gitlab-ci.yml file 1 year ago
LICENSE Add LICENSE 1 year ago
Pipfile Cleaned up the Pipfile and Pipfile.lock with black version 1 year ago
Pipfile.lock Cleaned up the Pipfile and Pipfile.lock with black version 1 year ago
README.md Update README.md 1 year ago

README.md

dungeon-maid

A project aimed at creating a set of tools, in the form of a Python library, which can facilitate running TTRPGs such as Dungeons & Dragons using a real time literate programming paradigm

Getting started

Dependencies are managed using Pipenv. If you have Pipenv installed, you can start working with this project inside of Jupyter Notebook by running the following commands.

pipenv install
pipenv run jupyter notebook

Developer Tools

We have black as our code linter and pytest for running tests. These can be run through pipenv:

pipenv install --dev
pipenv run black
pipenv run pytest

Pytest

Tests are located in the ./dungeon_maid/tests/ directory. An automated job will run them on commit.