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

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

ritetag-1.1.0.tar.gz (20.9 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: ritetag-1.1.0.tar.gz
  • Upload date:
  • Size: 20.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.9.0

File hashes

Hashes for ritetag-1.1.0.tar.gz
Algorithm Hash digest
SHA256 d33b7ccc01069c2e4c251c19afa098fb9a6ba894a083a537e57d5437bf42277d
MD5 877489436e4208dba7556070657e94c6
BLAKE2b-256 66a4b47e4908dd101a2d732de92fd473a0f755ceed19dd41f191092ab853b5f9

See more details on using hashes here.

Supported by

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