Metadata-Version: 1.1
Name: viapy
Version: 0.2.0
Summary: Python module for interacting with VIAF data & APIs
Home-page: https://github.com/Princeton-CDH/viapy
Author: CDH @ Princeton
Author-email: digitalhumanities@princeton.edu
License: Apache License, Version 2.0
Description: viapy
        =====
        
        .. sphinx-start-marker-do-not-remove
        
        *VIAF via Python*
        
        Python module for interacting with `VIAF`_ (the Virtual International
        Authority File) data and APIs.
        
        .. _VIAF: http://viaf.org
        
        **viapy** provides optional Django integration; this currently includes a
        django-autocomplete-light lookup view and a VIAF url widget.
        
        .. image:: https://travis-ci.org/Princeton-CDH/viapy.svg
            :target: https://travis-ci.org/Princeton-CDH/viapy
            :alt: Build status
        
        .. image:: https://codecov.io/gh/Princeton-CDH/viapy/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/Princeton-CDH/viapy/branch/master
            :alt: Code coverage
        
        .. image:: https://requires.io/github/Princeton-CDH/viapy/requirements.svg
             :target: https://requires.io/github/Princeton-CDH/viapy/requirements/
             :alt: Requirements Status     
        
        .. image:: https://www.codefactor.io/repository/github/princeton-cdh/viapy/badge
           :target: https://www.codefactor.io/repository/github/princeton-cdh/viapy
           :alt: CodeFactor
        
        .. image:: https://img.shields.io/pypi/pyversions/viapy
           :alt: PyPI - Python Version
           
        .. image:: https://img.shields.io/pypi/djversions/viapy
           :alt: PyPI - Django Version
        
        
        Installation
        ------------
        
        Use pip to install from GitHub.  Use a branch or tag name, e.g.
        ``@develop`` or ``@1.0`` if you want to install a specific tagged release or branch::
        
            pip install git+https://github.com/Princeton-CDH/viapy.git@develop#egg=viapy
        
        
        Configuration for use with Django
        ---------------------------------
        
        Using `viapy` with Django requires additional configuration.  Add `viapy` to
        installed applications along with the needed django-autocomplete-light
        modules::
        
            INSTALLED_APPS = (
                ...
                'dal',
                'dal_select2',
                'viapy',
                ...
            )
        
        
        Include the viapy urls at the desired base url with the namespace::
        
            urlpatterns = [
                ...
                url(r'^viaf/', include('viapy.urls', namespace='viaf')),
                ...
            ]
        
        
        Development instructions
        ------------------------
        
        This git repository uses `git flow`_ branching conventions.
        
        .. _git flow: https://github.com/nvie/gitflow
        
        Initial setup and installation:
        
        - Recommended: create and activate a python 3.5 virtualenv::
        
            virtualenv viapy -p python3.5
            source viapy/bin/activate
        
        - pip install the package with its python dependencies::
        
            pip install -e .
            pip install -e ".[django]""
        
        
        Unit Testing
        ^^^^^^^^^^^^
        
        Unit tests are set up to be run with `py.test <http://doc.pytest.org/>`_
        
        - Copy sample test settings and add a **SECRET_KEY**::
        
            cp ci/testsettings.py testsettings.py
        
        - To run the tests, either use the configured setup.py test command::
        
            python setup.py test
        
        - Or install test requirements and use py.test directly::
        
            pip install -e '.[test_all]'
            py.test
        
        
        Documentation
        ^^^^^^^^^^^^^
        
        Documentation is generated using `sphinx <http://www.sphinx-doc.org/>`_.
        To generate documentation, first install development requirements::
        
            pip install -e ".[docs]"
        
        Then build the documentation using the customized make file in the `docs`
        directory::
        
            cd sphinx-docs
            make html
        
        When building documentation for a production release, use `make docs` to
        update the published documentation on GitHub Pages.
        
        
        
        License
        -------
        
        **viapy** is distributed under the Apache 2.0 License.
        
        ©2017 Trustees of Princeton University.  Permission granted via
        Princeton Docket #18-3449-1 for distribution online under a standard Open Source
        license.  Ownership rights transferred to Rebecca Koeser provided software
        is distributed online via open source.
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
