Skip to main content

RiteTag API client.

Project description

RiteTag API client

Python API client

Documentation

API Documentation

Installation

pip install --user ritetag

Usage

In The Code

from ritetag import RiteTagApi

access_token = 'token'
client = RiteTagApi(access_token)

def limit_80_percentage_reached(limit):
    message = 'Used {}% of API credits. The limit resets on {}'.format(limit.usage, limit.reset)
    print(message)

# The callback function is triggered when 80% of the API limit is reached
client.on_limit(80, limit_80_percentage_reached)

stats = client.hashtag_stats(['jobs', 'hello'])

for data in stats:
    print('#{}: {} tweets per hour'.format(data.hashtag, data.tweets))

output:

#jobs: 642 tweets per hour
#hello: 25 tweets per hour

In The Console

ritetag-api -h
usage: ritetag-api [-h] [-t ACCESS_TOKEN] [-m MAX_HASHTAGS] [-p {auto,end}]
                   [-f FILENAME] [-ci CTA_ID]
                   {hashtag_stats,auto_hashtags,hashtag_suggestions,hashtag_history,emojis_suggestion,auto_emojify,company_logo,list_of_cta,shorten_link}
                   [hashtags [hashtags ...]]

RiteTag API console client.

positional arguments:
  {hashtag_stats,auto_hashtags,hashtag_suggestions,hashtag_history,emojis_suggestion,auto_emojify,company_logo,list_of_cta,shorten_link}
                        action
  hashtags              hashtags

optional arguments:
  -h, --help            show this help message and exit
  -t ACCESS_TOKEN, --access_token ACCESS_TOKEN
                        access token
  -m MAX_HASHTAGS, --max_hashtags MAX_HASHTAGS
  -p {auto,end}, --hashtag_position {auto,end}
  -f FILENAME, --filename FILENAME
  -ci CTA_ID, --cta_id CTA_ID
export ACCESS_TOKEN={access_token}
ritetag-api hashtag_stats jobs hello

or

ritetag-api -t {access_token} hashtag_stats jobs hello

output:

Used 19.89% of API credits. The limit resets on 2020-04-01.
==== Stats of #jobs ====
tweets: 642
retweets: 62
exposure: 1984429
mentions: 9.03427%
links: 35.04673%
images: 35.04673%
color: HOT_NOW
media count: 3490073

==== Stats of #hello ====
tweets: 25
retweets: 4
exposure: 32567
mentions: 32.0%
links: 32.0%
images: 32.0%
color: HOT_NOW
media count: 18896544

Company logo API (console)

Example 1 - google.com
# Company logo example
ritetag-api -t {token} company_logo google.com
Looking for logo - google.com
Used 0.14% of API credits. The limit resets on 2021-06-01.
Downloading logo - google.com
Image is saved google_com.svg - google.com
Downloading square logo - google.com
Image is saved google.com - google_com_square.png

Example 2 - notfound.test with Generate fallback
# Company logo example
ritetag-api -t {token} company_logo -g 1 company_logo notfound.test
Looking for logo - notfound.test
Used 0.14% of API credits. The limit resets on 2021-06-01.
Logo is generated.
Downloading logo - notfound.test
Image is saved notfound_test.png - notfound.test
Downloading square logo - notfound.test
Image is saved notfound.test - notfound_test_square.png

Example 3 - notfound.test without Generate fallback
# Company logo example
ritetag-api -t {token} company_logo -g 0 company_logo notfound.test
Looking for logo - notfound.test
Used 0.14% of API credits. The limit resets on 2021-06-01.
Downloading logo - notfound.test
Error Logo not found - notfound.test
Downloading square logo - notfound.test
Error Logo not found - notfound.test

Project details


Download files

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

Files for ritetag, version 1.3.2
Filename, size File type Python version Upload date Hashes
Filename, size ritetag-1.3.2.tar.gz (23.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page