Human Rights First is a non-profit organization that challenges the United States to respect its ideals. There goal with this project is to have relevant data shown for all users to see. The problem our team is trying to solve is how to transform the relevant data that was pulled from social media into visualizations that will assistant in aiding user's understanding of the current situation. The final solution to the problem was developed graphs of the United States where incidents were separated by location and another by month.
| Chase Goldfeld | Andy Tran | Nirmal Thapa | ||
|---|---|---|---|---|
 |
 |
 |
||
 |
|
|
| Griffin Wilson | Kristine Wang | Daniel Benson | ||
|---|---|---|---|---|
 |
 |
 |
||
| |
|
|
You can find the deployed project at Frontend Website, Backend API, Data Science API.
Our team is developing an interactive map that identifies potential instances of police use of force across the United States of America for Human Rights First, an independent advocacy and action organization.
We're pulling data from similiar APIs(All locations V2 - https://raw.githubusercontent.com/2020PB/police-brutality/data_build/all-locations-v2.json, 846- https://api.846policebrutality.com/api/incidents) and from Twitter and Reddit. We want to identify aggregate these instances.
- User can browse incident map
- User can view specific instances with original source links
- User can view map with various filters
- Python
- Docker
- FastAPI
- AWS Elastic Beanstalk
- Wanted to gain insight to AWS
- Docker makes environments easier
- FastAPI has been gaining traction over Flask
- Pandas
- Seaborn
- spacy
- nltk
- PRAW
- Plotly
- spacy
- newspaper3k
We are sending json objects to the backend with information about instances of police use of force. This information includes location data (city, state, and geocode) and relevant details about the incident, like the type of force that was used.
PRAW, The Python Reddit API Wrapper, makes it easy for users to analyze Reddit data. We used PRAW to scrape Reddit for potential instances of police of force.
In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:
* PRAW_CLIENT_ID - keys for Reddit API
* PRAW_CLIENT_SECRET - keys for Reddit API
* PRAW_USER_AGENT - keys for Reddit API
| Image Filename | Source / Creator | License |
|---|---|---|
| name1.svg | Griffin Wilson | MIT |
We tested the classifier on sets of 100-1000 incidents at a time, our aim was in precision as to minimize false incidents included.
We used Docker for ease of use when dealing with environmental dependancies
Get AWS credentials
Get your AWS access keys
Install AWS Command Line Interface
* aws configure -> configures AWS CLI
* pip install pipx -> installs pipx
* pipx install awsebcli -> installs AWS Elastic BeanStalk CLI
Follow AWS EB docs: Use Docker to build the image locally, test it locally, then push it to Docker Hub
* docker build -f project/Dockerfile -t YOUR-DOCKER-HUB-ID/YOUR-IMAGE-NAME ./project
* docker login
* docker push YOUR-DOCKER-HUB-ID/YOUR-IMAGE-NAME
Edit the image name in Dockerrun.aws.json then replace YOUR-DOCKER-HUB-ID/YOUR-IMAGE-NAME with your values
Then use the EB CLI:
* git add --all
* git commit -m "Your commit message"
* eb init -p docker YOUR-APP-NAME --region us-east-1
* eb create YOUR-APP-NAME
* eb open
Then use AWS Route 53 to set up a domain name with HTTPS for your DS API
Redeploy:
* git commit ...
* docker build ...
* docker push ...
* eb deploy
* eb open
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct. Please follow it in all your interactions with the project.
If you are having an issue with the existing project code, please submit a bug report under the following guidelines:
- Check first to see if your issue has already been reported.
- Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
- Create a live example of the problem.
- Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.
We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.
If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.
Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
- Ensure that your code conforms to our existing code conventions and test coverage.
- Include the relevant issue number, if applicable.
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
These contribution guidelines have been adapted from this good-Contributing.md-template.
See Backend Documentation for details on the backend of our project.