FBIwanted

This package is a FBI Wanted API python wrapper.

It allows you to retrieve a data set of FBI wanted people by their appearance features or by administrative regions(city name), as well as downloading their posters to see the photos.

Try it out if you suspect someone you see may be a FBI wanted person, with the data set retrieved with this package, you may find out whether you are in real danger and whether there is a reward!

Installation

$ pip install -i https://test.pypi.org/simple/ fbiwanted

Usage

Functions

1. fbi_wanted_appearance

fbi_wanted_appearance(eyes = None, hair = None, race = None)

Retrieve a data set of FBI wanted people by appearance features, including eye color, hair color and race.

2. fbi_wanted_office

fbi_wanted_office(field_offices = None)

Retrieve a data set of FBI wanted people by administration office. Input a lowercase city name with no space.

3. fbi_poster_appearance

fbi_poster_appearance(eyes = None, hair = None, race = None)

Download the posters of the FBI wanted people who look as you described. Easy way to compare and find out if you have really met a fugitive or missing person.

Column description

There are 12 columns in the dataframe you get using this package, with the function fbi_wanted_appearance() and fbi_wanted_office() below.

They are:

- name

- status:

Whether the FBI wanted person has been captured. "captured" means they've been captured, na means they are still out there.

- sex

- nationality

- race

- hair:

Hair color of the FBI wanted person when last seen, "bald" means they had no hair.

- eyes:

Eye color of the FBI wanted person.

- height_max:

The estimated maximum height, in inches.

- height_min:

The estimated minimum height, in inches.

- scars_and_marks:

Descriptions of the scars or marks the FBI wanted person has on their body.

- dates_of_birth_used

- place_of_birth

- occupations

- languages

- aliases

- subjects:

The catrgory of the reason why the FBI wanted person is wanted, like "White-Collar Crime“, "Kidnappings and Missing Persons", etc.

- field_offices:

A lowercase city name with no space between words.

- url:

A url that leads to the FBI webpage of the FBI wanted person. Photos, posters, and more details may be found there.

- reward_max:

The amount of reward one may get by providing clues for finding the FBI wanted person.

- warning_message:

A warning message indicating whether the FBI wanted person is armed, or be dangerous in other ways.

(More columns may be included in the future releases of this package.)

Quick Start

import all functions

>>> from fbiwanted import FBIwanted

1. Retrieve FBI wanted people info by appearance.

Example: Look for information of FBI wanted people with brown eyes, blond hair and are white.

>>> FBIwanted.fbi_wanted_appearance(eyes = "brown", hair = "blond", race = "white")

It returns a message telling you how many records are found, and a pandas dataframe with 12 columns.

12 records retrieved.

More about the input and out can be found with the help() function.

>>> help(fbi_wanted_appearance)

2. Retrieve FBI wanted people info by city name.

Example: Look for information of FBI wanted people under the adminiatration of FBI office in Honolulu.

>>> FBIwanted.fbi_wanted_office(field_offices = "honolulu"))

It also returns a message telling you how many records are found, and a pandas dataframe, with the same 12 columns as function 1:

5 records retrieved.

More about the input and out can be found with the help() function.

>>> help(fbi_wanted_office)

3. Download posters of FBI wanted people by appearence.

Example: Download posters of FBI wanted people with black eyes and black hair.

>>> FBIwanted.fbi_poster_appearance(eyes = "black", hair = "black")

It returns a message telling you how many poster PDFs are downloaded.

Download completed. 10 posters downloaded.

Posters in PDF format will be downloaded into your working directory. Careful! There can be hundreds of posters.

Try it out

• Here is a jupyter notebook demo with the example codes above, just change the parameters to get the data set you want! Note that I've already ran the sample codes once, so there are some poster PDF files in the Demo folder.

• Here you can retrieve and explore the whole original dataset. A function to retrieve a complete and clean full dataset will also be added in future releases.

Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

License

FBIwanted was created by Qinyue Hao. It is licensed under the terms of the MIT license.

Credits

FBIwanted was created with cookiecutter and the py-pkgs-cookiecutter template.