go-pipl
The unofficial golang wrapper for the pipl.com API.
![Donate](https://img.shields.io/badge/donate-bitcoin-ff9900.svg?logo=bitcoin&style=flat)
Table of Contents
Installation
go-pipl requires a supported release of Go.
go get -u github.com/mrz1836/go-pipl
Documentation
View the generated documentation
![GoDoc](https://godoc.org/github.com/mrz1836/go-pipl?status.svg&style=flat)
Features
- Complete coverage for the pipl.com API
- Client is completely configurable
- Using heimdall http client with exponential backoff & more
- Minimum criteria detection before submitting a pipl query
- Search by pipl pointer reference
- Search for a single person via any of the following:
- Full Name
- Full Street Address
- Email
- Phone
- Username or UserID or URL
- Search all possible people
- Returns the original full person record
- Searches all possible persons and gets full details
- Combines all persons into one single response
- Thumbnail configuration setting for
person.Images
- Adds
image.ThumbnailURL
with the complete url for a live thumbnail
- Test and example coverage for all methods
Library Deployment
goreleaser for easy binary or library deployment to Github and can be installed via: brew install goreleaser
.
The .goreleaser.yml file is used to configure goreleaser.
Use make release-snap
to create a snapshot version of the release, and finally make release
to ship to production.
Makefile Commands
View all makefile
commands
make help
List of all current commands:
all Runs lint, test-short and vet
clean Remove previous builds and any test cache data
clean-mods Remove all the Go mod cache
coverage Shows the test coverage
godocs Sync the latest tag with GoDocs
help Show this help message
install Install the application
install-go Install the application (Using Native Go)
lint Run the golangci-lint application (install if not found)
release Full production release (creates release in Github)
release Runs common.release then runs godocs
release-snap Test the full release (build binaries)
release-test Full production test release (everything except deploy)
replace-version Replaces the version in HTML/JS (pre-deploy)
tag Generate a new tag and push (tag version=0.0.0)
tag-remove Remove a tag if found (tag-remove version=0.0.0)
tag-update Update an existing tag to current commit (tag-update version=0.0.0)
test Runs vet, lint and ALL tests
test-short Runs vet, lint and tests (excludes integration tests)
test-travis Runs all tests via Travis (also exports coverage)
test-travis-short Runs unit tests via Travis (also exports coverage)
uninstall Uninstall the application (and remove files)
update-linter Update the golangci-lint package (macOS only)
vet Run the Go vet application
Examples & Tests
All unit tests and examples run via Travis CI and uses Go version 1.15.x. View the deployment configuration file.
Run all tests (including integration tests)
make test
Run tests (excluding integration tests)
make test-short
Benchmarks
Run the Go benchmarks:
make bench
Code Standards
Read more about this Go project's code standards.
Usage
Basic implementation:
package main
import (
"fmt"
"log"
"os"
"github.com/mrz1836/go-pipl"
)
func main() {
client, _ := pipl.NewClient("your-api-key", nil)
person := pipl.NewPerson()
_ = person.AddUsername("jeffbezos", "twitter")
response, _ := client.Search(person)
fmt.Println(response.Person.Names[0].Display)
}
Maintainers
Contributing
View the contributing guidelines and follow the code of conduct.
How can I help?
All kinds of contributions are welcome :raised_hands:!
The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon:.
You can also support this project by becoming a sponsor on GitHub :clap:
or by making a bitcoin donation to ensure this journey continues indefinitely! :rocket:
Credits
This project was based off the original code go pipl project by xpcmdshell
License
![License](https://img.shields.io/github/license/mrz1836/go-pipl.svg?style=flat)