Skip to content

r0kym/seat-navy-issue

 
 

Repository files navigation

SeAT Navy Issue

not affiliated with the original SeAT

Swagger Documentation Maintainability Python 3 Code style MIT License

Logo 256x256

logo derived from the work of Smashicons

SeAT Navy Issue is a simpler alternative to 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.

Getting started

Dependencies

  • python3.8;
  • requirements.txt for runtime dependencies;
  • requirements.dev.txt for development dependencies.

Simply run

virtualenv venv -p python3.8
. ./venv/bin/activate
pip install -r requirements.txt
pip install -r requirements.dev.txt

Running

make run
RUN_ARGS='--help' make run  # Custom command line arguments

Documentation

Simply run

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

make

to format the code following black, typecheck it using mypy, and check it using pylint, and check for common vulnerabilities using bandit.

About

Not affiliated with the original SeAT

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 99.4%
  • Makefile 0.6%