https://github.com/a-tal/esi-knife
ESI Knife
https://github.com/a-tal/esi-knife
esi eve-online eveonline jackknife
Last synced: 5 months ago
JSON representation
ESI Knife
- Host: GitHub
- URL: https://github.com/a-tal/esi-knife
- Owner: a-tal
- License: mit
- Created: 2018-05-10T08:58:38.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-30T22:13:31.000Z (almost 8 years ago)
- Last Synced: 2024-01-29T22:48:38.930Z (over 2 years ago)
- Topics: esi, eve-online, eveonline, jackknife
- Language: Python
- Homepage: https://esi.a-t.al
- Size: 46.9 KB
- Stars: 20
- Watchers: 8
- Forks: 14
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ESI-knife
It's like jackknife, but for ESI.
## What does this do?
This will fetch all data about your character, your corporation and/or alliance that it can from ESI. It will compress and save this content into a file, which you could then share and/use with other applications.
This repo is both a web frontend and contains a CLI. The CLI is only useful for local/self use. The `.knife` files should not be considered tamper-proof in any way. If you are sharing your results with another party, the only trusted way to do so is via a web deployment.
Large corporations think about running your own please. This is self-hosted, please don't chew through my bandwidth.
## Is this official?
No. Not in any way shape or form. This is entirely a personal project.
## Getting started
1. Run `docker-compose up`
2. Go to http://localhost:8888/
Everything should "just work". If you need to adjust the SSO callback or exposed port, the environment variables are configured in the `docker-compose.yaml` file.
## Running locally without docker
If you don't have docker, you can either run this locally as a CLI, or as a website.
Both python 2.7 and 3.5+ are supported.
### Local CLI
```bash
$ pip install git+https://github.com/a-tal/esi-knife.git
$ knife --help
```
### Local Web
```bash
$ pip install git+https://github.com/a-tal/esi-knife.git[deploy]
$ gunicorn --worker-class=gevent --bind=localhost:8888 "esi_knife.web:main()"
```
Now open http://localhost:8888 in your favorite web browser.
## TODOs
If you want to help out with something from here pull requests are very welcomed.
- requests client caching
- styling is kinda p bad in general
There could also maybe be some routes missing, I threw this together in an evening after work. I did not look at each route and consider their usefulness, but rather went through by path parameters requested. Should be pretty close to all the character-specific data though. Feel free to open an issue here if I've missed something though.