Metadata-Version: 2.1
Name: planet-generator-sdk
Version: 0.1.1
Summary: Python SDk for Planet API, the 2D planet sprite generator.
Home-page: https://planet.joffreybvn.be
Author: Joffrey Bienvenu
Author-email: joffreybvn@gmail.com
License: MIT
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown


# Planet Generator - Python SDK

Planet API is a **2D planet sprite generator**. Our internal process procedurally generate surfaces, map them to a true sphere, to finally render a planet at 1080x1080 with transparent background.
This SDK facilitate the interaction with the API and implement masks features to add lighting and solar effect to the planets.

This API currently under development. During this phase, it can be accessed for free. [See here how to get your key](https://planet.joffreybvn.be/).

## Installation

```shell
  pip install planet-generator-sdk
```

## Quickstart

Generate a 2D planet sprite with masks:

```python
from planet_generator import Client

# Create a Planet API client
planet_api = Client.from_api_key(
    api_key="YOUR API KEY HERE"
)

# Generate a new planet
planet = planet_api.get_planet()
sprite = planet.sprite.get_image(apply_masks=True)

sprite  # Contains the 2D planet sprite
```

