This repository was archived by the owner on Jul 11, 2024. It is now read-only.
- Notifications
You must be signed in to change notification settings - Fork0
Golang package and command line tool to return or output the difference between date, time or duration
License
NotificationsYou must be signed in to change notification settings
jftuga/dtdiff
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
This project has been superseded by another one of my projects:
Please use that instead as it has better functionality.
dtdiffis actually the name of aDebian binary as discussed in thisissue.- I initially wrote this program to find the difference between two date/times. However, adding or subtracting a duration from a date/time turned out to be a more interesting problem to solve.
- I went down a cobra CLI & Usage rabbit hole, especially with custom output, thus making the code more complicated than necessary. This is no longer needed in the new code base.
- This library's features were bolted on instead of rebuilt from the ground up.DateTimeMate uses thegolang options pattern which should easily allow for backward-compatible library updates in the future.
- In the new code base, I decided to use the word
repeatinstead ofrecurrence, which is more concise & understandable.
Golang package and command line tool to return or output the difference between date, time or duration
dtdiff allows you to answer three types of questions:
- What is the duration between two different dates and/or times?
- start and end can be in various formats, such as:
- 11:22:33
- 2024-06-01
- "2024-06-01 11:22:33"
- 2024-06-01T11:22:33.456Z
- What is the datetime when adding or subtracting a duration?
- Duration examples include:
- 5 minutes 5 seconds(or 5m5s)
- 3 weeks 4 days 5 hours(or 3W4D5h)
- 8 months 7 days 6 hours 5 minutes 4 seconds(or 8M7D6h5m4s)
- 1 year 2 months 3 days 4 hours 5 minutes 6 second 7 milliseconds 8 microseconds 9 nanoseconds(or 1Y2M3D4h5m6s7ms8us9ns)
- Similar to question two, but repeats a period multiple times or until a certain datetime is encountered.
- Library:
go get -u github.com/jftuga/dtdiff - Run:
go install github.com/jftuga/dtdiff/cmd/dtdiff@latest - Command line tool: Binaries for all platforms are provided in thereleases section.
- Homebrew (MacOS / Linux):
brew tap jftuga/homebrew-tap; brew update; brew install jftuga/tap/dtdiff
Supported date time formats are listed in:https://go.dev/src/time/format.go
Code Snippet:
// import "github.com/jftuga/dtdiff"// example 1 - difference between two datesdt:=dtdiff.New("2024-01-01 00:00:00","2025-12-31 23:59:59")format,_,err:=dt.DtDiff()fmt.Println(format)// 2 years 23 hours 59 minutes 59 seconds// alternatively, use the brief format:dt.SetBrief(true)format,_,_=dt.DtDiff()fmt.Println(format)// 2Y23h59m59s// example 2 - durationfrom:="2024-01-01 00:00:00"period:="1 day 1 hour 2 minutes 3 seconds"// can also use: "1D1h2m3s"future,_:=dtdiff.Add(from,period)fmt.Println(future)// 2024-01-02 01:02:03past,_:=dtdiff.Sub(from,period)fmt.Println(past)// 2023-12-30 22:57:57// example 3 - duration with five intervalsfrom:="2024-06-28T04:25:41Z"period:="1M1W1h1m2s"recurrence:=5all,_:=dtdiff.AddWithRecurrence(from,period,recurrence)// can also use SubWithRecurrencefor_,a:=rangeall {fmt.Println(a)}// example 4 - repeat interval until a datetime is encounteredfrom:="2024-06-28T04:25:41Z"period:="1M1W1h1m2s"until:="2025-01-01 09:30:51"all,err:=dtdiff.AddUntil(from,until,period)// can also use SubUntilfor_,a:=rangeall {fmt.Println(a)}
Full Example:
See theexample program and itsexpected output.
dtdiff: output the difference between date, time or durationUsage: dtdiff [flags]Globals: -h, --helphelp for dtdiff -n, --nonewlinedo not output a newline character -v, --versionversion for dtdiffFlag Group 1 (mutually exclusive with Flag Group 2): -b, --briefoutput in brief format, such as: 1Y2M3D4h5m6s7ms8us9ns -e, --end stringend date, time, or a datetime -s, --start stringstart date, time, or a datetime -i, --stdinread from STDIN instead of using -s/-eFlag Group 2: -A, --add stringadd: a duration to use with -F, such as '1 day 2 hours 3 seconds' -F, --from stringa base date, time or datetime to use with -A or -S -R, --recurrence intrepeat period this number of times (mutually exclusive with -U) -S, --sub stringsubtract: a duration to use with -F, such as '5 months 4 weeks 3 days' -U, --until stringrepeat period until date/time is exceededDurations:years months weeks dayshours minutes seconds milliseconds microseconds nanosecondsexample: "1 year 2 months 3 days 4 hours 1 minute 6 seconds"Brief Durations: (dates are upper, times are lower)Y M W Dh m s ms us nsexamples: 1Y2M3W4D5h6m7s8ms9us1ns, "1Y 2M 3W 4D 5h 6m 7s 8ms 9us 1ns"Relative Dates:for the -s, -e, -F, and -U flags, you can use these shortcuts:nowtoday (returns same value as now)yesterdaytomorrowexample: dtdiff -F today -A 7h10m -U tomorrowNote: The-i switch can accept two different types of input:
- one line with start and end separated by a comma
- two lines with start on the first line and end on the second line
Note: The-n switch along with-R will use a comma-delimited output
# difference between two times on the same day$ dtdiff -s 12:00:00 -e 15:30:453 hours 30 minutes 45 seconds# same input, using brief output$ dtdiff -s 12:00:00 -e 15:30:453h30m45s# using AM/PM and not 24-hour times$ dtdiff -s"11:00AM" -e"11:00PM"12 hours# using ISO-8601 dates$ dtdiff -s 2024-06-07T08:00:00Z -e 2024-06-08T09:02:03Z1 day 1 hour 2 minutes 3 seconds# using timezone offset$ dtdiff -s 2024-06-07T08:00:00Z -e 2024-06-07T08:05:05-05:005 hours 5 minutes 5 seconds# using a format which includes spaces$ dtdiff -s"2024-06-07 08:01:02" -e"2024-06-07 08:02"58 seconds# using the built-in MacOS date program and do not include a newline character$ dtdiff -s"$(date -R)" -e"$(date -v+1M -v+30S)" -n1 minute 30 seconds%# using the cross-platform date program, ending time starting first$ dtdiff -s"$(date)" -e 2020-4 years 24 weeks 1 day 7 hours 21 minutes 53 seconds# same input, using brief output$ dtdiff -s"$(date)" -e 2020 -b-4Y24W1D7h21m53s# using microsecond formatting$ dtdiff -s 2024-06-07T08:00:00Z -e 2024-06-07T08:00:00.000123Z123 microseconds# using millisecond formatting, adding -b returns: 1m2s345ms$ dtdiff -s 2024-06-07T08:00:00Z -e 2024-06-07T08:01:02.345Z1 minute 2 seconds 345 milliseconds# read from STDIN in CSV format and do not include a newline character$ dtdiff -i -n15:16:15,15:1745 seconds%# same as above, include newline character$echo 15:16:15,15:17| dtdiff -i45 seconds# read from STDIN with start on first line and end on second line$printf"15:16:15\n15:17:20"| dtdiff -i1 minute 5 seconds# add time# can also use "years", "months", "weeks", "days"$ dtdiff -F 2024-01-01 -A"1 hour 30 minutes 45 seconds"2024-01-01 01:30:45 -0500 EST# subtract time# can also use "milliseconds", "microseconds"$ dtdiff -F"2024-01-02 01:02:03" -S"1 day 1 hour 2 minutes 3 seconds"2024-01-01 00:00:00 -0500 EST# output multiple occurrences: add 5 weeks, for 3 intervals$ dtdiff -F"2024-01-02" -A"5W" -R 32024-02-06 00:00:00 -0500 EST2024-03-12 00:00:00 -0400 EDT2024-04-16 00:00:00 -0400 EDT# repeat until a certain datetime is encountered: subtract 5 minutes until 15:00$ dtdiff -F 15:20 -S 5m -U 15:002024-06-30 15:15:00 -0400 EDT2024-06-30 15:10:00 -0400 EDT2024-06-30 15:05:00 -0400 EDT2024-06-30 15:00:00 -0400 EDT# use relative date until tomorrow$ dtdiff -F today -A 7h10m -U tomorrow2024-07-03 14:29:28 -0400 EDT2024-07-03 21:39:28 -0400 EDT2024-07-04 04:49:28 -0400 EDT# use relative start date with brief output$ dtdiff -s today -e 2024-07-07 -b3D16h38m47s
- carbon -https://github.com/golang-module/carbon/
- cobra -https://github.com/spf13/cobra
- durafmt -https://github.com/hako/durafmt
- now -https://github.com/jinzhu/now
This program is my own original idea and was completely developedon my own personal time, for my own personal benefit, and on mypersonally owned equipment.
About
Golang package and command line tool to return or output the difference between date, time or duration