ibledy / timezone-converter

Whole-day timezone comparison

Timezone Converter

Compare a full day of your local timezone with foreign ones

$ timezone-converter tijuana --zone	$ timezone-converter tijuana new_york

---

Motivation

When working with people that are not in your local timezone, the available resources are the usual webpages that only show one hour at a time, which is pretty inconvenient.

With this package you can quickly compare a full day of your timezone against foreign ones.

Installation

pip install -U timezone-converter

Usage

timezone-converter <timezone> [<timezone> ...]

Docker

docker run --rm -t bledy/timezone-converter <timezone> [<timezone> ...]

Features

Comparison between multiple timezones

Multiple timezones can be provided to get a side-by-side comparison.

Current hour highlighting

The row containing the current hour will be highlighted.

Output a single hour

Using the --single argument, you can output a single hour. If you don't provide a value, the current hour will be displayed.

List of available timezones

Using the --list argument, you can see a pretty list of available timezones, by groups, and sorted alphabetically.

$ timezone-converter --list

License

This project is licensed under the terms of the MIT license.

↥ back to top

timezone-converter's Issues

Wrong timezone for GMT+-X conversion

Issue:

The timezone output of the gmt+x and gmt-x seems to be swapped.
For the reference, Hong Kong is in GMT+8.

Step to reproduce:

$ timezone-converter --version
timezone-converter 0.12.1

$ timezone-converter hong_kong gmt-5 gmt+5

┏━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┓
┃      LOCAL       ┃  ASIA/HONG_KONG  ┃    ETC/GMT-5     ┃    ETC/GMT+5     ┃
┡━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━┩
│ 2022-11-24 00:00 │ 2022-11-24 00:00 │ 2022-11-23 21:00 │ 2022-11-23 11:00 │
│ 2022-11-24 01:00 │ 2022-11-24 01:00 │ 2022-11-23 22:00 │ 2022-11-23 12:00 │
│ 2022-11-24 02:00 │ 2022-11-24 02:00 │ 2022-11-23 23:00 │ 2022-11-23 13:00 │
│ 2022-11-24 03:00 │ 2022-11-24 03:00 │ 2022-11-24 00:00 │ 2022-11-23 14:00 │
│ 2022-11-24 04:00 │ 2022-11-24 04:00 │ 2022-11-24 01:00 │ 2022-11-23 15:00 │
...

Sort output by least difference

When the user inputs multiple timezones, we could sort the output so after the local timezone there's always the one that has the least difference.

• We should try to preserve the user order, so if there's no difference we use the input order.

• We may also add an argument to preserve the user order even if the sorted output would be different. Maybe we can use--preserve-order or --no-sort? Or maybe even have this feature as an opt-in via --order

For example, in the following screenshot, new_york has less difference than tijuana, so the sorted output would be:

1. local
2. new_york
3. tijuana

Missing unit tests

Highlight row with the current local time

Show difference in hours

We can show what the hour difference is, maybe where we show the --zone.

• It can be just a number, but I think we should use gmt+
• We can use an argument like --difference

Option to output a single letter group

When calling --list we can accept a value ([a-z]) to output just that letter group.

• We could also accept multiple ones.

Packaging

Center text using the widest name amongst all requested timezones

Replace unmaintained `upload-release-asset` action

The action we are currently using to upload assets to a release is not being actively maintained, so we need to replace it.

We recently replaced https://github.com/actions/create-release with https://github.com/softprops/action-gh-release, which already has the option to upload assets (it would also allow us to do it in a single step).

Output a single hour

Through an argument? (--single)

Add automated Docker image build and push to the `deployment` workflow

• The image should be pushed to this repo: https://hub.docker.com/r/bledy/timezone-converter (I guess we would need a secret, for example DOCKER_HUB_TOKEN).
• The image should use the same tag as the release that triggered the workflow (without the v prefix)

Add a search option to the cli

This would add a --search option to the cli, which can be used to search timezones by name.

Examples:

$ timezone-converter --search "new york"
Found 1 timezone: "new_york"

$ timezone-converter --search mad
Found 2 timezones: "madeira", "madrid"

Better argument name to output a single hour

I think we should change the argument to something like --hour. Initially we used -s/--single to avoid collision with -h (help) argument. Hour seems more appropiate, but suggestions are welcome.

The initial work was discussed in #3, and done in #16.

Suggestion: shorter programme name in command line

It's such a pleasure to use and work on this amazing project and thanks @ibLeDy for your work. 🎉

Just a suggested change from my experience of working on this project.

I sometimes find the programme name (timezone-converter) too long to type in the command line when testing my PR or running the programme. It would be nice to use a shorter name like tz-conv or tz-convert (can be anything). The current repo name can still remain unchanged.

For example, timezone-converter --list can possibly be tz-conv --list

Change deployment action so it is only when we manually create a release

Right now, when we push a new tag, a release is automatically created with the artifacts attached, and the new release is also automatically uploaded to pypi.

This has some possible disadvantages:

• We need to be careful when and where to push the tags.
• As the release is automatically created, we would need to edit the release after the fact.
• A release is always published to pypi, and if a problem arises, we have to manually fix things later.

If we change this, we would be more conscious about the releases, and we could manually triple-check that everything is correct, then publish to pypi.

Also note that before commit ce5df97, we were checking for new tags only on the master branch.

Output close matches when the timezone argument is not correct

When the user inputs a timezone that is not in the list, we should fuzzy search for similar ones to offer a suggestion.

We can also have a fuzzy search capability in case the --list option is not useful enough

Missing docstrings