annabunches/elite_api
Archived
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update readme to reflect new targets for the library.

Browse Source
This commit is contained in:
Anna Rose 2016-01-21 14:33:04 -05:00
parent 95869d1daa
commit 4c817005ca
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Readme.md
View File

@ -1,9 +1,14 @@
# inara.py
# elite_api
This is a simple python library that is used to retrieve and store data to inara.py.
This is a simple python library that can:
* Retrieve and store select data on <http://inara.cz>.
* Retrieve data from the Elite: Dangerous Companion API.
It subclasses requests_cache.core.CachedSession to provide a specialized HTTP session to talk to inara.
Usage is simple:
### inara.py
The inara module subclasses requests_cache.core.CachedSession to provide a specialized
HTTP session to talk to inara. Usage is simple:
from inara.inara import InaraSession
@ -19,3 +24,9 @@ If the logged-in user is a member of a Wing, you can get information about wing-
info = session.get_cmdr_info(wing_id, cmdr_id)
where the 'id's are the numeric identifiers visible in inara's URLs.
### companion.py
This module just provides a cleaner interface on top of the companion module from the
Elite Dangerous Market Connector.