Skip to content

Commit

Permalink
get ready for 1.0.0 (#240)
Browse files Browse the repository at this point in the history
  • Loading branch information
hobu authored Apr 4, 2022
1 parent 5e6a2e6 commit 5bd4397
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 6 deletions.
7 changes: 6 additions & 1 deletion CREDITS.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Howard Butler <[email protected]>
* .count() and .intersection() methods
* Windows support
* Node fetching
* Index property access
* Index property access

Brent Pedersen <[email protected]>

Expand All @@ -26,3 +26,8 @@ Matthias <[email protected]>

* Custom storage API (both Rtree and libspatialindex)


Adam Stewart

* intersection/union support
* __len__ method
37 changes: 34 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,42 @@
Rtree
=====
# Rtree: Spatial indexing for Python

![Build](https://github.com/Toblerity/rtree/workflows/Build/badge.svg)
[![PyPI version](https://badge.fury.io/py/Rtree.svg)](https://badge.fury.io/py/Rtree)

RTree is a Python package with bindings for [libspatialindex](https://github.com/libspatialindex/libspatialindex). Wheels are available for most major platforms, and `rtree` with bundled `libspatialindex` can be installed via pip:

Rtree`_ is a [ctypes](http://docs.python.org/library/ctypes.html) Python wrapper of [libspatialindex](https://libspatialindex.org/) that provides a
number of advanced spatial indexing features for the spatially curious Python
user. These features include:

* Nearest neighbor search
* Intersection search
* Multi-dimensional indexes
* Clustered indexes (store Python pickles directly with index entries)
* Bulk loading
* Deletion
* Disk serialization
* Custom storage implementation (to implement spatial indexing in ZODB, for example)


Wheels are available for most major platforms, and `rtree` with bundled `libspatialindex` can be installed via pip:

```
pip install rtree
```

# Changes

## 1.0.0


* Python 3.7+ is now required (#212) (thanks @adamjstewart!)
* Type hints (#215 and others) (thanks @adamjstewart!)
* Python 3.10 wheels, including osx-arm64 #224
* Clean up libspatialindex C API mismatches #222 (thanks @musicinmybrain!)
* Many doc updates, fixes, and type hints (thanks @adamjstewart!) #212 #221 #217 #215
* __len__ method for index #194
* Prevent get_coordinate_pointers from mutating inputs #205 (thanks @sjones94549!)
* linux-aarch64 wheels #183 (thanks @odidev!)
* black (#218) and flake8 (#145) linting

https://github.com/Toblerity/rtree/releases/1.0.0
2 changes: 1 addition & 1 deletion rtree/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
Rtree provides Python bindings to libspatialindex for quick
hyperrectangular intersection queries.
"""
__version__ = "0.9.7"
__version__ = "1.0.0"

from .index import Index, Rtree # noqa
3 changes: 2 additions & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ classifiers =
Topic :: Database
license = MIT
description = R-Tree spatial index for Python GIS
long_description = file: docs/source/README.txt
long_description = file: README.md
long_description_content_type = text/markdown
keywords = gis, spatial, index, r-tree

[options]
Expand Down

0 comments on commit 5bd4397

Please sign in to comment.