Metadata-Version: 2.1
Name: pyrsi
Version: 0.1.3
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
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 :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: cachetools (==2.1.0)
Requires-Dist: requests (==2.20.1)
Requires-Dist: fuzzywuzzy (==0.17.0)
Requires-Dist: python-Levenshtein (==0.12.0)
Requires-Dist: wptools (==0.4.17)

==========
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


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
--------

Accessing ship information:

.. code-block:: python

    from rsi.shipmatrix import ShipMatrixAPI
    ships = ShipMatrixAPI()
    ship = ships.list()[0]
    ship = ships.search_by_name('kraken')

Accessing citizen information:

.. code-block:: python

    from rsi 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_true, username, 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.2 (2018-12-27)
------------------

* Added Authentication and session management required for accessing privileged Organization members
  list

0.1.0 (2018-12-10)
------------------

* Initial commit


