Skip to content

amandareilly/skills-api

Repository files navigation

Open Skills API - Sharing the DNA of America's Jobs

Provides a complete and standard data store for canonical and emerging skills, knowledge, abilities, tools, technolgies, and how they relate to jobs.

Overview

TODO - Write a sweet, sweet overview of the API

Demo

The following endpoints were automatically deployed via the Zappa framework to Amazon Web Services.

Dependencies

  • Python 2.7.11

Installation

To run the API locally, please perform the following steps:

  1. Clone the repository from https://www.github.com/dssg/skills-api
$ git clone https://www.github.com/dssg/skills-api
  1. Navigate to the checked out project
$ cd skills-api
  1. Ensure that pip package manager is installed. See installation instructions here.
$ pip --version
  1. Install the virtualenv package. Please review the documentation if you are unfamiliar with how virtualenv works.
$ pip install virtualenv
  1. Create a Python 2.7.11 virtual environment called venv in the project root directory
$ virtualenv -p /path/to/python/2.7.11 venv
  1. Activate the virtual environment. Note that the name of the virtual environment (venv) will be appended to the front of the command prompt.
$ source venv/bin/activate 
(venv) $
  1. Install dependencies from requirements.txt
$ pip install -r requirements.txt

Deployment to Amazon Web Services

TODO - Write some deployment instructions here

Dependencies

TODO - Write some dependencies.

Packages

No packages published

Languages

  • Python 86.9%
  • Shell 13.1%