astrotraders

Name	astrotraders JSON
Version	1.0.2 JSON
	download
home_page	https://github.com/kiriharu/astrotraders
Summary	A typed, handwrited and powerful spacetraders API wrapper
upload_time	2023-05-14 00:18:27
maintainer
docs_url	None
author	kiriharu
requires_python	>=3.10,<4.0
license
keywords	spacetraders spacetraders.io
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/kiriharu/astrotraders",
    "name": "astrotraders",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<4.0",
    "maintainer_email": "",
    "keywords": "spacetraders,spacetraders.io",
    "author": "kiriharu",
    "author_email": "me@kiriha.ru",
    "download_url": "https://files.pythonhosted.org/packages/1e/ed/2fbf18a7dfa670d4857c028ccc1915603a45569bad8d098bc7ab59af395d/astrotraders-1.0.2.tar.gz",
    "platform": null,
    "description": "# astrotraders\n\nA typed, handwrited and powerful library for spacetraders.io game.\n\nSpaceTraders is an API-based game where you acquire and manage a fleet of ships to explore, trade, and fight your way across the galaxy.\n\nThis client based on [HTTPX](https://www.python-httpx.org/) and [Pydantic](https://docs.pydantic.dev/latest/).\n\n## Install\n```\npip install astrotraders\n```\n\n## Usage\n\nCurrently, you can use API wrapper which  represented by `AstroTradersClient` class:\n\n```python\nfrom astrotraders import AstroTradersClient\nclient = AstroTradersClient.set_up(\n    \"token_here\",\n)\n```\n\nAfter initializing client you can use API resources, for example:\n\n```python\nagent = client.agents.info()\nsystems = client.systems.list()\ncontracts = client.contracts.list()\nfactions = client.factions.list()\n# you can use undocumented endpoints!\nstats = client.server.stats()\nuniverse = client.systems.all()\n```\n\n## TODO\n1. \"Game objects\" with data caching and more pythonic usage\n2. CLI tool for manage fleet (and as example)\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A typed, handwrited and powerful spacetraders API wrapper",
    "version": "1.0.2",
    "project_urls": {
        "Homepage": "https://github.com/kiriharu/astrotraders",
        "Repository": "https://github.com/kiriharu/astrotraders"
    },
    "split_keywords": [
        "spacetraders",
        "spacetraders.io"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3f8df458c909c8270e92b576c9319213a0c2baaea62257151eb6ff6a213d07ad",
                "md5": "db9ff94a0d54988bcec85489d70dda26",
                "sha256": "7e73545f11539698401de03a56593c491642cc6a89ee716de6c05313c37763fa"
            },
            "downloads": -1,
            "filename": "astrotraders-1.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "db9ff94a0d54988bcec85489d70dda26",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<4.0",
            "size": 21123,
            "upload_time": "2023-05-14T00:18:25",
            "upload_time_iso_8601": "2023-05-14T00:18:25.917781Z",
            "url": "https://files.pythonhosted.org/packages/3f/8d/f458c909c8270e92b576c9319213a0c2baaea62257151eb6ff6a213d07ad/astrotraders-1.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1eed2fbf18a7dfa670d4857c028ccc1915603a45569bad8d098bc7ab59af395d",
                "md5": "7e57808cbcfb5278f0389fa020900f65",
                "sha256": "fd5ac6d24b8a4f4b4e1feb303dab6ba261d319cd862d7e91cecdf04e468dd43e"
            },
            "downloads": -1,
            "filename": "astrotraders-1.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "7e57808cbcfb5278f0389fa020900f65",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<4.0",
            "size": 17326,
            "upload_time": "2023-05-14T00:18:27",
            "upload_time_iso_8601": "2023-05-14T00:18:27.364018Z",
            "url": "https://files.pythonhosted.org/packages/1e/ed/2fbf18a7dfa670d4857c028ccc1915603a45569bad8d098bc7ab59af395d/astrotraders-1.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-14 00:18:27",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kiriharu",
    "github_project": "astrotraders",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "astrotraders"
}