Skip to main content

Converts postcodes to timezones

Project description

Postcode to Timezone

Looks up timezones based on postcode. This is based on the assumption that postcodes are roughly following the timezone lines. This is not always true, especially in disputed territories, but it is a good approximation for most cases.

The data used for this lookup is indirectly from OpenStreetMap.

Usage example

from postcode_to_timezone import get_tz

get_tz('us', '12345')

returns 'America/Chicago'

Building

To regenerate the lookup table, first obtain a dump of the location_postcode table from a Nominatim database, and compress it to location_postcode.csv.xz. Then run python3 generate_lookup_table.py to generate the lookup table.

Actual package is built with hatch build, and the package is uploaded to PyPI with hatch publish.

Data sources

Postcode locations

A dump of the location_postcode table in a Nominatim database. Nominatim creates this database from OpenStreetMap data using the following query:

SELECT
    COALESCE(plx.country_code, get_country_code(ST_Centroid(pl.geometry))) as country_code,
    pl.address->'postcode' as postcode,
    COALESCE(plx.centroid, ST_Centroid(pl.geometry)) as geometry
  FROM place AS pl
  LEFT OUTER JOIN placex AS plx
         ON pl.osm_id = plx.osm_id AND pl.osm_type = plx.osm_type
WHERE
 pl.address ? 'postcode'
 AND pl.geometry IS NOT null

A dump from that table is stored at location_postcode.csv.xz.

Postcode validation

A copy from this GitHub Gist is stored in postcode_regex.json. Actual source not known.

Timezone definitions

Timezone definitions are used from timezonefinder package on pypi. The package is licensed under the MIT license.

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

postcode_to_timezone-2024.11.27.0.tar.gz (588.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

postcode_to_timezone-2024.11.27.0-py2.py3-none-any.whl (15.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file postcode_to_timezone-2024.11.27.0.tar.gz.

File metadata

File hashes

Hashes for postcode_to_timezone-2024.11.27.0.tar.gz
Algorithm Hash digest
SHA256 2df5801bb97e918e8c04ba6162aa0bd7b890ae11a1b027ca63e9c76fd667d46c
MD5 836ae4c81bd677d2418fc095f6292341
BLAKE2b-256 f7d4b8d5edcb04c7d97346d737da20a0bf668bbeadc16041c9471e5dc47b052c

See more details on using hashes here.

File details

Details for the file postcode_to_timezone-2024.11.27.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for postcode_to_timezone-2024.11.27.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1344ab992fcb5b1c3bfdf1fec6d19b5f3fbe5e2c6849848572f531064b400ed2
MD5 ab1ab24a40d639e513ad0e786aabbfe1
BLAKE2b-256 2acc2e81e69d22902e7e2059bc32e51aa6287d5058e2ce323779cd5499a83511

See more details on using hashes here.

Supported by

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