Metadata-Version: 2.1
Name: libiap
Version: 0.1.0
Summary: Python SDK/Library for IAP
Home-page: https://github.com/umccr/libiap
Author: UMCCR and Contributors
Author-email: services@umccr.org
License: MIT
Description: .. image:: https://github.com/umccr/libiap/workflows/Pull%20Request%20Build/badge.svg
            :target: https://github.com/umccr/libiap/actions
            :alt: PR Build Status Badge
        
        libiap
        ======
        
        Python SDK/Library for IAP -- https://umccr.github.io/libiap/
        
        * `Coverage <coverage>`_
        * `PyDoc <libiap>`_
        
        TL;DR
        -----
        
        - Install through ``pip`` like so::
        
            pip install libiap
        
        - Export IAP base URL and auth token::
        
            export IAP_BASE_URL=<baseUrl>
            export IAP_AUTH_TOKEN=<tok>
        
        - Somewhere in your Python code::
        
            from libiap import libgds
        
            for file in libgds.list_files(volume_name='my-gds-volume-name'):
                print(file)
        
        - More examples/tutorials available at `User Guide <user>`_
        
        Development
        -----------
        
        - Setup Python virtual environment e.g. ``python -m venv venv`` and, then::
        
            pip install '.[test,dev]' .
        
        
        - Run unit test suite::
        
            python -m unittest
        
        - Or run with ``pytest``::
        
            pytest
        
        - Run individual test case::
        
            python -m unittest tests.test_libgds.LibGDSUnitTests.test_list_files_pagination
        
        - Pilot run or Integration Test::
        
            export IAP_BASE_URL=<baseUrl>
            export IAP_AUTH_TOKEN=<tok>
            python pilot.py
        
        - See `Developer Guide <developer>`_ for more notes
        
        Documentation
        -------------
        
        - Use Sphinx and reStructuredText
        
        - Document sources are in ``sphinx/source/*.rst``
        
        - Build doc like so::
        
            (cd sphinx && make clean)
            (cd sphinx && make html)
        
        - Browse doc locally in ``sphinx/build/html/index.html``
        
        - Build for github page::
        
            (cd sphinx && make github)
        
        - If everything looks good, make all docs::
        
            make doc
        
        License
        -------
        
        MIT License and DISCLAIMER
        
        .. image:: https://img.shields.io/badge/License-MIT-yellow.svg
            :target: https://opensource.org/licenses/MIT
            :alt: MIT License
        
Platform: UNKNOWN
Requires-Python: >=3.7
Provides-Extra: dev
Provides-Extra: test
