mapchartpy 0.0.3

Some utilities for modifying or creating save files from mapchart.net

mapchartpy

A super simple library to manage and create Mapchart save files.

Getting started

1. Please make sure your code editor has support for intellisense in Python. This library has typing for basically everything, so it'll make your life a lot easier.

Opening a map

```python
import mapchartpy as mc
from pathlib import Path

map = mc.Map(save_file=Path("map.txt"))
```

Creating a new map

```python
import mapchartpy as mc

map = mc.Map()
```

Highlighting a country

```python
import mapchartpy as mc

map = mc.Map()
map.fill_country("Finland", "#002F6C")
```

You can find a list of countries available by running

```python
import mapchartpy as mc

countries = mc.Map.get_countries_and_territories()
print(countries)

# >> ['Austria', 'Belgium', 'Bulgaria', 'Croatia', 'Cyprus', 'Czechia', 'Denmark'...
```

Highlighting US states

```python
import mapchartpy as mc

map = mc.Map()
map.fill_country("USA_Kentucky", "#A3080B")
```

States are generally formatted as "US_(State)"

You can find a list of states available by running

```python
import mapchartpy as mc

territories = mc.Map.get_countries_and_territories()

for territory in territories:
    if territory.startswith("US"):
        print(territory)

```

Creating a map of a specific region

For example, here's europe:

```python
import mapchartpy as mc

map = mc.Map()
map.set_map_type("europe")
```

Saving the map file

```python
import mapchartpy as mc
import json

map = mc.Map()
map.fill_country("Finland", "#002F6C")

with open("output.txt", "w") as f:
    json.dump(map.get_file(), f)
```

Features

1. Super simple editing It's literally three lines of code

import mapchartpy as mc

map = mc.Map()
map.fill_country("Finland", "#002F6C")

2. Ability to load existing maps

import mapchartpy as mc
from pathlib import Path

map = mc.Map(save_file=Path("map.txt"))

3. Full type hinting The library supports full* type hinting of the Mapchart save file, in addition to some other nice-to-haves.

*: Type hinting may not be available for special properties. If you encounter a situation where you don't have full type hinting, please make an issue on our GitHub

4. Exporting to Mapchart's file format

import mapchartpy as mc
import json

map = mc.Map()
map.fill_country("Finland", "#002F6C")

with open("output.txt", "w") as f:
    json.dump(map.get_file(), f)

5. Dead simple installation It's literally just pip install mapchartpy