Skip to content

Commit 1b36653

Browse files
author
Nathaniel Henry
committed
Show pip install closecity now that the package is on PyPI.
1 parent 560831a commit 1b36653

3 files changed

Lines changed: 8 additions & 14 deletions

File tree

README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,9 @@ public transit. The data behind [close.city](https://close.city) is served over
99

1010
## Install
1111

12-
Will soon be on PyPI; install from GitHub until then:
13-
1412
```bash
15-
pip install git+https://github.com/henryspatialanalysis/closecity-python.git
16-
# add the census-block boundary downloader:
17-
pip install "closecity[tiger] @ git+https://github.com/henryspatialanalysis/closecity-python.git"
13+
pip install closecity
14+
pip install "closecity[tiger]" # to auto-download census-block boundaries
1815
```
1916

2017
This pulls in `httpx`, `pandas`, and `geopandas`, so results come back as data

docs/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ public transit. The data behind `close.city <https://close.city>`_ is served ove
1818
close_map(supermarkets, color = "#e8590c") # interactive map, bright hoverable points
1919
2020
By default, results come back as a GeoDataFrame where geometry applies (points,
21-
isochrones, and block polygons) and a plain DataFrame otherwise. Install it from GitHub for now (see
22-
:doc:`installation`); PyPI is coming. The catalog and lookup routes are free; the
23-
data routes need a key from `account.close.city <https://account.close.city>`_.
21+
isochrones, and block polygons) and a plain DataFrame otherwise. Install with
22+
``pip install closecity``. The catalog and lookup routes are free; the data routes
23+
need a key from `account.close.city <https://account.close.city>`_.
2424

2525
.. toctree::
2626
:maxdepth: 2

docs/installation.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
11
Installation
22
============
33

4-
The package will soon be published to PyPI. Until then, install it from GitHub:
5-
64
.. code-block:: bash
75
8-
pip install git+https://github.com/henryspatialanalysis/closecity-python.git
6+
pip install closecity
97
10-
Once it lands on PyPI, ``pip install closecity`` will work. Either way, this pulls
11-
in `httpx <https://www.python-httpx.org/>`_ and
8+
This pulls in `httpx <https://www.python-httpx.org/>`_ and
129
`geopandas <https://geopandas.org/>`_, so feature methods return GeoDataFrames out of
1310
the box.
1411

@@ -21,7 +18,7 @@ download the boundaries for you, add the ``tiger`` extra:
2118

2219
.. code-block:: bash
2320
24-
pip install "closecity[tiger] @ git+https://github.com/henryspatialanalysis/closecity-python.git"
21+
pip install "closecity[tiger]"
2522
2623
You do not need it for ``output="tabular"``, which returns the same rows without
2724
geometry.

0 commit comments

Comments
 (0)