pyrebrandly API

Request

Exceptions

exception pyrebrandly.exceptions.APIError

Base API Error

exception pyrebrandly.exceptions.APITimeoutError

API Operation Timeout

Code: 504

exception pyrebrandly.exceptions.APIUnavailableError

API endpoint under maintenance

Code: 503

exception pyrebrandly.exceptions.AlreadyExistsError

Link etc. Already Exists

Code: 403

exception pyrebrandly.exceptions.BadGatewayError

Failure in Rebrandly’s upstream providers

Code: 502

exception pyrebrandly.exceptions.BadRequestError

Invalid JSON Request

Code: 400

exception pyrebrandly.exceptions.Error

Base Error

exception pyrebrandly.exceptions.InternalServerError

API Endpoint Server Error

Code: 500

exception pyrebrandly.exceptions.InvalidFormatError

Invalid input format

Missing body

Limits threshold reached

Code: 403

exception pyrebrandly.exceptions.InvalidOptionsError(*, possible=None, invalid=None)

Invalid Options in Options dict()

:exception InvalidOptionsError

exception pyrebrandly.exceptions.NotAuthorizedError

Authorization credentials invalid

oAuth Token expired etc.

Code: 401

exception pyrebrandly.exceptions.NotEnoughArgumentsError(*, func=None, args=None)

Not Enough Arguments for method

exception pyrebrandly.exceptions.NotFoundError

Resource/Endpoint not found

Code: 404

exception pyrebrandly.exceptions.RebrandlyError

Base+Base Error

Installation

Installing via Pip

Installing via pip makes the install very easy.

• pip3 install pyrebrandly

Installing via source

If you want to install via source, you have to download the source.

Git

GitHub - git clone https://github.com/ElectroCode/pyrebrandly

GitLab - git clone https://gitlab.com/ElectroCode/pyrebrandly

PyPi

pip3 download pyrebrandly

pip3 install pyrebrandly -d <dir> - ‘Downloads package into <dir> instead of installing, regardless of what’s already installed’

You will want to run the following to get the dependencies for :bold:`pyrebrandly`

With Sudo - sudo pip3 install -r requirements.txt

User Install - pip3 install -r requirements.txt --user

Using

Using pyrebrandly is pretty easy, its just like any other library, although to start off, you have to set your account information for the library to use.

import pyrebrandly

client = pyrebrandly.Client(key='xxxxxxxx', id='xxxxxxxxx', )

About

I made pyrebrandly and its cousin rebrandlyrb out of wanting to make it easier to use the Rebrandly API.

Legal

pyrebrandly is/was developed by Ken Spencer. Ken Spencer does not have any affiliation nor endorsement from Rebrandly.

While this library was made with security, self-sufficiency, and self-configuration in mind, anyone that uses this library does so at their own risk.

Donations

pyrebrandly was brought to you through my own want, although if you do like it, and think it deserves it, I would very much appreciate a donation.

Donation Link:paypal.me/ElectroCode

Welcome to pyrebrandly’s documentation!

pyrebrandly is a python package used to access rebrandly.com’s API.

Indices and tables

• Index
• Module Index
• Search Page

Legal

For the legal and copyright disclaimer, see Legal