Skip to main content

Official Python client for the Currents API

Project description

currentsapi-python

A Python client for the Currents API

Provided under MIT License by Zhi Rui Tam.

Note: this library may be subtly broken or buggy. The code is released under the MIT License – please take the following message to heart:

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

General

This is a Python client library for CurrentsAPI version 1. The functions for the library should mirror the endpoints from the documentation.

Installation

Installation for the package can be done via pip.

    pip install currentsapi-python

Usage

After installation, import client into your project:

from currentsapi import CurrentsAPI

Initialize the client with your API key:

api = CurrentsAPI(api_key='XXXXXXXXXXXXXXXXXXXXXXX')

Endpoints

Latest News

api.latest_news()

Query

api.search(keywords='Trump')

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

currentsapi-0.0.2.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

currentsapi-0.0.2-py2.py3-none-any.whl (9.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file currentsapi-0.0.2.tar.gz.

File metadata

  • Download URL: currentsapi-0.0.2.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.6

File hashes

Hashes for currentsapi-0.0.2.tar.gz
Algorithm Hash digest
SHA256 f8393052e59ac820656e2f3860854fd9940540bcba28781abaad5d2fd9c48891
MD5 4d659be0e860929f7f9879746f6d5fdc
BLAKE2b-256 36def4124b979e9166602cf9d1a3002ee40ef70e2da0f8322881805364c1fbb7

See more details on using hashes here.

File details

Details for the file currentsapi-0.0.2-py2.py3-none-any.whl.

File metadata

  • Download URL: currentsapi-0.0.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.6

File hashes

Hashes for currentsapi-0.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 fba27f32d1ce823fef226659da9dac2177bf3a54b7137eb183e3bd0dc77198d0
MD5 52049f91bb8ea09b251faf8052704a81
BLAKE2b-256 9382e2ed99d9ed374357111dddb73f58c60962512b365a895f210d19f5994045

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