Code Monkey home page Code Monkey logo

everest's Introduction

everest

Everest is a REST API for EVE static data. To start with it only supports routes and jump counts.

Usage

There are two API groups right now: GET /route/ and GET /jump/

Route

The route takes a source and destination and gives the shortest path between the two places. Route can take system names, system IDs, or any combination of the two.

GET /route/Jita/Perimiter/

{
  "count": 1,
  "route": [
  {
    "id": 30000142,
    "name": "Jita"
  },
  {
    "id": 30000144,
    "name": "Perimeter"
  }]
}

Route can also take station names or IDs via GET /route/station/<source>/<destination>/

Security Avoidance

Route can also be configured to avoid certain systems with a given sec status. For instance, to avoid all null and high sec systems, append /highonly/ to the request. To avoid high sec, append /nohigh/. This will result in routes that contain no entries of the given security status. If the start or end points fall in the avoidance list, everest will return an empty set.

Jump Count

In case you don't want the entire route and just want the jump count, GET /jump/ is for you. Just like route, there is a station mode GET /jump/station/. Again, it can take any combination of names and IDs. It also support security avoidance like the route API and is used in the same manner.

GET /jump/Jita/Rens/

{
  "jumps": 15
}

Batched Jump Count

If you need more than a few jump counts you should make use of the batched API. POST /jump/batch/ accepts json data with one source and multiple destinations. Each location can be a system name or ID, or a station name or ID.

POST /jump/batch/

{
  "source": "Jita",
  "destinations": [
    "Rens",
    "Irjunen"
  ]
}

The response to the request looks like this:

{
  "source": "Jita",
  "destinations": [{
    "jumps": 15,
    "destination": "Rens"
  }, {
    "jumps": 6,
    "destination": "Irjunen"
  }]
}

Industry

The industry API is used to fetch T2 blueprint details. There are two modes for retrieving these: getting all blueprints by category (or just all of them) and then pulling information for a specific item. See the howto under docs for more details.

Configuration

To run this locally you'll need everyting in requirements.txt. You can either edit config.py directory or add a configuration file to your environment. For local development, I have a file called debug.cfb, and everest looks for that via EVEREST_CONFIG (so, export EVEREST_CONFIG=debug.cfg).

Unit Tests

There are unit tests. They do, however, require the database to run. Run them via python everest_test.py.

everest's People

Contributors

kaelspencer avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

everest's Issues

Test Issue

This is a test issue. Looking for gitter.im integration.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.