Skip to content

Commit a534df7

Browse files
author
Stefan Kuethe
committed
Update README
1 parent dc13f49 commit a534df7

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,39 @@
1-
# OpenLayers for Python
1+
# py-openlayers: OpenLayers for Python
22

33
[![Release](https://img.shields.io/github/v/release/eoda-dev/py-openlayers)](https://img.shields.io/github/v/release/eoda-dev/py-openlayers)
44
[![pypi](https://img.shields.io/pypi/v/openlayers.svg)](https://pypi.python.org/pypi/openlayers)
55
[![License](https://img.shields.io/github/license/eoda-dev/py-openlayers)](https://img.shields.io/github/license/eoda-dev/py-openlayers)
66
[![OpenLayers JS](https://img.shields.io/badge/OpenLayers-v10.5.0-blue.svg)](https://github.com/openlayers/openlayers/releases//tag/v10.5.0)
77

8+
Provides Python bindings for [Openlayers](https://openlayers.org/), a high-performance, full-featured web mapping library that displays maps from various sources and formats. It makes it a easy to create interactive maps in [Marimo](https://marimo.io/) and [Jupyter](https://jupyter.org/) notebbooks with a few lines of code in a pydantic way.
9+
10+
## Features
11+
12+
### Tiled Layers
13+
14+
Pull tiles from OSM, CartoDB, MapTiler and any other XYZ source.
15+
16+
17+
### Vector Layers
18+
19+
Render vector data from GeoJSON, TopoJSON, KML, GML and other formats.
20+
21+
### Controls
22+
23+
Add geocoding, draw, full screen and other controls to your map.
24+
25+
### WebGL
26+
27+
Render large data sets using WebGL.
28+
29+
### PMTiles
30+
31+
Render PMTiles from vector and raster sources.
32+
33+
### Interactions
34+
35+
Drag and drop GPX, GeoJSON, KML or TopoJSON files on to the map. Modify, draw and select features.
36+
837
## Installation
938

1039
```bash
@@ -19,9 +48,14 @@ uv add "git+https://github.com/eoda-dev/py-openlayers@main"
1948
import openlayers as ol
2049

2150
# Jupyter or Marimo
22-
ol.MapWidget()
51+
m = ol.MapWidget()
52+
m # Display map
2353

2454
# Standalone
2555
m = ol.Map()
2656
m.save()
2757
```
58+
59+
## Note
60+
61+
The documentation is still in an early stage, more examples will be added as soon as possible.

0 commit comments

Comments
 (0)