README
¶
MOTKI Core Libraries
The MOTKI EVE Corporation application libraries.
View current documentation on GoDoc.
Subpackage Overview
| Name | Description |
|---|---|
| app | Integration package that wires up all the dependencies in a MOTKI application. Use this package to bootstrap your own MOTKI client application. |
| cache | Short-lived, in-memory cache. |
| db | PostgreSQL database integration. Light wrapper around jackc/pgx. |
| eveapi | EVE API integration. Handles EVE SSO and fetching data from ESI using antihax/goesi. |
| evedb | EVE Static Data Export interface. Queries the SDE for static type/universe information. MOTKI uses Fuzzwork's Postgres dump. |
| evemarketer | Provides region- and system-specific market statistics using evemarketer.com. |
| log | Wrapper around sirupsen/logrus providing a configuration API and a defacto Logger type. |
| model | Encapsulates persistence of data to the database. General pattern is to fetch from DB, then from API if stale. The database schema for this package is defined in the resources/ddl/ directory. |
| proto | Defines the protocol buffer (and gRPC) interface for MOTKI at large. |
| proto/client | A golang gRPC client for interacting with a remote MOTKI application server. |
| proto/server | A golang gRPC server for handling MOTKI client requests. |
| worker | In-memory background task scheduler. |
Documentation
¶
Overview ¶
Package core contains libraries that provide various functionality, shared by all MOTKI applications.
This package is made up of subpackages, and currently serves informational purposes only.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package app contains functionality related to creating an integrated environment with all the necessary dependencies.
|
Package app contains functionality related to creating an integrated environment with all the necessary dependencies. |
|
profile
Package profile provides configuration-less profiling enabled with a command-line flag.
|
Package profile provides configuration-less profiling enabled with a command-line flag. |
|
Package cache is a short-lived, in-memory cache.
|
Package cache is a short-lived, in-memory cache. |
|
Package db manages interaction with an underlying database store.
|
Package db manages interaction with an underlying database store. |
|
Package eveapi manages fetching and posting data to the EVE Swagger API.
|
Package eveapi manages fetching and posting data to the EVE Swagger API. |
|
Package evedb manages interaction with the EVE Static Dump.
|
Package evedb manages interaction with the EVE Static Dump. |
|
Package evemarketer contains a client integration with the evemarketer.com API.
|
Package evemarketer contains a client integration with the evemarketer.com API. |
|
Package log provides a normalized interface for logging.
|
Package log provides a normalized interface for logging. |
|
Package model encapsulates the persistence layer and higher level functionality in a MOTKI application.
|
Package model encapsulates the persistence layer and higher level functionality in a MOTKI application. |
|
client
Package client provides an interface for interacting with a remote MOTKI installation.
|
Package client provides an interface for interacting with a remote MOTKI installation. |
|
server
Package server contains an implementation of the MOTKI GRPC server.
|
Package server contains an implementation of the MOTKI GRPC server. |
|
Package worker provides a simple asynchronous worker queue.
|
Package worker provides a simple asynchronous worker queue. |
Click to show internal directories.
Click to hide internal directories.