18F/crime-data-api

---
# .about.yml project metadata
#
# Short name that acts as the project identifier (required)
name: Crime Data API
 
# Full proper name of the project (required)
full_name: FBI Crime Data Explorer API
 
# The type of content in the repo
# values: app, docs, policy
type: app
 
# Describes whether a project team, working group/guild, etc. owns the repo (required)
# values: guild, working-group, project
owner_type: project
 
# Name of the main project repo if this is a sub-repo; name of the working group/guild repo if this is a working group/guild subproject
#parent:
 
# Maturity stage of the project (required)
# values: discovery, alpha, beta, live
stage: alpha
 
# Whether or not the project is actively maintained (required)
# values: active, deprecated
status: active
 
# Description of the project
description: >
  This is the API backend for the FBI Crime Data Explorer project, a
  tool for the public to search and download crime statistics from the
  FBI's Summary Reporting System (SRS) and National Incident-Based
  Reporting System (NIBRS) provided by police agencies across America.
 
# Should be 'true' if the project has a continuous build (required)
# values: true, false
testable: true
 
# Team members contributing to the project (required)
# Items:
# - github: GitHub user name
#   id: Internal team identifier/user name
#   role: Team member's role; leads should be designated as 'lead'
team:
- github: LarryBafundo
  id: Larry Bafundo
  role: Product Manager
 
- github: cacraig
  id: Colin Craig
  role: Back-End Developer
 
- github: catherinedevlin
  id: Catherine Devlin
  role: Back-End Developer
 
- github: nicoleslaw
  id: Nicole Fenton
  role: Content Designer
 
 
- github: ryansibley
  id: Ryan Sibley
  role: Content Designer
  
- github: harrisj
  id: Jacob Harris
  role: Back-End Developer
 
- github: jeremiak
  id: Jeremia Kimelman
  role: Front-End Developer
 
- github: AvivaOskow
  id: Aviva Oskow
  role: Visual Designer
 
- github: amberwreed
  id: Amber Reed
  role: Researcher
 
- github: brendansudol
  id: Brendan Sudol
  role: Front-End Developer
 
# Partners for whom the project is developed
partners:
- FBI
 
# Brief descriptions of significant project developments
milestones:
- "September 2016: Research begins"
- "October 2016: Prototyping & API Design begins"
- "December 2016: First sprint begins"
- "March 2017: MVP ready for launch"
 
# Technologies used to build the project
stack:
  - Python 3
  - SQLAlchemy
  - Flask
  - Marshmallow
 
# Brief description of the project's outcomes
impact: >
  The Crime Data Explorer is a website that will make crime data more
  accessible and easier to understand for law enforcement and the
  general public. As part of the FBI\'s broader effort to modernize
  crime reporting, the CDE will promote greater awareness of local,
  state, and national crime trends.
 
 
# Services used to supply project status information
# Items:
# - name: Name of the service
#   category: Type of the service
#   url: URL for detailed information
#   badge: URL for the status badge
services:
- name: Code Climate
  category: code quality
  url: https://codeclimate.com/github/18F/crime-data-api
  badge: https://codeclimate.com/github/18F/crime-data-api/badges/gpa.svg
- name: Code Climate Coverage
  category: code coverage
  url: https://codeclimate.com/github/18F/crime-data-api/coverage
  badge: https://codeclimate.com/github/18F/crime-data-api/badges/coverage.svg
- name: Gemnasium
  category: dependency management
  url: https://gemnasium.com/18F/crime-data-api
  badge: https://gemnasium.com/18F/crime-data-api.svg
- name: CircleCI
  category: Continuous Integration
  url: https://circleci.com/gh/18F/crime-data-api
  badge: https://circleci.com/gh/18F/crime-data-api.svg?style=svg
 
# Licenses that apply to the project and/or its components (required)
# Items by property name pattern:
#   .*:
#     name: Name of the license from the Software Package Data Exchange (SPDX): https://spdx.org/licenses/
#     url: URL for the text of the license
licenses:
  dashboard:
    name: CC0-1.0
    url: https://github.com/18F/team_api/blob/master/LICENSE.md
 
# Links to project artifacts
# Items:
# - url: URL for the link
#   text: Anchor text for the link
links:
- url: https://crime-data-api.fr.cloud.gov/
  text: Production website
 
# Email addresses of points-of-contact
contact:
- url: mailto:larry.bafundo@gsa.gov
  text: Larry Bafundo