Metadata-Version: 1.1
Name: pyrsi
Version: 0.1.17
Summary: Python API for interacting with the Roberts Space Industries site for Star Citizen.
Home-page: https://gitlab.com/scmodding/frameworks/pyrsi
Author: Ventorvar
Author-email: ventorvar@gmail.com
License: MIT license
Description: Python RSI
        ==========
        
        A community made 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.
        
        * 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')
        
        
        Getting Roadmap information:
        
        .. code-block:: python
        
            from datetime import datetime
            from rsi.roadmap import Roadmap
            r = Roadmap()
            cur_roadmap = r.fetch_roadmap(start_date=datetime(year=2021, month=1, day=1),
                                          end_date=datetime(year=2021, month=12, day=31))
        
        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
        
        
        
        
        .. image:: docs/MadeByTheCommunity_Black.png
          :width: 128
          :alt: Made By the Star Citizen Community
        
        This project is not endorsed by or affiliated with the Cloud Imperium or Roberts Space Industries group of companies.
        All game content and materials are copyright Cloud Imperium Rights LLC and Cloud Imperium Rights Ltd..  Star CitizenÂ®,
        Squadron 42Â®, Roberts Space IndustriesÂ®, and Cloud ImperiumÂ® are registered trademarks of Cloud Imperium Rights LLC.
        All rights reserved.
        
        
        =======
        History
        =======
        
        0.1.16 (2020-12-30)
        -------------------
        
        * Moved to GitLab
        
        0.1.15 (2020-12-23)
        -------------------
        
        * Added new Roadmap API
        
        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.8
