Metadata-Version: 2.1
Name: rindap
Version: 1.1
Summary: Rindap API
Home-page: https://github.com/rindap/rindap-python-sdk/
Author: Rindap
Author-email: arge@rindap.com
License: UNKNOWN
Keywords: rindap
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
Requires-Dist: six
Requires-Dist: pytz
Requires-Dist: requests[security] (>=2.0.0) ; python_version<"3.0"
Requires-Dist: requests (>=2.0.0) ; python_version>="3.0"

# rindap-python

[![PyPI](https://img.shields.io/pypi/v/rindap.svg)](https://pypi.python.org/pypi/rindap)
[![PyPI](https://img.shields.io/pypi/pyversions/rindap.svg)](https://pypi.python.org/pypi/rindap)

## Documentation

The documentation for the Rindap API can be found [here][apidocs].

The Python library documentation can be found [here][libdocs].

### Supported Python Versions

This library supports the following Python implementations:

* Python 2.7
* Python 3.4
* Python 3.5
* Python 3.6
* Python 3.7
* Python 3.8

## Installation

Install from PyPi using [pip](http://www.pip-installer.org/en/latest/), a
package manager for Python.

    pip install rindap

Don't have pip installed? Try installing it, by running this from the command
line:

    $ curl https://raw.github.com/pypa/pip/master/contrib/get-pip.py | python

Or, you can [download the source code
(ZIP)](https://github.com/rindap/rindap-python-sdk/zipball/master "rindap-python-sdk
source code") for `rindap-python-sdk`, and then run:

    python setup.py install

You may need to run the above commands with `sudo`.

## Getting Started

Getting started with the Rindap API couldn't be easier. Create a
`Client` and you're ready to go.

### API Credentials

The `Rindap` needs your Rindap credentials. You can either pass these
directly to the constructor (see the code below) or via environment variables.

```python
from rindap.rest import Client

account = "ACXXXXXXXXXXXXXXXXX"
token = "YYYYYYYYYYYYYYYYYY"
client = Client(account, token)
```

Alternately, a `Client` constructor without these parameters will
look for `ACCOUNT_SID` and `AUTH_TOKEN` variables inside the
current environment.

We suggest storing your credentials as environment variables. Why? You'll never
have to worry about committing your credentials and accidentally posting them
somewhere public.


```python
from rindap.rest import Client
client = Client()
```

### Create a Workspace

```python
from rindap.rest import Client

account = "ACXXXXXXXXXXXXXXXXX"
token = "YYYYYYYYYYYYYYYYYY"
client = Client(account, token)

client.rindap.workspaces.create('a friendly name')
```

### Handling Exceptions

```python
from rindap.rest import Client
from rindap.base.exceptions import RindapRestException

account = "ACXXXXXXXXXXXXXXXXX"
token = "YYYYYYYYYYYYYYYYYY"
client = Client(account, token)

try:
    client.rindap.workspaces.get("WSd8d1e9c8c0384fe7abd63c0abafd1966").delete()
except RindapRestException as e:
    print(e)
```

### Docker Image

The `Dockerfile` present in this repository and its respective `rindap/rindap-python-sdk` Docker image are currently used by Rindap for testing purposes only.

### Getting help

If you need help installing or using the library, please check the [Rindap Support Help Center](https://support.rindap.com).

If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!

[apidocs]: https://slate.rindap.com/
[libdocs]: https://rindap.github.io/rindap-python-sdk


