Metadata-Version: 2.1
Name: amti-islands
Version: 0.0.2
Summary: Object oriented islands in the South China Sea
Home-page: https://github.com/fionn/amti-islands
Author: Fionn Fitzmaurice
Project-URL: Source Code, https://github.com/fionn/amti-islands
Project-URL: Changelog, https://github.com/fionn/amti-islands/tags
Project-URL: Documentation, https://github.com/fionn/amti-islands/blob/master/README.md
Project-URL: Bug Tracker, https://github.com/fionn/amti-islands/issues
Project-URL: PyPI, https://pypi.org/project/amti-islands/
Project-URL: Download, https://github.com/fionn/amti-islands/archive/refs/heads/master.zip
Keywords: amti,south china sea,islands
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Provides-Extra: dev

# AMTI Islands

Object-oriented islands in the South China Sea.

## Installation

Install with `pip`.

## Interface

### Island

The `Island` class represents an island in the South China Sea.

Each instance has the following properties:

* `url`, the URL for the AMTI reference,
* `title`, the AMTI title,
* `names`, a dictionary of names for the island,
* `occupier`, optional occupying country,
* `legal_status`, the legal status of the feature,
* `geo`, a `Coordinates` object with `lat` and `long` properties.

### AMTI

Instantiate the `AMTI` class. This is a factory class for `Island` objects and has methods `islands` (a generator for `Island` instances) and `random_island` (which returns a random `Island`).
