Setup Development Environment

1. Download and install the latest Python 3 distribution (currently 3.6) from the Python website.

2. Create and Activate a Python Virtual Environment for Development from your OS command-line

   python -m venv py3-dev
   source py3-dev/bin/activate # for Linux and MacOS
   py3-env\Scripts\activate # for Windows
   

3. Clone Alliance BIBCAT source code repository

   git clone https://github.com/KnowledgeLinks/alliance-bibcat
   

   Change to that directory

   cd alliance-bibcat
   

4. Init and Update the BIBCAT and RDFW submodules

   git submodule init
   git submodule update
   

5. Change to the development branch and pull in latest changes

   git checkout -b development 
   git pull origin development
   

6. Install Python Dependencies using pip

   pip install -r requirements.txt 
   

7. Make an instance directory for development configuration

   mkdir instance
   

8. Create a config.py file

   touch config.py
   

9. Open config.py in a text editor and the following lines to the top of the file:

   import os
   import sys
   sys.path.append(os.path.abspath(os.path.dirname(__file__)))
   from example_instance.config import *
   

10. Add these configuration values to config.py