Development Install#

Installing with invoke#

First, create a virtualenv for the project using python, conda, virtualenvwrapper, VS Code, or whichever manner you choose.

Once it’s created, make sure your venv is active. This project uses the invoke task runner to automate development tasks, and we’ll use invoke to create your environment. At this time, the tasks are configured to work in a linux (and probably mac osx) environment.

# clone the repository
git clone https://github.com/adelphi-ed-tech/nycschools.git
cd nycschools

# install the development requirements
pip install -r requirements.txt

# run the development install task
invoke install-dev

Manual dev install#

If invoke isn’t working for you or you are setting up on windows, you can get up and running with these steps:

  1. Get the repo: git clone https://github.com/adelphi-ed-tech/nycschools.git

  2. Move into the project directory.

  3. Create a venv for your project and activate it.

  4. Install the project requirements with pip or conda. These are found in requirements.txt Run: pip install -r requirements.txt

  5. Install the library from source in development mode. Run: pip install -e .[dev]

  6. Download the data with the interactive installer. Run: python -m nycschools.dataloader -d

  7. Follow the directions from the regular install to configure environment variables.