Developer Installation

Developer Installation

In order to contribute to Grama, you will need to follow these instructions.

Uninstall any local py-grama copy

pip uninstall py-grama

Create a fork

Click the Fork button (on the top-right of the py_grama GitHub page) to create your own "forked" copy of the repository.

Install locally

Clone your forked copy to your computer.

Note 1: We recommend Anaconda Python as your distribution, as it takes care of many of the dependencies for Grama.

Note 2: Make sure to use the req-both.txt requirements file; a developer install requires additional packages to run the test suite.

git clone [email protected]:${USERNAME}/py_grama.git
cd py_grama/
pip install -r req-both.txt
pip install .

Where ${USERNAME} is your GitHub username.

Add to your PYTHONPATH

Adding py_grama to your PYTHONPATH will allow for local importing of py_grama throughout your system. In order to make this change follow these instructions

Gotcha's!

Working in Windows

If you are running into errors while running Grama in your command line, you may find it helpful to use the Ubuntu for Windows terminal instead.