https://github.com/altaris/seat-navy-issue
Not affiliated with the original SeAT
https://github.com/altaris/seat-navy-issue
api-server esi eve-online python3
Last synced: 26 days ago
JSON representation
Not affiliated with the original SeAT
- Host: GitHub
- URL: https://github.com/altaris/seat-navy-issue
- Owner: altaris
- License: mit
- Created: 2020-06-16T08:23:46.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-12-14T23:19:12.000Z (over 5 years ago)
- Last Synced: 2025-09-09T04:56:59.519Z (10 months ago)
- Topics: api-server, esi, eve-online, python3
- Language: Python
- Homepage: https://altaris.github.io/seat-navy-issue/
- Size: 11.4 MB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
SeAT Navy Issue
===============
*not affiliated with the original [SeAT](https://github.com/eveseat/seat)*
[](https://editor.swagger.io/?url=https://raw.githubusercontent.com/altaris/seat-navy-issue/master/docs/openapi.yml)
[](https://altaris.github.io/seat-navy-issue/)
[](https://codeclimate.com/github/altaris/seat-navy-issue/maintainability)
[](https://pypi.org/project/black/)
[](https://choosealicense.com/licenses/mit/)
*logo derived from the work of [Smashicons](https://smashicons.com/)*
SeAT Navy Issue is a simpler alternative to
[SeAT](https://github.com/eveseat/seat). In short, it is an EVE Online
community manager, in the form of a REST API. Its core functionalities include:
* managing corporations, alliances, and even coalitions;
* creating and managing custom groups;
* storing and refreshing ESI tokens; making queries against the ESI;
* a simplistic clearance system;
* a Discord and Teamspeak connector.
Note that this project is just a backend. For a nice web-based user interface,
check out [SNI-frontend](https://github.com/r0kym/SNI-frontend).
# Getting started
## Dependencies
* `python3.8`;
* `requirements.txt` for runtime dependencies;
* `requirements.dev.txt` for development dependencies.
Simply run
```sh
virtualenv venv -p python3.8
. ./venv/bin/activate
pip install -r requirements.txt
pip install -r requirements.dev.txt
```
## Running
```sh
make run
RUN_ARGS='--help' make run # Custom command line arguments
```
## Documentation
Simply run
```sh
make docs
```
This will generate the HTML doc of the project, and the index file should be at
`docs/_build/index.html`.
## Code quality
Don't forget to run
```sh
make
```
to format the code following [black](https://pypi.org/project/black/),
typecheck it using [mypy](http://mypy-lang.org/), and check it using
[pylint](https://pylint.org/), and check for common vulnerabilities using [bandit](https://pypi.org/project/bandit/).