Metadata-Version: 2.4
Name: fiftyone_ipintelligence_cloud
Version: 0.0.1
Summary: 51Degrees IP Intelligence resolves an IP address to detailed location, network and registration information. This package retrieves IP intelligence results by consuming the 51Degrees cloud service.
Home-page: https://51degrees.com/
Author: 51Degrees Engineering
Author-email: engineering@51degrees.com
License: EUPL-1.2
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: fiftyone_ipintelligence_shared
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# 51Degrees IP Intelligence Engines - Cloud

![51Degrees](https://51degrees.com/img/logo.png?utm_source=github&utm_medium=repository&utm_content=readme_main&utm_campaign=python-open-source "Data rewards the curious") **Python IP Intelligence**

[Developer Documentation](https://51degrees.com/ip-intelligence-python/index.html?utm_source=github&utm_medium=repository&utm_content=documentation&utm_campaign=python-open-source "developer documentation")

## Introduction

This package uses the 51Degrees cloud service to resolve IP addresses to
location, network and registration information using the
[51Degrees Pipeline API](https://51degrees.com/documentation/index.html).

To use the cloud service you will need a resource key. You can obtain one
from the [51Degrees Configurator](https://configure.51degrees.com/).

## Usage

```python
from fiftyone_ipintelligence_cloud.ipintelligence_cloud_pipelinebuilder import IpIntelligenceCloudPipelineBuilder

pipeline = IpIntelligenceCloudPipelineBuilder(resource_key="YOUR_RESOURCE_KEY").build()

flowdata = pipeline.create_flowdata()
flowdata.evidence.add("query.client-ip-51d", "185.28.167.78")
flowdata.process()

print(flowdata.ip.registeredname.value())
```

## Folders

- `fiftyone_ipintelligence_cloud` - the IP intelligence cloud engine and
  pipeline builder.
- `tests` - unit tests. These mock the cloud service so no resource key is
  required; set the `resource_key` environment variable to also run the live
  cloud integration test.
