Skip to content

Commit ec3df68

Browse files
committed
Test on python 3.11. Update action deps.
1 parent d92c267 commit ec3df68

File tree

3 files changed

+14
-11
lines changed

3 files changed

+14
-11
lines changed

.github/workflows/test.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ jobs:
77
runs-on: ubuntu-latest
88
strategy:
99
matrix:
10-
python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
10+
python-version: ["3.6", "3.7", "3.8", "3.9", "3.10", "3.11"]
1111
steps:
12-
- uses: actions/checkout@v2
12+
- uses: actions/checkout@v3
1313
- name: Set up Python ${{ matrix.python-version }}
14-
uses: actions/setup-python@v2
14+
uses: actions/setup-python@v4
1515
with:
1616
python-version: ${{ matrix.python-version }}
17-
- uses: actions/cache@v2
17+
- uses: actions/cache@v3
1818
name: Configure pip caching
1919
with:
2020
path: ~/.cache/pip

README.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -59,18 +59,22 @@ The CLI currently supports these geocoders:
5959
- `bing`
6060
- `googlev3`
6161
- `mapquest` (and `open-mapquest`)
62-
- `nominatim`
6362
- `mapbox`
63+
- `nominatim`
6464
- `opencage`
6565

66-
More will be added soon.
66+
#### Adding new geocoders
67+
68+
1. Open an issue with the name of the geocoding service as the ticket title ([example](https://github.com/eyeseast/geocode-sqlite/issues/35)). Put any noteworthy implementation details in the ticket body, like where to get an API key if one is required.
69+
2. Fork the repo and add a geocoder.
70+
3. Add an example to the `Makefile`. Add tests if there's new shared functionality.
6771

6872
### Common arguments and options
6973

7074
Each geocoder needs to know where to find the data it's working with. These are the first two arguments:
7175

72-
- database: a path to a SQLite file, which must already exist
73-
- table: the name of a table, in that database, which exists and has data to geocode
76+
- `database`: a path to a SQLite file, which must already exist
77+
- `table`: the name of a table, in that database, which exists and has data to geocode
7478

7579
From there, we have a set of options passed to every geocoder:
7680

@@ -131,9 +135,8 @@ To run the tests:
131135

132136
```sh
133137
pytest
134-
135138
```
136139

137-
Please remember that this library is mainly glue code between other well-tested projects, specifically: click, geopy and sqlite-utils. Tests should focus on making sure those parts fit together correctly. We can assume the parts themselves already work.
140+
Please remember that this library is mainly glue code between other well-tested projects, specifically: [click](https://click.palletsprojects.com/), [geopy](https://geopy.readthedocs.io/en/stable/) and [sqlite-utils](https://sqlite-utils.datasette.io/en/stable/). Tests should focus on making sure those parts fit together correctly. We can assume the parts themselves already work.
138141

139142
To that end, there is a test geocoder included: `geocode_sqlite.testing.DummyGeocoder`. That geocoder works with an included dataset of In-N-Out Burger locations provided by [AllThePlaces](https://www.alltheplaces.xyz/). It works like a normal GeoPy geocoder, except it will only return results for In-N-Out locations using the included database.

setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
from setuptools import setup
22
import os
33

4-
VERSION = "0.6.1"
4+
VERSION = "0.7.0"
55

66
requirements = ["click>=7.0", "sqlite_utils", "geopy"]
77

0 commit comments

Comments
 (0)