Development Install
Contents
Development Install#
Installing with invoke
#
First, create a virtualenv
for the project using python,
conda,
virtualenvwrapper, 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 it to establish 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:
Get the repo:
git clone https://github.com/adelphi-ed-tech/nycschools.git
Move into the project directory.
Create a
venv
for your project.Install the project requirements with
pip
orconda
. These are found inrequirements.txt
Install the library from source in development mode:
pip install -e nycschools
Download the data from: https://drive.google.com/file/d/1I35Wr1-UObcPm9CYSgqPUa8JOzOuAQBF/view?usp=share_link
Create a new folder called
nyc-schools
and extract the contents ofnycschools-data.7z
intonyc-schools