NAME

dateseq - Generate a sequence of dates

VERSION

This document describes version 0.112 of dateseq (from Perl distribution App-dateseq), released on 2022-10-12.

SYNOPSIS

dateseq [--business|--no-business|--nobusiness] [--business6|--no-business6|--nobusiness6] [--eval=str|-e=str] [(--exclude-dow=date::dow_nums)+|--exclude-dow-json=json] [(--exclude-month=date::month_nums)+|--exclude-month-json=json] [--format-class-attrs=s|--format-class-attrs-json=json] [--format-class=perl::modname] [--format=name|--json] [--header=str] [(--include-dow=date::dow_nums)+|--include-dow-json=json] [(--include-month=date::month_nums)+|--include-month-json=json] [--limit-monthly=posint] [--limit-yearly=posint] [--limit=posint|-n=posint] [--(no)naked-res] [--page-result[=program]|--view-result[=program]] [--random] [--reverse|-r] [--strftime=str|-f=str] -- [from] [to] [increment]

See examples in the "EXAMPLES" section.

DESCRIPTION

This utility is similar to Unix seq command, except that it generates a sequence of dates.

OPTIONS

* marks required options.

Main options

--from=s

Starting date.

Can also be specified as the 1st command-line argument.

--header=s

Add a header row.

--increment=s, -i

Can also be specified as the 3rd command-line argument.

--limit-monthly=s

Only output at most this number of dates for each month.

--limit-yearly=s

Only output at most this number of dates for each year.

--limit=s, -n

Only generate a certain amount of dates.

--random

Instead of incrementing/decrementing monotonically, generate random date between --to and --from.

If you specify this, you have to specify --to and --from.

Also, currently, if you also specify --limit-yearly or --limit-monthly, the script may hang because it runs out of dates, so be careful when specifying these options combined.

--reverse, -r

Decrement instead of increment.

--to=s

End date, if not specified will generate an infinite* stream of dates.

Can also be specified as the 2nd command-line argument.

Filtering options

--business

Only list business days (Mon-Fri), or non-business days.

--business6

Only list business days (Mon-Sat), or non-business days.

--exclude-dow-json=s

Do not show dates with these day-of-weeks (JSON-encoded).

See --exclude-dow.

--exclude-dow=s@

Do not show dates with these day-of-weeks.

Can be specified multiple times.

--exclude-month-json=s

Do not show dates with these month numbers (JSON-encoded).

See --exclude-month.

--exclude-month=s@

Do not show dates with these month numbers.

Can be specified multiple times.

--include-dow-json=s

Only show dates with these day-of-weeks (JSON-encoded).

See --include-dow.

--include-dow=s@

Only show dates with these day-of-weeks.

Can be specified multiple times.

--include-month-json=s

Only show dates with these month numbers (JSON-encoded).

See --include-month.

--include-month=s@

Only show dates with these month numbers.

Can be specified multiple times.

Formatting options

--format-class-attrs-json=s

Arguments to pass to constructor of DateTime::Format::* class (JSON-encoded).

See --format-class-attrs.

--format-class-attrs=s

Arguments to pass to constructor of DateTime::Format::* class.

--format-class=s

Use a DateTime::Format::* class for formatting.

By default, DateTime::Format::Strptime is used with pattern set from the <strftime> option.

--strftime=s, -f

strftime() format for each date.

Default is %Y-%m-%d, unless when hour/minute/second is specified, then it is %Y-%m-%dT%H:%M:%S.

dateseq actually uses DateTimeX::strftimeq, so you can embed Perl code for flexibility. For example:

% dateseq 2019-11-19 2019-11-25 -f '%Y-%m-%d%( $_->day_of_week == 7 ? "su" : "" )q'

will print something like:

2019-11-19
2019-11-20
2019-11-21
2019-11-22
2019-11-23
2019-11-24su
2019-11-25

Output options

--eval=s, -e

Run perl code for each date.

Specified perl code will receive the date as DateTime object in $_and expected to return result to print.

--format=s

Choose output format, e.g. json, text.

Default value:

undef

Output can be displayed in multiple formats, and a suitable default format is chosen depending on the application and/or whether output destination is interactive terminal (i.e. whether output is piped). This option specifically chooses an output format.

--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

[200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use --naked-res so you just get:

[1,2,3]

--page-result

Filter output through a pager.

This option will pipe the output to a specified pager program. If pager program is not specified, a suitable default e.g. less is chosen.

--view-result

View output using a viewer.

This option will first save the output to a temporary file, then open a viewer program to view the temporary file. If a viewer program is not chosen, a suitable default, e.g. the browser, is chosen.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C dateseq dateseq

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

complete dateseq 'p/*/`dateseq`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

EXAMPLES

Generate "infinite" dates from today

% dateseq

Generate dates from 2015-01-01 to 2015-01-31

% dateseq 2015-01-01 2015-01-31
2015-01-01
2015-01-02
... 27 more lines ...
2015-01-30
2015-01-31

Generate dates from yesterday to 2 weeks from now

% dateseq yesterday "2 weeks from now"
2022-10-11T00:00:00
2022-10-12T00:00:00
... 12 more lines ...
2022-10-25T00:00:00
2022-10-26T00:00:00

Generate dates from 2015-01-31 to 2015-01-01 (reverse)

% dateseq 2015-01-31 2015-01-01 -r
2015-01-31
2015-01-30
... 27 more lines ...
2015-01-02
2015-01-01

Generate "infinite" dates from 2015-01-01 (reverse)

% dateseq 2015-01-01 -r

Generate 10 dates from 2015-01-01

% dateseq 2015-01-01 -n 10
2015-01-01
2015-01-02
... 6 more lines ...
2015-01-09
2015-01-10

Generate dates with increment of 3 days

% dateseq 2015-01-01 2015-01-31 -i P3D
2015-01-01
2015-01-04
... 7 more lines ...
2015-01-28
2015-01-31

Generate first 20 business days (Mon-Fri) after 2015-01-01

% dateseq 2015-01-01 --business -n 20 -f "%Y-%m-%d(%a)"
2015-01-01(Thu)
2015-01-02(Fri)
2015-01-05(Mon)
2015-01-06(Tue)
2015-01-07(Wed)
... 11 more lines ...
2015-01-23(Fri)
2015-01-26(Mon)
2015-01-27(Tue)
2015-01-28(Wed)

Generate first 5 non-business days (Sat-Sun) after 2015-01-01

% dateseq 2015-01-01 --no-business -n 5
2015-01-03
2015-01-04
2015-01-10
2015-01-11
2015-01-17

Show the first business day (Mon-Fri) of each month in 2021

% dateseq 2021-01-01 2021-12-13 --business --limit-monthly 1 -f "%Y-%m-%d(%a)"
2021-01-01(Fri)
2021-02-01(Mon)
2021-03-01(Mon)
2021-04-01(Thu)
2021-05-03(Mon)
... 3 more lines ...
2021-09-01(Wed)
2021-10-01(Fri)
2021-11-01(Mon)
2021-12-01(Wed)

Show the last business day (Mon-Fri) of each month in 2021

% dateseq 2021-12-31 2021-01-01 -r --business --limit-monthly 1 -f "%Y-%m-%d(%a)"
2021-12-31(Fri)
2021-11-30(Tue)
2021-10-29(Fri)
2021-09-30(Thu)
2021-08-31(Tue)
... 3 more lines ...
2021-04-30(Fri)
2021-03-31(Wed)
2021-02-26(Fri)
2021-01-29(Fri)

Show Mondays, Wednesdays, and Fridays between 2015-01-01 and 2015-02-28

% dateseq 2015-01-01 2015-02-28 --include-dow Mo,We,Fr -f "%Y-%m-%d(%a)"

Show dates (except Mondays) after 2015-01-01 and 2015-02-28

% dateseq 2015-01-01 2015-02-28 --exclude-dow Mo -f "%Y-%m-%d(%a)"

Generate a CSV data

% dateseq 2010-01-01 2015-01-31 -f "%Y,%m,%d" --header "year,month,day"
year,month,day
2010,01,01
... 1854 more lines ...
2015,01,30
2015,01,31

Generate periods (YYYY-MM)

% dateseq 2010-01-01 2015-12-31 -i P1M -f "%Y-%m"
2010-01
2010-02
... 68 more lines ...
2015-11
2015-12

List non-holidays in 2015 (using Indonesian holidays)

% setop --diff <(dateseq 2015-01-01 2015-12-31) <(list-idn-holidays --year 2015)
2015-01-02
2015-01-04
2015-01-05
2015-01-06
2015-01-07
... 336 more lines ...
2015-12-28
2015-12-29
2015-12-30
2015-12-31

See also dateseq-idn as alternative.

List non-holidays business days in 2015 (using Indonesian holidays)

% setop --diff <(dateseq 2015-01-01 2015-12-31 --business) <(list-idn-holidays --year 2015)
2015-01-02
2015-01-05
2015-01-06
2015-01-07
2015-01-08
... 236 more lines ...
2015-12-28
2015-12-29
2015-12-30
2015-12-31

See also dateseq-idn as alternative.

Use with fsql

% dateseq 2010-01-01 2015-12-01 -f "%Y,%m" -i P1M --header "year,month" | fsql --add-csv - --add-csv data.csv -F YEAR -F MONTH 'SELECT year, month, data1 FROM stdin WHERE YEAR(data.date)=year AND MONTH(data.date)=month'

Use %q (see DateTimeX::strftimeq)

% dateseq 2020-12-24 2021-01-15 -f '%Y-%m-%d%( $_->day_of_week == 7 ? "su" : "" )q'
2020-12-24
2020-12-25
2020-12-26
2020-12-27su
2020-12-28
... 14 more lines ...
2021-01-12
2021-01-13
2021-01-14
2021-01-15

Print first and last days of each month of 2021

% dateseq 2021-01-01 2021-12-01 --increment '1 month' -e 'my $dt2 = $_->clone; $dt2->add(months=>1); $dt2->add(days => -1); $_->ymd . " " . $dt2->ymd'
2021-01-01 2021-01-31
2021-02-01 2021-02-28
2021-03-01 2021-03-31
2021-04-01 2021-04-30
2021-05-01 2021-05-31
... 3 more lines ...
2021-09-01 2021-09-30
2021-10-01 2021-10-31
2021-11-01 2021-11-30
2021-12-01 2021-12-31

Retrieve MetaCPAN releases data for 2020, saved in monthly JSON files

% dateseq 2020-01-01 2020-12-01 --increment '1 month' -e 'my $dt2 = $_->clone; $dt2->add(months=>1); $dt2->add(days => -1); sprintf "list-metacpan-releases --from-date %sT00:00:00 --to-date %sT23:59:59 --json > %04d%02d.json", $_->ymd, $dt2->ymd, $_->year, $_->month' | bash

Generate 100 random dates between a certain range

% dateseq --random --from "1 year ago" --to "1 year from now" --limit 100
2022-09-08T14:55:06
2022-03-20T12:07:01
... 96 more lines ...
2022-01-02T07:23:33
2022-12-31T03:43:00

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-dateseq.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-dateseq.

SEE ALSO

durseq. Produce sequence of date durations.

dateseq-idn. A wrapper for dateseq, with built-in support for Indonesian holidays.

seq.

seq-pl. Perl variant of seq.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2022, 2021, 2020, 2019, 2016, 2015 by perlancar <perlancar@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-dateseq

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

cpanm App::dateseq

perl -MCPAN -e shell
install App::dateseq