Metadata-Version: 1.0
Name: PennSDK
Version: 0.1.4.1
Summary: Python tools for building Penn-related applications
Home-page: https://github.com/pennappslabs/penn-sdk-python
Author: PennApps Labs
Author-email: pennappslabs@gmail.com
License: MIT
Description: =======================================
        PennSDK: Wrapper for Mulitple Penn APIs
        =======================================
        
        .. image:: https://badge.fury.io/py/PennSDK.png
            :target: http://badge.fury.io/py/PennSDK
        
        .. image:: https://pypip.in/d/PennSDK/badge.png
                :target: https://crate.io/packages/PennSDK/
        
        Penn SDK is the Python library for writing code that interfaces with University of Pennsylvania
        data. It consists of wrappers for the Registrar, Dining, and
        Directory API's
        
        
        Getting an API key
        ------------------
        
        To use these libraries, you must first obtain an API token and password,
        which can be done here_. There are separate API tokens for each.
        
        
        Documentation
        -------------
        
        The full API documentation can be found at
        https://esb.isc-seo.upenn.edu/8091/documentation/.
        
        Documentation for the wrapper can be found at http://penn-sdk.readthedocs.org/
        
        Running Tests
        -------------
        
        Once you have an API token and password, you can run the tests by creating a
        ``tests/credentials.py`` file with them as constants. Include:
        
        .. code-block:: python
        
            REG_USERNAME = 'MY_REGISTAR_USERNAME'
            REG_PASSWORD = 'MY_REGISTAR_PASSWORD'
        
        to run ``python tests/registrar_test.py``.
        
        For dining, include:
        
        .. code-block:: python
        
            DIN_USERNAME = 'MY_DINING_USERNAME'
            DIN_PASSWORD = 'MY_DINING_PASSWORD'
        
        and run ``python tests/dining_test.py``.
        
        For the directory API, include:
        
        .. code-block:: python
        
            DIR_USERNAME = 'MY_DIRECTORY_USERNAME'
            DIR_PASSWORD = 'MY_DIRECTORY_PASSWORD'
        
        and run ``python tests/directory_test.py``.
        
        You can also type ``make test`` to run all tests.
        
        Contributing & Bug Reporting
        ----------------------------
        
        If you find a bug, please submit it through the `GitHub issues page`_.
        
        Pull requests are welcome!
        
        .. _`GitHub issues page`: https://github.com/pennappslabs/penn-sdk-python/issues
        .. _`here`: https://secure.www.upenn.edu/computing/da/webloginportal/eforms/index.html?content=kew/EDocLite?edlName=openDataRequestForm&userAction=initiate
        
Platform: UNKNOWN
