Metadata-Version: 2.1
Name: astrotraders
Version: 1.0.2
Summary: A typed, handwrited and powerful spacetraders API wrapper
Home-page: https://github.com/kiriharu/astrotraders
Keywords: spacetraders,spacetraders.io
Author: kiriharu
Author-email: me@kiriha.ru
Requires-Python: >=3.10,<4.0
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Dist: httpx (>=0.24.0,<0.25.0)
Requires-Dist: orjson (>=3.8.12,<4.0.0)
Requires-Dist: pydantic (>=1.10.7,<2.0.0)
Project-URL: Repository, https://github.com/kiriharu/astrotraders
Description-Content-Type: text/markdown

# astrotraders

A typed, handwrited and powerful library for spacetraders.io game.

SpaceTraders is an API-based game where you acquire and manage a fleet of ships to explore, trade, and fight your way across the galaxy.

This client based on [HTTPX](https://www.python-httpx.org/) and [Pydantic](https://docs.pydantic.dev/latest/).

## Install
```
pip install astrotraders
```

## Usage

Currently, you can use API wrapper which  represented by `AstroTradersClient` class:

```python
from astrotraders import AstroTradersClient
client = AstroTradersClient.set_up(
    "token_here",
)
```

After initializing client you can use API resources, for example:

```python
agent = client.agents.info()
systems = client.systems.list()
contracts = client.contracts.list()
factions = client.factions.list()
# you can use undocumented endpoints!
stats = client.server.stats()
universe = client.systems.all()
```

## TODO
1. "Game objects" with data caching and more pythonic usage
2. CLI tool for manage fleet (and as example)

