Skip to main content

Making requests to rest apis in pythonista.

Project description

Pythonista API Client

Installation

There's a package on PyPI just type:

pip install pythonista_api_client

Desktop

To test your installation you can try one of the examples:

python examples/konektom.py

iOS

Before you are able to install the package from PyPI, you have to install StaSh a shell for pythonista.

Api

To create an api client just inherit from BaseClient which will handle authentication and settings for you. Requests should be done by importing requests from api client which will then behave like the usual requests module.

Depending on which platform your script will be run one of following methods will be called:

  • python_main (normal python)
  • pythonista_main (started with pythonista play button)
  • appex_main (invoked via share sheet)

Token Authentication

If you wnat to use token authentication you need to set obtain_token_endpoint.

JWT Authentication

For JWT Authentication obtain_jwt_endpoint and refresh_jwt_endpoint have to be set.

Example with token authentictaion

Here's a minimal example which should work with token and jwt authentication:

from urllib.parse import urljoin

from api_client import requests
from api_client import BaseClient


class Bookmark(BaseClient):
    obtain_jwt_endpoint = 'api/auth/token/obtain/'
    refresh_jwt_endpoint = 'api/auth/token/refresh/'
    obtain_token_endpoint = '/api/api-token-auth/'

    bookmarks_endpoint = 'api/v1/bookmarks/'

    def list_bookmarks(self):
        list_url = urljoin(self.base_url, self.bookmarks_endpoint)
        return requests.get(list_url, auth=self.auth).json()

    def python_main(self):
        print('running in normal python')
        print(self.list_bookmarks())

    def pythonista_main(self):
        print('Running in Pythonista app, using test data...\n')
        print(self.list_bookmarks())

    def appex_main(self):
        print('running in share sheet')
        print(self.list_bookmarks())


def main():
    Bookmark(auth_method='token').main()

if __name__ == '__main__':
    main()

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

pythonista_api_client-0.1.4.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

pythonista_api_client-0.1.4-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

Details for the file pythonista_api_client-0.1.4.tar.gz.

File metadata

File hashes

Hashes for pythonista_api_client-0.1.4.tar.gz
Algorithm Hash digest
SHA256 9fe100d39b823b335ada77e6cc1c2d7b1b4d233c6e418f42b1f6bffeee59ed5b
MD5 6dc4cddbee03a54636fce5ec38ffff46
BLAKE2b-256 f3c286df9ec100764685fb5c2c4e0dfdd273ba1d7987148d04f429f7b24552cf

See more details on using hashes here.

File details

Details for the file pythonista_api_client-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for pythonista_api_client-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4f4bd34fe2b446165b30c456081e5940de17eabe6a5e5b855336ca7f0b793c2d
MD5 f81cbd5c013fb08389260c944bef54ad
BLAKE2b-256 0fb193e262257cb6c597a658c1c97e55665ac65d2050db1214d22830200df6d6

See more details on using hashes here.

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