mirror of
https://github.com/marceloprates/prettymaps.git
synced 2025-08-30 17:50:13 +02:00
Enhance documentation with detailed usage examples and feature descriptions for Prettymaps.
This commit is contained in:
@@ -1,5 +1,7 @@
|
|||||||
# API Reference
|
# API Reference
|
||||||
|
|
||||||
This page will contain the API reference for Prettymaps.
|
This section is auto-generated from the Prettymaps source code.
|
||||||
|
|
||||||
_More details coming soon!_
|
::: prettymaps.draw
|
||||||
|
|
||||||
|
::: prettymaps.fetch
|
@@ -1,3 +1,24 @@
|
|||||||
# Prettymaps Documentation
|
# Prettymaps Documentation
|
||||||
|
|
||||||
Welcome to the Prettymaps documentation site.
|
Welcome to the Prettymaps documentation site.
|
||||||
|
|
||||||
|
Prettymaps is a minimal Python library to draw beautiful maps from OpenStreetMap data.
|
||||||
|
It allows you to easily generate artistic, customizable maps for any location in the world.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Fetches and visualizes OpenStreetMap data with minimal code
|
||||||
|
- Highly customizable layers and styles
|
||||||
|
- Supports elevation, hillshading, and keypoints
|
||||||
|
- Preset system for reusable map styles
|
||||||
|
- Export to PNG, SVG, and plotter-friendly formats
|
||||||
|
|
||||||
|
## Quick Example
|
||||||
|
|
||||||
|
```python
|
||||||
|
import prettymaps
|
||||||
|
|
||||||
|
prettymaps.plot("Porto Alegre, Brazil")
|
||||||
|
```
|
||||||
|
|
||||||
|
Explore the [Usage](usage.md) and [API Reference](api.md) for more details.
|
@@ -1,5 +1,55 @@
|
|||||||
# Usage
|
# Usage
|
||||||
|
|
||||||
This page will describe how to use Prettymaps.
|
## Installation
|
||||||
|
|
||||||
_More details coming soon!_
|
Install Prettymaps and its dependencies:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
pip install prettymaps
|
||||||
|
```
|
||||||
|
|
||||||
|
## Basic Usage
|
||||||
|
|
||||||
|
Generate a map for a location:
|
||||||
|
|
||||||
|
```python
|
||||||
|
import prettymaps
|
||||||
|
|
||||||
|
prettymaps.plot("Paris, France")
|
||||||
|
```
|
||||||
|
|
||||||
|
## Customizing Layers and Styles
|
||||||
|
|
||||||
|
You can customize which map layers to show and their appearance:
|
||||||
|
|
||||||
|
```python
|
||||||
|
layers = {
|
||||||
|
"perimeter": {},
|
||||||
|
"streets": {"width": 8},
|
||||||
|
"buildings": {},
|
||||||
|
"water": {},
|
||||||
|
}
|
||||||
|
style = {
|
||||||
|
"perimeter": {"fc": "#f2efe9", "ec": "#333"},
|
||||||
|
"streets": {"fc": "#cccccc"},
|
||||||
|
"buildings": {"fc": "#b0b0b0"},
|
||||||
|
"water": {"fc": "#aadaff"},
|
||||||
|
}
|
||||||
|
prettymaps.plot("Berlin, Germany", layers=layers, style=style)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Saving Maps
|
||||||
|
|
||||||
|
You can save the generated map to a file:
|
||||||
|
|
||||||
|
```python
|
||||||
|
prettymaps.plot("Tokyo, Japan", save_as="tokyo_map.png")
|
||||||
|
```
|
||||||
|
|
||||||
|
## Advanced Features
|
||||||
|
|
||||||
|
- **Keypoints:** Highlight specific places or features on the map.
|
||||||
|
- **Presets:** Save and reuse your favorite map styles.
|
||||||
|
- **Hillshade:** Add elevation shading for a 3D effect.
|
||||||
|
|
||||||
|
See the [API Reference](api.md) for all available options.
|
Reference in New Issue
Block a user