{ "info": { "author": "CDH @ Princeton", "author_email": "digitalhumanities@princeton.edu", "bugtrack_url": null, "classifiers": [ "Environment :: Web Environment", "Framework :: Django", "Framework :: Django :: 1.11", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Topic :: Internet :: WWW/HTTP", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "viapy\n=====\n\n.. sphinx-start-marker-do-not-remove\n\n*VIAF via Python*\n\nPython module for interacting with `VIAF`_ (the Virtual International\nAuthority File) data and APIs.\n\n.. _VIAF: http://viaf.org\n\n**viapy** provides optional Django integration; this currently includes a\ndjango-autocomplete-light lookup view and a VIAF url widget.\n\nPython 3.5 / Django 1.11\n\n.. image:: https://travis-ci.org/Princeton-CDH/viapy.svg?branch=master\n :target: https://travis-ci.org/Princeton-CDH/viapy\n :alt: Build status\n\n.. image:: https://codecov.io/gh/Princeton-CDH/viapy/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/Princeton-CDH/viapy/branch/master\n :alt: Code coverage\n\n.. image:: https://landscape.io/github/Princeton-CDH/viapy/master/landscape.svg?style=flat\n :target: https://landscape.io/github/Princeton-CDH/viapy/master\n :alt: Code Health\n\n.. image:: https://requires.io/github/Princeton-CDH/viapy/requirements.svg?branch=master\n :target: https://requires.io/github/Princeton-CDH/viapy/requirements/?branch=master\n :alt: Requirements Status\n\n\n\nInstallation\n------------\n\nUse pip to install from GitHub. Use a branch or tag name, e.g.\n``@develop`` or ``@1.0`` if you want to install a specific tagged release or branch::\n\n pip install git+https://github.com/Princeton-CDH/viapy.git@develop#egg=viapy\n\n\nConfiguration for use with Django\n---------------------------------\n\nUsing `viapy` with Django requires additional configuration. Add `viapy` to\ninstalled applications along with the needed django-autocomplete-light\nmodules::\n\n INSTALLED_APPS = (\n ...\n 'dal',\n 'dal_select2',\n 'viapy',\n ...\n )\n\n\nInclude the viapy urls at the desired base url with the namespace::\n\n urlpatterns = [\n ...\n url(r'^viaf/', include('viapy.urls', namespace='viaf')),\n ...\n ]\n\n\nDevelopment instructions\n------------------------\n\nThis git repository uses `git flow`_ branching conventions.\n\n.. _git flow: https://github.com/nvie/gitflow\n\nInitial setup and installation:\n\n- Recommended: create and activate a python 3.5 virtualenv::\n\n virtualenv viapy -p python3.5\n source viapy/bin/activate\n\n- pip install the package with its python dependencies::\n\n pip install -e .\n pip install -e \".[django]\"\"\n\n\nUnit Testing\n^^^^^^^^^^^^\n\nUnit tests are set up to be run with `py.test `_\n\n- Copy sample test settings and add a **SECRET_KEY**::\n\n cp ci/testsettings.py testsettings.py\n\n- To run the tests, either use the configured setup.py test command::\n\n python setup.py test\n\n- Or install test requirements and use py.test directly::\n\n pip install -e '.[test_all]'\n py.test\n\n\nDocumentation\n^^^^^^^^^^^^^\n\nDocumentation is generated using `sphinx `_.\nTo generate documentation, first install development requirements::\n\n pip install -e \".[docs]\"\n\nThen build the documentation using the customized make file in the `docs`\ndirectory::\n\n cd sphinx-docs\n make html\n\nWhen building documentation for a production release, use `make docs` to\nupdate the published documentation on GitHub Pages.\n\n\n\nLicense\n-------\n\n**viapy** is distributed under the Apache 2.0 License.\n\n\u00a92017 Trustees of Princeton University. Permission granted via\nPrinceton Docket #18-3449-1 for distribution online under a standard Open Source\nlicense. Ownership rights transferred to Rebecca Koeser provided software\nis distributed online via open source.\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Princeton-CDH/viapy", "keywords": "", "license": "Apache License, Version 2.0", "maintainer": "", "maintainer_email": "", "name": "viapy", "package_url": "https://pypi.org/project/viapy/", "platform": "", "project_url": "https://pypi.org/project/viapy/", "project_urls": { "Homepage": "https://github.com/Princeton-CDH/viapy" }, "release_url": "https://pypi.org/project/viapy/0.1.1/", "requires_dist": null, "requires_python": "", "summary": "Python module for interacting with VIAF data & APIs", "version": "0.1.1" }, "last_serial": 5820272, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "0b9444d108f5ac2cd07e2e42d0f59f89", "sha256": "d9258e502a0c29332c80ee4cbbd1b176777ae9fa3cf9ae2ad14c3111acc14516" }, "downloads": -1, "filename": "viapy-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "0b9444d108f5ac2cd07e2e42d0f59f89", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 10016, "upload_time": "2018-03-08T22:49:36", "url": "https://files.pythonhosted.org/packages/9a/64/d2423a046093bd5fb5a43c67b5842f7e4d40fd607f9a8a1f23020ca5a3fd/viapy-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0476be254bfa0aa8445819a69138446b", "sha256": "23bc099edce62597fd44b8823de4f1ed605691d2af723bb74faa9a2fe1cff46f" }, "downloads": -1, "filename": "viapy-0.1.1.tar.gz", "has_sig": false, "md5_digest": "0476be254bfa0aa8445819a69138446b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6787, "upload_time": "2018-03-08T22:49:34", "url": "https://files.pythonhosted.org/packages/a4/56/8831c293c98f8646fa57388620614a328d7d1bc0644e493cb792f6d8432a/viapy-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "0b9444d108f5ac2cd07e2e42d0f59f89", "sha256": "d9258e502a0c29332c80ee4cbbd1b176777ae9fa3cf9ae2ad14c3111acc14516" }, "downloads": -1, "filename": "viapy-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "0b9444d108f5ac2cd07e2e42d0f59f89", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 10016, "upload_time": "2018-03-08T22:49:36", "url": "https://files.pythonhosted.org/packages/9a/64/d2423a046093bd5fb5a43c67b5842f7e4d40fd607f9a8a1f23020ca5a3fd/viapy-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0476be254bfa0aa8445819a69138446b", "sha256": "23bc099edce62597fd44b8823de4f1ed605691d2af723bb74faa9a2fe1cff46f" }, "downloads": -1, "filename": "viapy-0.1.1.tar.gz", "has_sig": false, "md5_digest": "0476be254bfa0aa8445819a69138446b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6787, "upload_time": "2018-03-08T22:49:34", "url": "https://files.pythonhosted.org/packages/a4/56/8831c293c98f8646fa57388620614a328d7d1bc0644e493cb792f6d8432a/viapy-0.1.1.tar.gz" } ] }