ra

How to Run the Game

Currently, the game can be run using the command: python3 game/ra.py -n 2 --p1 Albert --p2 Belinda

See python3 game/ra.py -h for more options to start the game with.

In general, a RaGame instance must be initialized, then the function start_game function should be called from within the instance. For example, the below code initializes a two-player game between "Albert" and "Belinda":

game = RaGame(["Albert", "Belinda"], outfile = "game3.txt")
game.start_game()

Python Requirements

pipenv and pyenv

As of the latest update, we recommend leveraging pipenv and pyenv to maintain a hermetic static for dependencies. The other options are left here only for reference as they are not maintained/tested often.

On Mac, make sure you have Homebrew installed. You can install pipenv and pyenv with:

brew install pipenv
brew install pyenv
# This is required by our backend database. If you do not install,
# you will receive errors when installing the Python deps.
brew install postgresql@14

After installing, you navigate to the root of the project directory, and run:

pipenv install

This will install all the required dependencies as well as the appropriate Python version (using pyenv). You can then run:

pipenv shell

When installing future dependencies, just make sure you use pipenv. For example:

pipenv install flask

Environment Varibles.

You'll also need to define a few environment variables. Note that when using pipenv, you can define these variables in .env which will automatically load them.

# Set the database location.
DATABASE_URI=sqlite:////tmp/game.db
# Add current working directory to python path.
PYTHONPATH=${PYTHONPATH}:${PWD}

Type Checking and Linter

For development purposes, you want to also install the dev dependencies by running pipenv install -d. For type-checking, we use pyre. See here to install.

You should be able to type check by running:

# Assumes you're in the right shell.
pipenv run pyre

We also use black for formatting. If you installed the development dependecies, you can run:

pipenv run black .

Additionally, we recommend that you enable a pre-commit hook. The configuration is included in the repo. You can run:

pipenv run pre-commit install

Note that these commands will be run when push to the master branch on github as well. You'll be able to see the results on Github Actions.

Testing

Testing for the RaGame class and for the newer functions of the GameState class are still needed. Existing tests can be found in the tests folder, where each file is a set of tests.

We use the unittest framework. To run the tests, run:

# Assumes you're in the right shell.
pipenv run python -m unittest

Note that above automatically runs all tests found in test_*.py files.

Deployment

When pushed, this server gets deployed to ra-server.fly.dev.

Ra Server

To launch the backend server for debugging, you first need to define an ENVIRONMENT VARIABLE for the data. If using pipenv, create a .env file and run:

DATABASE_URL=sqlite:////tmp/game.db

Then run:

pipenv run uvicorn --host 0.0.0.0 --port 8080 --workers 1 --lifespan on --proxy-headers --log-level debug app:asgi_app

Ra Website

See frontend/README.md.

Specifications

Runs on Python3.9. Probably works on any Python3 version, but not Python2.