Metadata-Version: 2.1
Name: digitalarchive
Version: 0.1.11
Summary: A python client for the Wilson Center Digital Archive API.
Home-page: https://github.com/epikulski/digitalarchive
Author: Evan Pikulski
Author-email: epikulsk@gmail.com
License: MIT
Description: 
        Digital Archive
        ===============
        ![PyPI](https://img.shields.io/pypi/v/digitalarchive)
        [![Build Status](https://travis-ci.com/epikulski/digitalarchive.svg?token=DF1254Zmz3xWHziFRx2x&branch=master)](https://travis-ci.com/epikulski/digitalarchive)
        [![codecov](https://codecov.io/gh/epikulski/digitalarchive/branch/master/graph/badge.svg?token=UOd5l8vX6b)](https://codecov.io/gh/epikulski/digitalarchive)
        ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/digitalarchive)
        [![Documentation Status](https://readthedocs.org/projects/digitalarchive/badge/?version=latest)](https://digitalarchive.readthedocs.io/en/latest/?badge=latest)
        
        
        A Python client for the Wilson Center's [Digital Archive](https://digitalarchive.wilsoncenter.org) ("DA") of historical primary sources. This library provides an ORM for searching and accessing documents and other resources in the Digital Archive. 
        
        Installation
        ------------
        The client is available on pypi. It requires python 3.7+.
        ```
        pip install digitalarchive
        ```
        
        Usage
        -----
        ```
        >>> import digitalarchive
        
        # Search for documents:
        >>> soviet_docs = digitalarchive.Document.match(title="soviet").all()
        
        # Collections and other resource types are also searchable.
        >> soviet_collections = digitalarchive.Collection.match(name="soviet")
        
        # Grab a single, specific document:
        >>> document = digitalarchive.Document.match(id="112566").first()
        
        # Pull transcripts, translations, and original scans of documents:
        >>> document.hydrate()
        >>> document = test_doc.transcripts[0].html
        
        # Pull the metadata and other assets for an entire resultset.
        >>> chernobyl_docs = digitalarchive.Document.match(title="chernobyl")
        >>> chernobyl_docs.hydrate()
        >>> chernobyl_docs.all()
        
        # Or just download all the documents!
        >>> all_documents = digitalarchive.Document.match().all()
        ```
        
        Complete documentation for the client and the Digital Archive's models are available [here](https://digitalarchive.readthedocs.io/en/latest/).
        
        Disclaimers
        -----------
        * This is an unofficial library. I am not presently affiliated with the Wilson Center. I understandthat the API is unlikely to change in the near future, but I cannot guarantee that this library won't break without warning. 
        * If you plan to scrape the DA, please be respectful. 
        
        Planned Features
        ----------------
        * Support for searching by date range.
        * Asynchronous hydration of large result sets.
        * For Collections, inlcude keyword hits in `short_description` for searches. (modify collection searches to use the  `record.json` instead of `collection.json` endpoint.
        
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.7.0
Description-Content-Type: text/markdown
