Skip to content

A library and Jupyter environment for analysis of the Flesh and Blood TCG

License

Notifications You must be signed in to change notification settings

HarrisonTotty/fab

Repository files navigation

GitHub release (latest by date including pre-releases) GitHub last commit Read the Docs

Flesh and Blood TCG Analysis Environment

A Python library and Jupyter Lab environment for analysis of the Flesh and Blood trading card game. Card data powered by flesh-cube/flesh-and-blood-cards.

Getting Started

In short, there are basically two ways you can start using fab: either downloading and installing the latest release .whl via pip, or building and running the containerized Jupyter Lab environment.

To learn more about working with the library, check out the Getting Started notebook or the Online API Documentation.

Installing Locally

Ensure that you have Python 3.9+ and pip installed and then run:

export VERSION=0.3.0
curl "https://github.com/HarrisonTotty/fab/releases/download/v${VERSION}/fab-${VERSION}-py3-none-any.whl" -o fab.whl
pip install fab.whl

Building Locally

Ensure that you have Python 3.9+ installed, along with poetry and then run:

# Clone the repository.
git clone https://github.com/HarrisonTotty/fab.git && cd fab

# Build the wheel package.
poetry install && poetry build

# Install the wheel package.
pip install dist/*.whl

Building & Running Container Image

Note that you'll need docker installed.

# Clone the repository.
git clone https://github.com/HarrisonTotty/fab.git && cd fab

# Build and execute the container environment.
./build-env.sh && ./run-env.sh

(then navigate to http://127.0.0.1:8888/lab)

Project Status

This project is still really early in development. It's code is mostly based on a personal finance platform I wrote called tcat and is pretty opinionated. However if you want to contribute to the project, feel free to reach out to me. I imagine contribution requirements will morph as/if the project gets bigger.