Metadata-Version: 2.1
Name: pssapi
Version: 0.1.1
Summary: Wrapper for the Pixel Starships API
Home-page: https://github.com/PSS-Tools-Development/pssapi.py
Author: Solevis
Author-email: "The worst." <theworstpss@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/PSS-Tools-Development/pssapi.py
Project-URL: Bug Tracker, https://github.com/PSS-Tools-Development/pssapi.py/issues
Project-URL: Changelog, https://github.com/PSS-Tools-Development/pssapi.py/releases
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Programming Language :: Python :: 3.11
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: test
License-File: LICENSE.md

# Wrapper for the Pixel Starships API

This library allows you to request the Pixel Starships API through a Python Wrapper.

## Supported Platforms

- Python: 3.11

## Usage

### Installation

You can install this module using your package management method. For example:

```bash
pip install pssapi
```

### Get started

```python
import asyncio

from pssapi import PssApiClient


async def main():
    client = PssApiClient()

    item_designs = await client.item_service.list_item_designs()
    print(f"Found {len(item_designs)} item designs.")
    print(f"First item: {item_designs[0].item_design_name}")


if __name__ == "__main__":
    loop = asyncio.new_event_loop()
    asyncio.set_event_loop(loop)
    asyncio.run(main())
```

## Contributing

### Install development dependencies

```bash
make init
```

### Format code

```bash
make format
```

### Check & Test

```bash
make check
make test
```

### Showcase

```bash
# install locally pssapi.py
pip install -e .

# run the showcase with examples
python showcase.py
```
