pingintel-api

Python client library for API and commandline tools for Ping products.

Setup

pip install pingintel-api

You will probably want to create a ~/.pingintel.ini file, which can store your API keys. (They can also be provided in the environment, via --auth-token on the commandline, or passed as arguments):

Example ~/.pingintel_ini file:

[sovfixer]
# use this by default
SOVFIXER_AUTH_TOKEN = abcdxxxx
# use _STG for staging environment. if not provided, fall back to SOVFIXER_AUTH_TOKEN.
SOVFIXER_AUTH_TOKEN_STG = efghxxxx
# use _DEV for staging environment. if not provided, fall back to SOVFIXER_AUTH_TOKEN.
SOVFIXER_AUTH_TOKEN_DEV = efghxxxx

[pingvision]
# use _DEV or _STG  versions as desired
PINGVISION_AUTH_TOKEN = abcdxxxx

[pingdata]
# use _DEV or _STG  versions as desired
PINGDATA_AUTH_TOKEN = abcdxxxx

[pingmaps]
# use _DEV or _STG  versions as desired
PINGMAPS_AUTH_TOKEN = abcdxxxx

Usage

This package installs a number of commandline tools:

sovfixerapi pingvisionapi pingdataapi pingmapsapi

These tools are thin wrappers around the client API libraries.

See the examples/ directory for some usage examples. For instance, to submit an SOV to Ping SOV Fixer and poll for completion:

from pingintel_api import SOVFixerAPIClient

api_client = SOVFixerAPIClient()
api_client.fix_sov("test_sov.xlsx")

API Documentation

pingvisionapi

Usage: pingvisionapi [OPTIONS] COMMAND [ARGS]...

Options:
  -e, --environment [prod|prodeu|staging|dev]
  -u, --api-url TEXT              Provide base url (instead of environment,
                                  primarily for debugging)
  --auth-token TEXT               Provide auth token via --auth-token or
                                  PINGVISION_AUTH_TOKEN environment variable.
  -v, --verbose                   Can be used multiple times. -v for INFO, -vv
                                  for DEBUG, -vvv for very DEBUG.
  --help                          Show this message and exit.

Commands:
  activity                  List submission activity.
  create                    Create new submission from file(s).
  download-document         Download document by document URL.
  events                    List submission events.
  get                       Get submission detail.
  get-output                Fetch or generate an output from a previous...
  list-submission-statuses  List submission statuses.
  list-teams                List teams.

sovfixerapi

Usage: sovfixerapi [OPTIONS] COMMAND [ARGS]...

Options:
  -e, --environment [prod|prodeu|staging|dev]
  -u, --api-url TEXT              Provide base url (instead of environment,
                                  primarily for debugging)
  --auth-token TEXT               Provide auth token via --auth-token or
                                  SOVFIXER_AUTH_TOKEN environment variable.
  -v, --verbose                   Can be used multiple times. -v for INFO, -vv
                                  for DEBUG, -vvv for very DEBUG.
  --help                          Show this message and exit.

Commands:
  activity             List submission activity.
  check-progress       Check the progress of a submission.
  fix                  Extract insurance information from file(s).
  get-output           Fetch or generate an output from a previous...
  history              List submission activity.
  list-output-formats  List available output formats.
  serverinfo
  update               Update an existing SOV with new location data.

pingdataapi

Usage: pingdataapi [OPTIONS] COMMAND [ARGS]...

Options:
  -e, --environment [prod|prodeu|staging|dev]
  -u, --api-url TEXT              Provide base url (instead of environment,
                                  primarily for debugging)
  --auth-token TEXT               Provide auth token via --auth-token or
                                  PINGDATA_AUTH_TOKEN environment variable.
  -v, --verbose                   Can be used multiple times. -v for INFO, -vv
                                  for DEBUG, -vvv for very DEBUG.
  -D, --delegate-to ORG_SHORT_NAME
                                  Delegate to another organization. Provide
                                  the 'short name' of the desired delegatee.
                                  Requires the `delegate` permission.
  --help                          Show this message and exit.

Commands:
  bulk-enhance      Request data about multiple addresses using async API.
  enhance           Request data synchronously about a single address.
  get-datasource    Get the configuration for a single datasource by its...
  list-datasources  List the datasource configurations the authenticated...
  usage             Get API credit usage over a time range, broken down...

For complete documentation on the REST API, please see https://docs.pingintel.com/.

pingmapsapi

Usage: pingmapsapi [OPTIONS] COMMAND [ARGS]...

Options:
  -e, --environment [prod|prodeu|staging|dev]
  -u, --api-url TEXT              Provide base url (instead of environment,
                                  primarily for debugging)
  --auth-token TEXT               Provide auth token via --auth-token or
                                  PINGDATA_AUTH_TOKEN environment variable.
  -v, --verbose                   Can be used multiple times. -v for INFO, -vv
                                  for DEBUG, -vvv for very DEBUG.
  --help                          Show this message and exit.

Commands:
  settings  Get current user's settings.

Contributing

pingintel-api uses hatch for pypi packaging and updates. Install it for your platform first.

  1. Update the __about__.py file with the new version number.

  2. hatch build: Create the necessary pypi packages.

  3. Create a ~/.pypirc file. It should look something like this:

    [distutils]
index-servers = pypi testpypi

[pypi]
repository = https://upload.pypi.org/legacy/
username = __token__
password = <your pypi token here>

  4. hatch publish: Push the new package(s) to pypi. (Note that you'll need a pypi account and to be a member of our organization for this step.)

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

Owner

PyPI data
Data sourced directly from PyPI's database.

7 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for acmisiti from gravatar.com acmisiti Avatar for blbuford from gravatar.com blbuford Avatar for josephmisiti from gravatar.com josephmisiti
+4 more Avatar for mpezzula from gravatar.com mpezzula Avatar for murphypeisel from gravatar.com murphypeisel Avatar for nkalfa from gravatar.com nkalfa Avatar for sykhader from gravatar.com sykhader

Credits

Author: Ping Intel

License

MIT License

Requires

Python >=3.11

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pingintel_api-1.4.12.tar.gz (299.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pingintel_api-1.4.12-py3-none-any.whl (47.0 kB view details)

Uploaded Python 3

File details

Details for the file pingintel_api-1.4.12.tar.gz.

File metadata

  • Download URL: pingintel_api-1.4.12.tar.gz
  • Upload date:
  • Size: 299.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.18.0 {"ci":null,"cpu":"arm64","distro":{"name":"macOS","version":"26.2"},"implementation":{"name":"CPython","version":"3.12.10"},"installer":{"name":"hatch","version":"1.18.0"},"openssl_version":"OpenSSL 3.6.0 1 Oct 2025","python":"3.12.10","system":{"name":"Darwin","release":"25.2.0"}} HTTPX2/2.12.0

File hashes

Hashes for pingintel_api-1.4.12.tar.gz
Algorithm Hash digest
SHA256 6dcfbc051213da978c67c29d9a5380802b3bd4870bbc6b85935c85dc571e96df
MD5 e84606d6f50d65e244d1c880d1e687c5
BLAKE2b-256 7f98be61e79cf6d0d6bc524fac23ff2f87cbbac18c4a06a76c1cf5deec68988e

See more details on using hashes here.

File details

Details for the file pingintel_api-1.4.12-py3-none-any.whl.

File metadata

  • Download URL: pingintel_api-1.4.12-py3-none-any.whl
  • Upload date:
  • Size: 47.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.18.0 {"ci":null,"cpu":"arm64","distro":{"name":"macOS","version":"26.2"},"implementation":{"name":"CPython","version":"3.12.10"},"installer":{"name":"hatch","version":"1.18.0"},"openssl_version":"OpenSSL 3.6.0 1 Oct 2025","python":"3.12.10","system":{"name":"Darwin","release":"25.2.0"}} HTTPX2/2.12.0

File hashes

Hashes for pingintel_api-1.4.12-py3-none-any.whl
Algorithm Hash digest
SHA256 08788034c43ce7973b71638caeb4b8a111670ee7e66bfa68a38d476cccaf1ee1
MD5 f1d3ab57fd79e4f574fe0d44975bf97e
BLAKE2b-256 2a43b3f65b9d75305b3e40904da1a2344f38c53ada4f573d596e9dfcd3cd4af1

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.4.12 This release

2 files

1.4.11

2 files

1.4.10

2 files

1.4.9

2 files

1.4.8

2 files

1.4.7

2 files

1.4.6

2 files

1.4.5

2 files

1.4.3.1

2 files

1.4.3

2 files

1.4.2

2 files

1.4.1

2 files

1.4.0

2 files

1.3.11

2 files

1.3.10

2 files

1.3.9

2 files

1.3.8

2 files

1.3.7

2 files

1.3.6

2 files

1.3.5

2 files

1.3.4

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

1.2.0

2 files

1.1.9

2 files

1.1.8

2 files

1.1.7

2 files

1.1.6

2 files

1.1.5

2 files

1.1.4

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.7

2 files

1.0.6

2 files

1.0.5

2 files

1.0.4

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.11.8

2 files

0.11.7

2 files

0.11.6

2 files

0.11.5

2 files

0.11.4

2 files

0.11.3

2 files

0.11.2

2 files

0.11.0

2 files

0.10.6

2 files

0.10.5

2 files

0.10.4

2 files

0.10.3

2 files

0.10.2

2 files

0.10.1

2 files

0.10.0

2 files

0.9.1

2 files

0.9.0

2 files

0.8.1

2 files

0.8.0

2 files

0.7.0

2 files

0.6.0

2 files

0.5.0

2 files

0.4.0

2 files

0.3.0

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page