Metadata-Version: 2.1
Name: NaStyAPI
Version: 0.1.1
Summary: A Python wrapper for the NationStates API
Home-page: UNKNOWN
Author: Roddy Rappaport
Author-email: Roddy.Rappaport@gmail.com
License: CC Attribution 4.0 International
Platform: UNKNOWN
Description-Content-Type: text/markdown

# NaStyAPI - A NationState wrapper
![PyPi status](https://github.com/Nimi142/NaStyAPI/workflows/PyPi%20status/badge.svg)<br/>
A Python wrapper for the [NationStates](https://www.nationstates.net/) [api](https://www.nationstates.net/pages/api.html).<br/>
<sub><sup>Note: The wrapper doesn't have rate regulation yet but it is planned.</sup></sub>

# Table of Contensts:
- [NaStyAPI - A NationState wrapper](#nastyapi---a-nationstate-wrapper)
- [Table of Contensts:](#table-of-contensts)
  - [Installation:](#installation)
  - [Documentation](#documentation)
  - [Use:](#use)
    - [Nation](#nation)
    - [Region](#region)
    - [Telegrams](#telegrams)
    - [Trading Cards](#trading-cards)
    - [World](#world)
  - [How to contribute](#how-to-contribute)

## Installation:
The package is available on PyPi! simply write:<br/>
```pip install NaSty```

## Documentation
Planned...

## Use:
<hr/>
The NationState API is divided into parts, and so is the wrapper.


### Nation
To use the Nations api you must first import the module that deals with it, as such: 
```python
from NaStyAPI import Nation
```
This api lets you get statistics for specific countries, and to make commands to your own country. See the docs for more information.

### Region
To use the Regions api you must first import the module that deals with it, as such: 
```python
from NaStyAPI import Region
```
This api lets you get statistics for specific regions.

### Telegrams
To use the Telegrams api you must first import the module that deals with it, as such: 
```python
from NaStyAPI import Telegrams
```
This api lets you get statistics for specific regions.

### Trading Cards
To use the Trading Cards api you must first import the module that deals with it, as such: 
```python
from NaStyAPI import TradingCards
```
This api lets you get information about Trading cards.

### World
To use the Trading Cards api you must first import the module that deals with it, as such: 
```python
from NaStyAPI import World
```
This api lets you get information about the World.

## How to contribute
Thank you for looking at this!
There isn't all that much to do yet, so the best you can do to help is to use it!

