Popularity
0.5
Stable
Activity
7.6
Declining
3
1
0

Programming language: Go
Tags: API     Go Tools     Go     Golang     Pipl    
Latest version: v0.2.1

go-pipl alternatives and similar packages

Based on the "Go Tools" category

Do you think we are missing an alternative of go-pipl or a related project?

Add another 'Go Tools' Package

README

go-pipl

go-pipl is a simple golang wrapper to help find people using the pipl.com API.

Go Build Status Report Codacy Badge Release standard-readme compliant GoDoc

Table of Contents

Installation

go-pipl requires a supported release of Go.

$ go get -u github.com/mrz1836/go-pipl

Documentation

You can view the generated documentation here.

Features

  • Complete coverage for the pipl.com API
  • [Client](client.go) 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 for person.Images
    • Adds image.ThumbnailURL with the complete url for a live thumbnail
  • Test and example coverage for all methods

Examples & Tests

All unit tests and [examples](pipl_test.go) run via Travis CI and uses Go version 1.13.x. View the [deployment configuration file](.travis.yml).

  • [helper examples & tests](helper_test.go)
  • [pipl examples & tests](pipl_test.go)
  • [response tests](response_test.go)

Run all tests (including integration tests)

$ cd ../go-pipl
$ go test ./... -v

Run tests (excluding integration tests)

$ cd ../go-pipl
$ go test ./... -v -test.short

Benchmarks

Run the Go [benchmarks](pipl_test.go):

$ cd ../go-pipl
$ go test -bench . -benchmem

Code Standards

Read more about this Go project's [code standards](CODE_STANDARDS.md).

Usage

  • View the [pipl examples & benchmarks](pipl_test.go)
  • View the [helper examples & benchmarks](helper_test.go)
  • View the [response tests](response_test.go)

Basic implementation:

package main

import (
    "fmt"
    "log"
    "os"
    "github.com/mrz1836/go-pipl"
)

func main() {

    // Create a client with your api key
    client, _ := pipl.NewClient("your-api-key", nil)

    // Create a new person for searching
    person := pipl.NewPerson()
    person.AddUsername("jeffbezos", "twitter")

    // Submit the search
    response, _ := client.Search(person)

    // Use the pipl response
    fmt.Println(response.Person.Names[0].Display)
    // Output: Jeff Preston Bezos
}

Maintainers

@MrZ

Contributing

This project was based off the original code go pipl project by xpcmdshell

View the [contributing guidelines](CONTRIBUTING.md) and follow the [code of conduct](CODE_OF_CONDUCT.md).

Support the development of this project πŸ™

Donate

License

License


*Note that all licence references and agreements mentioned in the go-pipl README section above are relevant to that project's source code only.