Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

An asynchronous Twitter API client for Python 3.5+

Project description

https://travis-ci.org/odrling/peony-twitter.svg?branch=master https://codecov.io/gh/odrling/peony-twitter/branch/master/graph/badge.svg Documentation Status

Installation

To install this module simply run:

pip install peony-twitter[all]

This will install all the modules required to make peony run out of the box. You might feel like some of them are not fit for your needs. Check Advanced installation for more information about how to install only the modules you will need.

Authorize your client

You can use peony.oauth_dance to authorize your client:

>>> from peony.oauth_dance import oauth_dance
>>> tokens = oauth_dance(YOUR_CONSUMER_KEY, YOUR_CONSUMER_SECRET)
>>> from peony import PeonyClient
>>> client = PeonyClient(**tokens)

This should open a browser to get a pin to authorize your application.

Getting started

You can easily create a client using the class PeonyClient. Make sure to get your api keys and access tokens from Twitter’s application management page and/or to Authorize your client

import asyncio

# NOTE: the package name is peony and not peony-twitter
from peony import PeonyClient

loop = asyncio.get_event_loop()

# create the client using your api keys
client = PeonyClient(consumer_key=YOUR_CONSUMER_KEY,
                     consumer_secret=YOUR_CONSUMER_SECRET,
                     access_token=YOUR_ACCESS_TOKEN,
                     access_token_secret=YOUR_ACCESS_TOKEN_SECRET)

# this is a coroutine
req = client.api.statuses.update.post(status="I'm using Peony!!")

# run the coroutine
loop.run_until_complete(req)

Documentation

Read Peony’s documentation.

Contributing

Every kind of contribution is appreciated.

If you find a bug please start an issue and if you’re very motivated you can create a pull request.

If you have a suggestion you can also start an issue and create a pull request if you managed to make it work.

Tests

To run the tests run:

make test

The first time this command is run it will install all the dependencies which can take a bit of time.

The tests include a code style test. The code style is mostly PEP8, the only exception so far being long urls included in docstrings and some imports that are not at the top of the file (because they can’t be there).

To resolve the most trivial errors you can run:

make format

Note that running make is equivalent to running make format && make test

You can also use tox to run the tests, a configuration file is provided:

tox

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
peony_twitter-1.1.1-py3-none-any.whl (34.6 kB) Copy SHA256 hash SHA256 Wheel py3 Sep 15, 2018
peony-twitter-1.1.1.tar.gz (28.8 kB) Copy SHA256 hash SHA256 Source None Sep 15, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page