Mediacloud news archive search api client
Project description
Mediacloud News Archive Client
🚧 under construction 🚧
A simple client library to access the Wayback Machine news archive search.
Installation
NB: TBD
pip install mediacloud-news-client
Basic Usage
Counting matching stories:
from mcnews.searchapi import SearchApiClient
import datetime as dt
api = SearchApiClient("mediacloud")
api.count("coronavirus", dt.datetime(2022, 3, 1), dt.datetime(2022, 4, 1))
Paging over all matching results:
from mcnews.searchapi import SearchApiClient
import datetime as dt
api = SearchApiClient("mediacloud")
for page in api.all_articles("coronavirus", dt.datetime(2022, 3, 1), dt.datetime(2022, 4, 1)):
do_something(page)
Dev Installation
Install the dependencies for dev: pip install -e .[dev]
Distribution
- Run
pytest
to make sure all the test pass - Update the version number in
mcnews/__init__.py
- Make a brief note in the version history section below about the changes
- Commit the changes
- Tag the commit with a semantic version number - 'v*..'
- Push to repo to GitHub
- Run
python setup.py sdist
to create an installation package - Run
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
to upload it to PyPI's test platform - Run
twine upload dist/*
to upload it to PyPI
Version History
- v2.0.0 - Fresh start as mediacloud-news-client
- v1.2.1 - fix paging bug triggered by no results
- v1.2.0 - add support for new
expanded
results, and more integration testing - v1.1.0 - add new
paged_articles
method to allow paging over all results - v1.0.3 - add 30 sec timeout, remove extra params mcproviders library might be adding
- v1.0.2 - fix to article endpoint
- v1.0.1 - automatically escape '/' in query strings, test case for
url
field search - v1.0.0 - update to public API endpoint
- v0.1.5 - simpler return for top terms
- v0.1.4 - better error handling
- v0.1.3 - allow overriding base api URL
- v0.1.2 - fix
article
endpoint, test case for fetching content (snippet
) viaarticle_url
property - v0.1.1 - more consistent method names
- v0.1.0 - initial test-only release
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for mediacloud-news-client-2.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b33e610c2e834a4b2181f64d6fd0a9952e8ac35d77ad02edd3ba3c02f7cbfcf |
|
MD5 | 18e132e218ee1214b326a5d2fcd15939 |
|
BLAKE2b-256 | be783b2e4062bccf3f4f76417091b2e1f85a5cd58156562cc51c5e0c52257543 |
Close
Hashes for mediacloud_news_client-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d6aebac00f96a973c22cadcaf9941a453b0288540744f7bde2e5219f7e31fa5b |
|
MD5 | 2a923ec06444fbbf9eea47d25941290f |
|
BLAKE2b-256 | e98af153f118b4fb88fdc51cc0e92637e8bf83f7d3f09dbbaf5fdf4c29aab31d |