Skip to main content

Simple library for offline lookup of the timezone for a location.

Project description

Github Actions Status https://codecov.io/github/dmayo3/geotz/graph/badge.svg?token=A0WO17S0KD Documentation Status PyPI Package Supported versions Code style: black Type checked by mypy License

GeoTZ v0.0.2b0

Docs: https://geotz.readthedocs.io/

This is a small library for looking up the timezone for a given country code and postal code / postal code prefix. The main logic under geotz is very small indeed, so you can easily read it for yourself.

It’s well tested - see the coverage badge above and take a look at the tests for all the cases that are covered.

Compared to alternatives like geopy or pgeocode, it’s intended to be easier to use, less feature rich, and more lightweight.

It uses offline data from www.geonames.org to find the approximate location and then uses another library to convert that into a timezone.

Please read the LICENSE file for important information about using this library and the data contained within.

Motivation

  1. Easy to use. No API key or external API service required.

  2. Fast offline lookup.

  3. No downloads required; the necessary data comes bundled with the package.

  4. No network requests.

  5. I tried to keep the extra dependencies to a minimum.

  6. Data is loaded from disk on demand, so as to not use unnecessary memory.

Development

To run the build, there’s the GitHub actions workflows as well as the option to run locally.

For running the build locally, use pip install tox and the run tox in the repository base directory (or tox -p to run the build in parallel).

  1. Ensure you have tox installed e.g. by running pip install tox

  2. Extract data tox -e extract_data

  3. Run the build: tox

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

geotz-0.0.2b0.tar.gz (16.7 MB view details)

Uploaded Source

Built Distribution

geotz-0.0.2b0-py3-none-any.whl (17.1 MB view details)

Uploaded Python 3

File details

Details for the file geotz-0.0.2b0.tar.gz.

File metadata

  • Download URL: geotz-0.0.2b0.tar.gz
  • Upload date:
  • Size: 16.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for geotz-0.0.2b0.tar.gz
Algorithm Hash digest
SHA256 b77a395c69b5e6c7187b12dcf31d9e2ade662aa1e6db98bb101405ce5835de04
MD5 352b1b2d56ee8208afc3dddfa178faed
BLAKE2b-256 67758c6f6074fb29a52166a0880df7a529ba3a18b43a90d5c33f3ddee606bf19

See more details on using hashes here.

File details

Details for the file geotz-0.0.2b0-py3-none-any.whl.

File metadata

  • Download URL: geotz-0.0.2b0-py3-none-any.whl
  • Upload date:
  • Size: 17.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for geotz-0.0.2b0-py3-none-any.whl
Algorithm Hash digest
SHA256 14e191df826144812b7a5fdf7cc0f67f03458b3ed01787ee375e090f816e3693
MD5 0cb2e1e2f9c2b54eef10f91df0bb531a
BLAKE2b-256 5714a3f76baf0c610484ed843e07d7e72b201ea7e3c72dc262fb1479e7e34a82

See more details on using hashes here.

Supported by

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