| Name | geotz JSON |
| Version |
0.0.2b0
JSON |
| download |
| home_page | None |
| Summary | Simple library for offline lookup of the timezone for a location. |
| upload_time | 2024-08-04 08:34:33 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | ## License for included geographic data The geographic data provided with this package is derived from GeoNames (www.geonames.org), which is licensed under the Creative Commons Attribution 4.0 International License (CC BY 4.0). A summary of this license and the full license text are available at https://creativecommons.org/licenses/by/4.0/. Further redistribution of the geographic data bundled with this package must provide attribution to GeoNames. Redistribution includes any form of sharing the data with third parties in original or modified form, including publishing, distributing, or embedding it within other software. A simple link to www.geonames.org is considered sufficient attribution under the terms of the license. Simply using this library to infer timezones does not produce outputs that directly copy or modify the original licensed geographic data. Thus, using the library to infer timezones should not constitute a derivative work that requires direct attribution under the terms of the license. ## Main license MIT License Copyright (c) 2024 Daniel Mayo Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
geo
timezones
tz
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
.. image:: https://github.com/dmayo3/geotz/actions/workflows/ci.yaml/badge.svg
:target: https://github.com/dmayo3/mocksafe/actions/workflows/ci.yaml?query=branch%3Amain
:alt: Github Actions Status
.. image:: https://codecov.io/github/dmayo3/geotz/graph/badge.svg?token=A0WO17S0KD
:target: https://codecov.io/github/dmayo3/geotz
.. image:: https://readthedocs.org/projects/geotz/badge/?version=latest
:target: https://geotz.readthedocs.io/en/stable/?badge=latest
:alt: Documentation Status
.. image:: https://badge.fury.io/py/geotz.svg
:target: https://badge.fury.io/py/geotz
:alt: PyPI Package
.. image:: https://img.shields.io/pypi/pyversions/geotz.svg
:target: https://pypi.org/project/geotz
:alt: Supported versions
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code style: black
.. image:: http://www.mypy-lang.org/static/mypy_badge.svg
:target: http://mypy-lang.org/
:alt: Type checked by mypy
.. image:: https://img.shields.io/badge/License-CC%20BY%204.0%20%2B%20MIT-yellow
:target: https://github.com/dmayo3/geotz/blob/main/LICENSE
:alt: 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`
Raw data
{
"_id": null,
"home_page": null,
"name": "geotz",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "geo, timezones, tz",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/67/75/8c6f6074fb29a52166a0880df7a529ba3a18b43a90d5c33f3ddee606bf19/geotz-0.0.2b0.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/dmayo3/geotz/actions/workflows/ci.yaml/badge.svg\n :target: https://github.com/dmayo3/mocksafe/actions/workflows/ci.yaml?query=branch%3Amain\n :alt: Github Actions Status\n.. image:: https://codecov.io/github/dmayo3/geotz/graph/badge.svg?token=A0WO17S0KD \n :target: https://codecov.io/github/dmayo3/geotz\n.. image:: https://readthedocs.org/projects/geotz/badge/?version=latest\n :target: https://geotz.readthedocs.io/en/stable/?badge=latest\n :alt: Documentation Status\n.. image:: https://badge.fury.io/py/geotz.svg\n :target: https://badge.fury.io/py/geotz\n :alt: PyPI Package\n.. image:: https://img.shields.io/pypi/pyversions/geotz.svg\n :target: https://pypi.org/project/geotz\n :alt: Supported versions\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code style: black\n.. image:: http://www.mypy-lang.org/static/mypy_badge.svg\n :target: http://mypy-lang.org/\n :alt: Type checked by mypy\n.. image:: https://img.shields.io/badge/License-CC%20BY%204.0%20%2B%20MIT-yellow\n :target: https://github.com/dmayo3/geotz/blob/main/LICENSE\n :alt: License\n\n\nGeoTZ v0.0.2b0\n--------------\n\nDocs: https://geotz.readthedocs.io/\n\nThis is a small library for looking up the timezone for a given country code\nand postal code / postal code prefix. The main logic under `geotz` is very\nsmall indeed, so you can easily read it for yourself.\n\nIt's well tested - see the coverage badge above and take a look at the tests\nfor all the cases that are covered.\n\nCompared to alternatives like `geopy` or `pgeocode`, it's intended to be\neasier to use, less feature rich, and more lightweight.\n\nIt uses offline data from www.geonames.org to find the approximate location\nand then uses another library to convert that into a timezone.\n\nPlease read the LICENSE file for important information about using this\nlibrary and the data contained within.\n\nMotivation\n----------\n\n1. Easy to use. No API key or external API service required.\n\n2. Fast offline lookup.\n\n3. No downloads required; the necessary data comes bundled with the package.\n\n4. No network requests.\n\n5. I tried to keep the extra dependencies to a minimum.\n\n6. Data is loaded from disk on demand, so as to not use unnecessary memory.\n\nDevelopment\n-----------\n\nTo run the build, there's the GitHub actions workflows as well as the option to run locally.\n\nFor running the build locally, use `pip install tox` and the run `tox` in the repository base\ndirectory (or `tox -p` to run the build in parallel).\n\n1. Ensure you have `tox` installed e.g. by running `pip install tox`\n\n2. Extract data `tox -e extract_data`\n\n3. Run the build: `tox`\n",
"bugtrack_url": null,
"license": "## License for included geographic data The geographic data provided with this package is derived from GeoNames (www.geonames.org), which is licensed under the Creative Commons Attribution 4.0 International License (CC BY 4.0). A summary of this license and the full license text are available at https://creativecommons.org/licenses/by/4.0/. Further redistribution of the geographic data bundled with this package must provide attribution to GeoNames. Redistribution includes any form of sharing the data with third parties in original or modified form, including publishing, distributing, or embedding it within other software. A simple link to www.geonames.org is considered sufficient attribution under the terms of the license. Simply using this library to infer timezones does not produce outputs that directly copy or modify the original licensed geographic data. Thus, using the library to infer timezones should not constitute a derivative work that requires direct attribution under the terms of the license. ## Main license MIT License Copyright (c) 2024 Daniel Mayo Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Simple library for offline lookup of the timezone for a location.",
"version": "0.0.2b0",
"project_urls": {
"Docs": "http://geotz.readthedocs.io/",
"Source": "https://github.com/dmayo3/geotz"
},
"split_keywords": [
"geo",
" timezones",
" tz"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5714a3f76baf0c610484ed843e07d7e72b201ea7e3c72dc262fb1479e7e34a82",
"md5": "0cb2e1e2f9c2b54eef10f91df0bb531a",
"sha256": "14e191df826144812b7a5fdf7cc0f67f03458b3ed01787ee375e090f816e3693"
},
"downloads": -1,
"filename": "geotz-0.0.2b0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0cb2e1e2f9c2b54eef10f91df0bb531a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 17065929,
"upload_time": "2024-08-04T08:34:30",
"upload_time_iso_8601": "2024-08-04T08:34:30.279853Z",
"url": "https://files.pythonhosted.org/packages/57/14/a3f76baf0c610484ed843e07d7e72b201ea7e3c72dc262fb1479e7e34a82/geotz-0.0.2b0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "67758c6f6074fb29a52166a0880df7a529ba3a18b43a90d5c33f3ddee606bf19",
"md5": "352b1b2d56ee8208afc3dddfa178faed",
"sha256": "b77a395c69b5e6c7187b12dcf31d9e2ade662aa1e6db98bb101405ce5835de04"
},
"downloads": -1,
"filename": "geotz-0.0.2b0.tar.gz",
"has_sig": false,
"md5_digest": "352b1b2d56ee8208afc3dddfa178faed",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 16694865,
"upload_time": "2024-08-04T08:34:33",
"upload_time_iso_8601": "2024-08-04T08:34:33.272097Z",
"url": "https://files.pythonhosted.org/packages/67/75/8c6f6074fb29a52166a0880df7a529ba3a18b43a90d5c33f3ddee606bf19/geotz-0.0.2b0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-04 08:34:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dmayo3",
"github_project": "geotz",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "geotz"
}
