Skip to content

Latest commit

 

History

History
96 lines (77 loc) · 3.84 KB

README.md

File metadata and controls

96 lines (77 loc) · 3.84 KB

Democritus Timezones

PyPI CI Lint codecov The Democritus Project uses semver version 2.0.0 The Democritus Project uses black to format code License: LGPL v3

Democritus functions[1] for working with timezones.

[1] Democritus functions are simple, effective, modular, well-tested, and well-documented Python functions.

We use d8s (pronounced "dee-eights") as an abbreviation for democritus (you can read more about this here).

Installation

pip install d8s-timezones

Usage

You import the library like:

from d8s_timezones import *

Once imported, you can use any of the functions listed below.

Functions

  • def pytz_timezone_object(timezone_name: str):
        """Create a pytz timezone object for the given timezone_name."""
  • def pytz_country_names():
        """Get a dictionary with countries's ISO 3166 country code as keys and the country name as the value."""
  • def pytz_country_timezones():
        """Get a dictionary with countries's names as keys and the timezones as values."""
  • def timezones_names():
        """Get a list of all timezones."""
  • def timezone_utc_offset(timezone_name: str, date):
        """Find how many hours the given timezone is off from UTC."""
  • def timezone_abbreviation(timezone_name: str, date):
        """Find the abbreviation for the given timezone_name."""
  • def country_timezone_abbreviation(country_name: str, date):
        """Find the abbreviation for the given country_name."""
  • def country_code_timezone_abbreviation(iso_3166_country_code: str, date):
        """Find the abbreviation for the given iso_3166_country_code."""
  • def country_code_timezones(iso_3166_country_code):
        """Find the timezones for the country with the given iso_3166_country_code."""
  • def country_timezones(country_name):
        """Find the timezones for the given country."""
  • def timezone_countries(timezone_name):
        """Find countries in the given timezone_name."""

Development

👋  If you want to get involved in this project, we have some short, helpful guides below:

If you have any questions or there is anything we did not cover, please raise an issue and we'll be happy to help.

Credits

This package was created with Cookiecutter and Floyd Hightower's Python project template.