Skip to main content

BCH compliance Codacy Code Health

This package interacts with The Powder Toy’s API.

Usage:

import tptapi

client = tptapi.Client()

Login

Most actions need a session token you can obtain from Login: client.login(user, password) returns a boolean.

Check Login

To verify that your session is still valid you can run checkLogin: client.check_login() which will return a boolean.

Vote [LOGIN NEEDED]

To cast a vote, you need to do client.vote(id, type) where type is a negative or positive number that defines if it’s a upvote or downvote. Returns a boolean.

Comment [LOGIN NEEDED]

To add a comment, you need to do client.comment(id, text). Returns a boolean.

Add Tag [LOGIN NEEDED]

To add a tag, you need to do client.add_tag(id, name). Returns a boolean.

Delete Tag [LOGIN NEEDED]

To remove a tag, you need to do client.delete_tag(id, name). Returns a boolean.

Delete Save [LOGIN NEEDED]

To remove a save, you need to do client.delete_save(id). Returns a boolean.

Unpublish Save [LOGIN NEEDED]

To unpublish a save, you need to do client.unpublish_tag(id). Returns a boolean.

Publish Save [LOGIN NEEDED]

To publish a save, you need to do client.publish_save(id). Returns a boolean.

Update Profile [LOGIN NEEDED]

To update your profile, you need to do client.set_profile(data). Returns a boolean.

Browse [LOGIN ENHACES OUTPUT]

To browse, you need to do client.browse(query, count, offset). Returns results.

List Tags

To list tags, you need to do client.list_tags(start, count). Returns array of tags.

Favourite a Save [LOGIN NEEDED]

To add a save to favutrites, you need to do client.add_fav(id). Returns a boolean.

UnFavourite a Save [LOGIN NEEDED]

To remove a save from favutrites, you need to do client.remove_fav(id). Returns a boolean.

Save [LOGIN NEEDED]

Saves a CPS file. Data has to be OPS1-encoded save.

data = open("save.cps", "br").read()
client.save(name, description, data)

Returns the save id.

Update Save [LOGIN NEEDED]

Updates a save with new description and content. Data has to be OPS1-encoded save.

data = open("save.cps", "br").read()
client.updateSave(id, description, data)

Returns a boolean.

Startup Data [LOGIN ENHACES OUTPUT]

Returns Startup.json data. client.startup()

Save’s Comments

Returns a save’s comments. client.comments(id, count, offset)

Download files

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

Source Distribution

tptapi-1.1.0.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tptapi-1.1.0-py2.py3-none-any.whl (7.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file tptapi-1.1.0.tar.gz.

File metadata

  • Download URL: tptapi-1.1.0.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for tptapi-1.1.0.tar.gz
Algorithm Hash digest
SHA256 19c3753de75b104fb658fb68d6c225e075ae05ed02e6f800b48a62298e5f0cd6
MD5 da0c5817bb3e0dd093801575398f2f9f
BLAKE2b-256 789d831a48a6c5ea45302c13147fc76868b38bcfb327ca1d62e5497fbaa1b56d

See more details on using hashes here.

File details

Details for the file tptapi-1.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for tptapi-1.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 81731cd55030d83ba5555dbe4f56abe8204da7e7847ad895c063e8a8ffcee83a
MD5 fef4c3ea86c3c28d1d90dd5bded5039f
BLAKE2b-256 441e09c62bc30c6c7c10cbda46bb0d3c2712ddbac594f569a9d9564d62f409fa

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 files

1.0.0

2 files

0.1.1

1 file

0.1.0

3 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page