Media Cloud API Client Library

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for pgulley from gravatar.com pgulley Avatar for rahulbot from gravatar.com rahulbot

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License
  • Author: Rahul Bhargava
  • Requires: Python >=3.10
  • Provides-Extra: dev , test
Classifiers
Report project as malware

Project description

MediaCloud Python API Client

This is a python client for accessing the MediaCloud API v4. This allows you to perform cross-platform searches and also browse our collection/source/feed directory.

pylint pytest GitHub license

Usage

First sign up for an API key. Then

pip install mediacloud

Check CHANGELOG.md for a detailed history of changes.

Examples

Take a look at the test in the mediacloud/test/ module for more detailed examples.

Count Stories Matching a Query

import mediacloud.api
US_NATIONAL_COLLECTION = 34412234
mc_search = mediacloud.api.SearchApi(YOUR_MC_API_KEY)
all_stories = []
pagination_token = None
more_stories = True
while more_stories:
    page, pagination_token = mc_search.story_list('robots', start_date= , end_date= collection_ids=[US_NATIONAL_COLLECTION])
    all_stories += page
    more_stories = pagination_token is not None
print(f"Retrived {len(all_stories)} matching stories")

Page Through Stories Matching a Query

import mediacloud.api
INDIA_NATIONAL_COLLECTION = 34412118
mc_search = mediacloud.api.SearchApi(YOUR_MC_API_KEY)
all_stories = []
pagination_token = None
more_stories = True
while more_stories:
    page, pagination_token = mc_search.story_list('modi AND biden', collection_ids=[INDIA_NATIONAL_COLLECTION],
                                                  pagination_token=pagination_token)
    all_stories += page
    more_stories = pagination_token is not None
print(f"Retrived {len(all_stories)} matching stories")

Fetch all Sources in a Collection

import mediacloud.api
INDIA_NATIONAL_COLLECTION = 34412118
SOURCES_PER_PAGE = 100  # the number of sources retrieved per page
mc_directory = mediacloud.api.DirectoryApi(YOUR_MC_API_KEY)
sources = []
offset = 0   # offset for paging through
while True:
    # grab a page of sources in the collection
    response = mc_directory.source_list(collection_id=INDIA_NATIONAL_COLLECTION, limit=SOURCES_PER_PAGE, offset=offset)
    # add it to our running list of all the sources in the collection
    sources += response['results']
    # if there is no next page then we're done so bail out
    if response['next'] is None:
        break
    # otherwise setup to fetch the next page of sources
    offset += len(response['results'])
print("India National Collection has {} sources".format(len(sources)))

Development

If you are interested in adding code to this module, first clone the GitHub repository.

Installing

  • flit install
  • pre-commit install

Testing

pytest

Distributing a New Version

  1. Run pytest to make sure all the test pass
  2. Update the version number in pyproject.toml
  3. Make a brief note in the CHANGELOG.md about what changes
  4. Commit changes, and tag commit with version number
  5. Push to main

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for pgulley from gravatar.com pgulley Avatar for rahulbot from gravatar.com rahulbot

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License
  • Author: Rahul Bhargava
  • Requires: Python >=3.10
  • Provides-Extra: dev , test
Classifiers

Release history Release notifications | RSS feed

This version

4.4.0

4.3.0

4.2.0

4.1.4

4.1.3

4.1.2

4.1.1

4.1.0

4.0.1

4.0.0

3.13.0

3.12.5

3.12.4

3.12.3

3.12.2

3.12.1

3.12.0

3.11.3

3.11.2

3.11.1

3.11.0

3.10.0

3.9.3

3.9.2

3.9.1

3.9.0

3.8.0

3.7.6

3.7.5

3.7.4

3.7.3

3.7.2

3.7.1

3.7.0

3.6.5

3.6.4

3.6.3

3.6.2

3.6.1

3.6.0

3.5.1

3.5.0

3.4.4

3.4.3

3.4.2

3.4.1

3.4.0

3.3.1

3.3.0

3.2.3

3.2.2

3.2.1

3.2.0

3.1.1

3.1.0

3.0.4

3.0.3

3.0.2

3.0.1

3.0.0

3.0.0-b2 pre-release

3.0.0-b1 pre-release

2.53.0

2.52.0

2.51.0

2.50.0

2.49.0

2.48.0

2.47.0

2.46.0

2.45.0

2.44.0

2.43.3

2.43.2

2.43.1

2.43.0

2.42.0

2.41.0

2.40.1

2.40.0

2.39.2

2.39.1

2.39.0

2.38.2

2.38.1

2.38.0

2.37.0

2.36.2

2.36.1

2.36.0

2.35.6

2.35.5

2.35.3

2.35.2

2.35.1

2.35.0

2.34.0

2.33.1

2.33.0

2.32.0

2.31.0

2.30.0

2.29.1

2.29.0

2.28.0

2.27.0

2.26.1

2.26.0

2.25.0

2.24.1

2.24.0

2.23.0

2.22.2

Download files

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

Source Distribution

mediacloud-4.4.0.tar.gz (22.1 kB view details)

Uploaded Source

Built Distribution

mediacloud-4.4.0-py3-none-any.whl (24.8 kB view details)

Uploaded Python 3

File details

Details for the file mediacloud-4.4.0.tar.gz.

File metadata

  • Download URL: mediacloud-4.4.0.tar.gz
  • Upload date:
  • Size: 22.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mediacloud-4.4.0.tar.gz
Algorithm Hash digest
SHA256 b7530525cf93faaf9e6dcafc9313f2c45b858c205805371031a50b2f85c530c9
MD5 7c49fcd99c699e71e69f00aba3a99f83
BLAKE2b-256 1d65d0b97ca61a9cc182dcfa3e35977d3c56b5b1331e1f36828dbcbdce2be36c

See more details on using hashes here.

Provenance

The following attestation bundles were made for mediacloud-4.4.0.tar.gz:

Publisher: publish-to-pypi.yml on mediacloud/api-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mediacloud-4.4.0-py3-none-any.whl.

File metadata

  • Download URL: mediacloud-4.4.0-py3-none-any.whl
  • Upload date:
  • Size: 24.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mediacloud-4.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e731314a4942ef7b3d5b58b07194497e46cc0d3a27aab69dccc9d8f373aee50c
MD5 222cc92490bb1b7b6d4355d9f0560838
BLAKE2b-256 9b0485776b80a52a6be3c7968319e320bc6af83b70105ae4ba37a2570d041c05

See more details on using hashes here.

Provenance

The following attestation bundles were made for mediacloud-4.4.0-py3-none-any.whl:

Publisher: publish-to-pypi.yml on mediacloud/api-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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