Metadata-Version: 2.4
Name: openapiipify
Version: 6.0.0
Summary: openapi-ipify
Home-page: https://github.com/oapicf/openapi-ipify
Author: OpenAPI Clients Factory
Author-email: OpenAPI Clients Factory <blah+oapicf@cliffano.com>
License: MIT
Project-URL: Repository, https://github.com/oapicf/openapi-ipify
Keywords: OpenAPI,OpenAPI-Generator,openapi-ipify
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author
Dynamic: home-page

# openapiipify
OpenAPI client for ipify, a simple public IP address API

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 6.0.0
- Package version: 6.0.0
- Generator version: 7.18.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://github.com/oapicf/openapi-ipify](https://github.com/oapicf/openapi-ipify)

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/oapicf/openapi-ipify.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/oapicf/openapi-ipify.git`)

Then import the package:
```python
import openapiipify
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import openapiipify
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import openapiipify
from openapiipify.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api64.ipify.org
# See configuration.py for a list of all supported configuration parameters.
configuration = openapiipify.Configuration(
    host = "https://api64.ipify.org"
)



# Enter a context with an instance of the API client
with openapiipify.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapiipify.DefaultApi(api_client)
    format = 'format_example' # str | Response format (optional)
    param_callback = 'param_callback_example' # str | JSONP callback function name (optional)

    try:
        # Get your public IP address
        api_response = api_instance.get_ip(format=format, param_callback=param_callback)
        print("The response of DefaultApi->get_ip:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->get_ip: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api64.ipify.org*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**get_ip**](docs/DefaultApi.md#get_ip) | **GET** / | Get your public IP address


## Documentation For Models

 - [GetIp200Response](docs/GetIp200Response.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization

Endpoints do not require authorization.


## Author

blah+oapicf@cliffano.com


