A wrapper for WorldtimeAPI with search functionality.
Worldtime-py is a Python wrapper for . It is able to search through the endpoints of the API to find the closest location if the exact one could not be found. It reduces the strain and the difficulty of getting the time for the location desired.
is a JSON API for obtaining the current time in, and related data about, a timezone. It gives data suh as the UTC offset, whether that timezone is in Daylight Savings Time (DST), offset, etc.
This library can be installed by using
pip install worldtimepy. Doing so will automatically install all requirements.
This library requires you to have , , and . All of those can be installed using
Using the wrapper
This is the main class through which you should interact with the API.
Has all existing locations from WorldtimeAPI.
.from_ip(ip: str='') -> TimeInfo optional argument: ip
Takes an IP and returns a corresponding TimeInfo object with timezone information for that IP. If no IP is provided, it will use the requesting IP.
.find_by_name(name: str) -> list
Takes a string and returns a list of strings for all locations that contain that name.
.search(name: str) -> str
Takes a country name or a city name and tries to find it in the database. It returns a string that can be used by
Warning: This function iterates through different databases to try and locate the query. It may be slow.
.get_location(location: str) -> object
Takes a proper location taken from
find_by_nameand returns a TimeInfo object.
Gathers new data for
class timeinfo.TimeInfo(to_get=0, ip: bool=False)
This class takes a location found through one of the other methods and makes an object with information for that timezone. You can use any location from worldtime.WorldTime().locations here.
Alternatively, if you set ip to True, you may provide an IPv4 address on to_get to get time information for that IP. If ip is set to True and nothing is given to to_get, the machine's IP will be used.
Printing or turning this object into a string returns a prettier string containing time information.
2021-06-11 00:14:14.378300 UTC-0700
Full json pulled from the API.
Returns current day of the week.
Returns current day of the year.
Returns current number of the week of the year.
Returns an aware .
Returns a string version of a datetime object.
Returns a string representing the abbreviated format of the timezone. E.g. 'PST'
Returns whether timezone is in daylight savings time.
Returns a unix like time integer.
Returns the UTC time..
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for worldtimepy-0.1.1-py3-none-any.whl