Skip to main content

Carte is a flexible, extensible reverse-geocode library.

Project description

Carte




Carte is a flexible, extensible reverse-geocode library implemented in Python.

Installation

From PyPI via pip

Carte is available from PyPI via pip.

pip install carte

From source using poetry

Note: It is recommended to build carte in a virtual environment due to dependency version requirements.

From the root of the repository, install the necessary dependencies via poetry:

poetry install

Then, build the wheel:

poetry build

Finally, outside of your virtual environment, install the wheel using pip:

pip install dist/carte-<version>-py3-none-any.whl

Usage

Carte is built using resources which inherit from the Resource class. A Carte instance is instantiated with a list of the Resource types it will query:

import carte

carte_instance = carte.Carte([my_resource_type])

results = carte_instance.query(List of coordinates as tuples...)

Multiple Carte instances may be created, and resources will be shared between them by a backing ResourceStore.

Custom Resources

The flexibility of Carte lies in the Resource class, which queries are passed to sequentially via the query method. The results of each resource query are aggregated and passed to the next, allowing the creation of resources that mutate previous resources' results, such as translating a country's ISO 3166-1 identifier code into a full name.

For examples of Resource classes, see the resources submodule.

Defining your own Resource is as simple as inheriting from the Resource superclass, and implementing the load and query methods.

from carte.resources import resource

class MyCustomResource(resource.Resource):
    def load(self):
        # do stuff...

    def query(self, coordinates, results) -> dict:
        # do other stuff...
        return results

Testing

To run tests, execute the following from the root of the project:

poetry run pytest tests/

License

Carte is licensed under the GNU Lesser General Public License.

Attribution

Carte is inspired by reverse-geocode.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

carte-0.2.2.tar.gz (21.5 kB view details)

Uploaded Source

Built Distribution

carte-0.2.2-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

Details for the file carte-0.2.2.tar.gz.

File metadata

  • Download URL: carte-0.2.2.tar.gz
  • Upload date:
  • Size: 21.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.2 CPython/3.8.0 Darwin/18.7.0

File hashes

Hashes for carte-0.2.2.tar.gz
Algorithm Hash digest
SHA256 67c0ebbf75954c5a952e256729fe3d128e06916bd4731fdb7c121c8a227269f5
MD5 c7309967eb93a9d28617e881fa60e28d
BLAKE2b-256 891dbf7b118aa1d6be7e6fd8b388d1894a13a29ab1077f1d48e5a69d9c784df9

See more details on using hashes here.

File details

Details for the file carte-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: carte-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 23.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.2 CPython/3.8.0 Darwin/18.7.0

File hashes

Hashes for carte-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 12474c409084e113e205ec097ab686e0e8de9dbcbc5900399144389ff18f97ee
MD5 52d609f848d850516ceeee6f4915d557
BLAKE2b-256 74d872e9cca5a2aecdcffc994c5b1fc36df042bc5fd755a10242438706efdd53

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page