ESI celery task queues for distributed API access using RabbitMQ and Redis.
Project description
ESICelery
ESI API requests library using RabbitMQ, celery tasks queues, and Redis caching.
Installation
pip install ESICelery
Usage
Starting the Celery worker server
From CLI
Set the following environmental variables and then run ESICelery from the CLI. Variables: BrokerUser, BrokerPassword, BrokerHost, BrokerPort, BrokerVhost, ResultBackendUser, ResultBackendPassword, ResultBackendHost, ResultBackendPort, ResultBackendDb
python ESICelery
From your code
From your worker code start the Celery worker server that handles running tasks:
from ESICelery.CeleryApp import CeleryApp
c = CeleryApp(broker_user="user", broker_password="pass", broker_host="host", broker_port=5672, broker_vhost="esi",
result_user="user", result_password="pass", result_host="host", result_port=6379, result_db=0,
header_email="youremail@example.com")
c.start() # Start celery app - equivalent to running "celery worker -l WARNING --autoscale 10,1 -Q queues"
Using ESICelery in your code
From another Python script you can send tasks to the queues and receive results:
from ESICelery.CeleryApp import CeleryApp
from ESICelery.tasks.Universe import *
c = CeleryApp(broker_user="user", broker_password="pass", broker_host="host", broker_port=5672, broker_vhost="esi",
result_user="user", result_password="pass", result_host="host", result_port=6379, result_db=0,
header_email="youremail@example.com") # only need to call this once in our code to init the tasks
r = SystemInfo().get_sync(timeout=5, system_id=30000142)
print(r)
Current supported endpoints
ESI Route | ESICelery Task |
---|---|
/alliances/{alliance_id}/ | AllianceInfo() |
/characters/{character_id}/ | CharacterPublicInfo() |
/corporations/{corporation_id}/ | CorporationInfo() |
/markets/prices/ | PricesList() |
/universe/categories/{category_id}/ | CategoryInfo() |
/universe/constellations/{constellation_id}/ | ConstellationInfo() |
/universe/factions/ | FactionsList() |
/universe/groups/{group_id}/ | GroupInfo() |
/universe/regions/{region_id}/ | RegionInfo() |
/universe/systems/{system_id}/ | SystemInfo() |
/universe/types/{type_id}/ | TypeInfo() |
Examples
See the included example scripts under docs/examples
Copyright Notice
See CCP.md
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ESICelery-0.8.tar.gz
(24.3 kB
view hashes)
Built Distribution
ESICelery-0.8-py3-none-any.whl
(30.4 kB
view hashes)