Skip to main content

ImperialBin is a hastebin alternative built with UI and user experience in mind.

Project description

Imperial-py README

ImperialBin is a Hastebin alternative built with UI and user experience in mind.

Connect With Us!

Endpoints

Function Endpoint Request Type
create_document() /api/document POST
get_document() /api/document GET
edit_document() /api/document PATCH
verify() /api/CheckApiToken GET

Example Usage

An API Token is not required, but you can't edit without one, and this is generally made with authorization in mind.

Add IMPERIAL-TOKEN to path to set it automatically; this will get overwritten by setting one manually.

from imperial_py import Imperial

imp = Imperial()

imp.create_document("Hello World!")
# {'success': True, 'document_id': 'bmhn60klmpw', 'raw_link': 'https://www.imperialb.in/r/bmhn60klmpw', 'formatted_link': 'https://www.imperialb.in/p/bmhn60klmpw', 'expires_in': datetime.datetime(2021, 1, 29, 18, 55, 37, 725000), 'instant_delete': False}

imp.get_document("bmhn60klmpw")
# {'success': True, 'document': 'Hello World!'}

imp.edit_document("Hello From Python!", "bmhn60klmpw")
# {'success': True, 'message': 'Successfully edited the document!', 'document_id': 'phqmaxastug', 'raw_link': 'https://www.imperialb.in/r/phqmaxastug', 'formatted_link': 'https://www.imperialb.in/p/phqmaxastug', 'expires_in': datetime.datetime(2021, 2, 13, 19, 30, 54, 839000), 'instant_delete': False}

imp.get_document("bmhn60klmpw")
# {'success': True, 'document': 'Hello From Python!'}

Shorthand Functions

import imperial_py
imperial_py.create_document("Hello World!")  # same as Imperial().create_document()
imperial_py.get_document("bmhn60klmpw")  # same as Imperial().get_document()
# etc...

Python Exclusives

  • camelCase json response is converted to snake_case
  • The expires_in dict key gets converted from an isoformat string to a datetime object

Docs

To get full docs, refer to imperial documentation. To view what goes on with imperial-py, view the full code. Every function has docstrings and a description.

Contributing

Either send contributions in the discord or open a pull request. If you suggest a change, make sure it's backwards compatible. As of now, imperial-py is python 3.5 and up.

Project details


Download files

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

Source Distribution

imperial-py-1.0.5.tar.gz (5.2 kB view hashes)

Uploaded Source

Built Distributions

imperial_py-1.0.5-py3.9.egg (9.5 kB view hashes)

Uploaded Source

imperial_py-1.0.5-py3-none-any.whl (11.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page