Metadata-Version: 1.1
Name: pyrsi
Version: 0.1.14
Summary: Python API for interacting with the Roberts Space Industries site for Star Citizen.
Home-page: https://github.com/ExterraGroup/pyrsi
Author: Ventorvar
Author-email: ventorvar@gmail.com
License: MIT license
Description: ==========
        Python RSI
        ==========
        
        
        .. image:: https://img.shields.io/pypi/v/pyrsi.svg
                :target: https://pypi.python.org/pypi/pyrsi
        
        .. image:: https://img.shields.io/travis/ExterraGroup/pyrsi.svg
                :target: https://travis-ci.org/ExterraGroup/pyrsi
        
        .. image:: https://readthedocs.org/projects/pyrsi/badge/?version=latest
                :target: https://pyrsi.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        .. image:: https://coveralls.io/repos/github/ExterraGroup/pyrsi/badge.svg?branch=devel
                :target: https://coveralls.io/github/ExterraGroup/pyrsi?branch=devel
        
        
        
        Python API for interactive with the Roberts Space Industries site for Star Citizen.
        
        .. warning:: This API is in it's very early stages and will change often.
        
        * Free software: MIT license
        * Documentation: https://pyrsi.readthedocs.io.
        
        
        Features
        --------
        
        * TODO
        
        
        Examples
        --------
        
        Getting system status:
        
        .. code-block:: python
        
           from rsi.status import Status
           s = Status()
           current_status = s.system()
           recent_incidents = s.timeline()
           specific_incident = s.incident('28f92e5a')
        
        
        Accessing ship information:
        
        .. code-block:: python
        
            from rsi.shipmatrix import ShipMatrixAPI
            ship_matrix = ShipMatrixAPI()
            ship = ship_matrix.ships[170]      # ships is a dictionary, keys are ship IDs
            ship = ship_matrix.search_by_name('kraken')
        
        Accessing citizen information:
        
        .. code-block:: python
        
            from rsi.citizen import fetch_citizen
            fetch_citizen('ventorvar')
        
        Accessing org information:
        
        .. code-block:: python
        
            from rsi.org import OrgAPI
            org = OrgAPI('EXTERRA')
            member = org.members[0]
        
        Accessing admin org information for an organization that you have the Officer or Founder role for.
        This let's you see the member information for hidden members.
        
        .. code-block:: python
        
            from rsi.org import OrgAPI
            org = OrgAPI('EXTERRA', admin_mode=True, username=username, password=password)
            member = org.members[0]
            members = org.search('fuzzy_handle_matching')     # list of members using fuzzy matching
            member = org.search_one('fuzzy_handle_matching')  # returns only the top match
        
        
        
        =======
        History
        =======
        
        0.1.11 (2020-05-02)
        -------------------
        
        * Added RSI status page API
        
        0.1.2 (2018-12-27)
        ------------------
        
        * Added Authentication and session management required for accessing privileged Organization members
          list
        
        0.1.0 (2018-12-10)
        ------------------
        
        * Initial commit
        
Keywords: pyrsi
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
