App-DesktopNotifyUtils

 view release on metacpan or  search on metacpan

MANIFEST  view on Meta::CPAN

# This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.031.
Changes
LICENSE
MANIFEST
META.json
META.yml
Makefile.PL
README
dist.ini
lib/App/DesktopNotifyUtils.pm
script/notify-desktop
t/00-compile.t
t/author-critic.t
t/author-pod-coverage.t
t/author-pod-syntax.t
t/release-rinci.t
weaver.ini

META.json  view on Meta::CPAN

      }
   },
   "version" : "0.001",
   "x_Dist_Zilla" : {
      "perl" : {
         "version" : "5.038002"
      },
      "plugins" : [
         {
            "class" : "Dist::Zilla::Plugin::GenPericmdScript",
            "name" : "GenPericmdScript notify-desktop",
            "version" : "0.425"
         },
         {
            "class" : "Dist::Zilla::Plugin::PERLANCAR::CheckPendingRelease",
            "name" : "@Author::PERLANCAR/PERLANCAR::CheckPendingRelease",
            "version" : "0.001"
         },
         {
            "class" : "Dist::Zilla::Plugin::GatherDir",
            "config" : {

META.yml  view on Meta::CPAN

  bugtracker: https://rt.cpan.org/Public/Dist/Display.html?Name=App-DesktopNotifyUtils
  homepage: https://metacpan.org/release/App-DesktopNotifyUtils
  repository: git://github.com/perlancar/perl-App-DesktopNotifyUtils.git
version: '0.001'
x_Dist_Zilla:
  perl:
    version: '5.038002'
  plugins:
    -
      class: Dist::Zilla::Plugin::GenPericmdScript
      name: 'GenPericmdScript notify-desktop'
      version: '0.425'
    -
      class: Dist::Zilla::Plugin::PERLANCAR::CheckPendingRelease
      name: '@Author::PERLANCAR/PERLANCAR::CheckPendingRelease'
      version: '0.001'
    -
      class: Dist::Zilla::Plugin::GatherDir
      config:
        Dist::Zilla::Plugin::GatherDir:
          exclude_filename: []

Makefile.PL  view on Meta::CPAN

use ExtUtils::MakeMaker;

my %WriteMakefileArgs = (
  "ABSTRACT" => "Utilities related to Desktop::Notify",
  "AUTHOR" => "perlancar <perlancar\@cpan.org>",
  "CONFIGURE_REQUIRES" => {
    "ExtUtils::MakeMaker" => 0
  },
  "DISTNAME" => "App-DesktopNotifyUtils",
  "EXE_FILES" => [
    "script/notify-desktop"
  ],
  "LICENSE" => "perl",
  "MIN_PERL_VERSION" => "5.010001",
  "NAME" => "App::DesktopNotifyUtils",
  "PREREQ_PM" => {
    "Data::Sah::Compiler::perl::TH::int" => "0.914",
    "Data::Sah::Compiler::perl::TH::str" => "0.914",
    "Desktop::Notify" => 0,
    "Log::ger" => "0.038",
    "Perinci::CmdLine::Any" => "0.154",

README  view on Meta::CPAN

    This document describes version 0.001 of App::DesktopNotifyUtils (from
    Perl distribution App-DesktopNotifyUtils), released on 2024-08-30.

SYNOPSIS
DESCRIPTION
    This distribution includes several utilities:

    #INSERT_EXECS_LIST

FUNCTIONS
  notify_desktop
    Usage:

     notify_desktop(%args) -> [$status_code, $reason, $payload, \%result_meta]

    Show a notification on your desktop.

    Currently a very simple interface to Desktop::Notify. Will offer more
    options in the future.

    This function is not exported.

    Arguments ('*' denotes required arguments):

    *   body => *str*

dist.ini  view on Meta::CPAN

;---------------------------------
author  = perlancar <perlancar@cpan.org>
copyright_holder = perlancar <perlancar@cpan.org>
license = Perl_5
;---------------------------------

version=0.001

name=App-DesktopNotifyUtils

[GenPericmdScript / GenPericmdScript notify-desktop]
url=/App/DesktopNotifyUtils/notify_desktop
enable_log=1
read_config=0
read_env=0

[@Author::PERLANCAR]
:version=0.610

[Prereqs]
perl=5.010001
strict=0

lib/App/DesktopNotifyUtils.pm  view on Meta::CPAN

use warnings;
use Log::ger;

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2024-08-30'; # DATE
our $DIST = 'App-DesktopNotifyUtils'; # DIST
our $VERSION = '0.001'; # VERSION

our %SPEC;

$SPEC{notify_desktop} = {
    v => 1.1,
    summary => 'Show a notification on your desktop',
    description => <<'MARKDOWN',

Currently a very simple interface to <pm:Desktop::Notify>. Will offer more
options in the future.

MARKDOWN
    args => {
        summary => {
            schema => 'str*',
            req => 1,

lib/App/DesktopNotifyUtils.pm  view on Meta::CPAN

            schema => 'str*',
            pos => 1,
        },
        timeout => {
            summary => 'Timeout, in ms',
            schema => 'uint*',
            default => 5000,
        },
    },
};
sub notify_desktop {
    require Desktop::Notify;

    my %args = @_;
    my $notify = Desktop::Notify->new;

    my $notification = $notify->create(
        summary => $args{summary},
        body => $args{body},
        timeout => $args{timeout} // 5000,
    );

lib/App/DesktopNotifyUtils.pm  view on Meta::CPAN


=head1 DESCRIPTION

This distribution includes several utilities:

#INSERT_EXECS_LIST

=head1 FUNCTIONS


=head2 notify_desktop

Usage:

 notify_desktop(%args) -> [$status_code, $reason, $payload, \%result_meta]

Show a notification on your desktop.

Currently a very simple interface to L<Desktop::Notify>. Will offer more
options in the future.

This function is not exported.

Arguments ('*' denotes required arguments):

=over 4

script/notify-desktop  view on Meta::CPAN

#!perl

# Note: This script is a CLI for Riap function /App/DesktopNotifyUtils/notify_desktop
# and generated automatically using Perinci::CmdLine::Gen version 0.502

use 5.010001;
use strict;
use warnings;
use Log::ger;

use Perinci::CmdLine::Any;

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2024-08-30'; # DATE
our $DIST = 'App-DesktopNotifyUtils'; # DIST
our $VERSION = '0.001'; # VERSION

my $cmdline = Perinci::CmdLine::Any->new(
    url => "/App/DesktopNotifyUtils/notify_desktop",
    program_name => "notify-desktop",
    log => 1,
    read_config => 0,
    read_env => 0,
);

$cmdline->run;

# ABSTRACT: Show a notification on your desktop
# PODNAME: notify-desktop

__END__

=pod

=encoding UTF-8

=head1 NAME

notify-desktop - Show a notification on your desktop

=head1 VERSION

This document describes version 0.001 of notify-desktop (from Perl distribution App-DesktopNotifyUtils), released on 2024-08-30.

=head1 SYNOPSIS

B<notify-desktop> B<L<--help|/"--help, -h, -?">> (or B<L<-h|/"--help, -h, -?">>, B<L<-?|/"--help, -h, -?">>)

B<notify-desktop> B<L<--version|/"--version, -v">> (or B<L<-v|/"--version, -v">>)

B<notify-desktop> [B<L<--debug|/"--debug">>|B<L<--log-level|/"--log-level=s">>=I<level>|B<L<--quiet|/"--quiet">>|B<L<--trace|/"--trace">>|B<L<--verbose|/"--verbose">>] [B<L<--format|/"--format=s">>=I<name>|B<L<--json|/"--json">>] [B<L<--(no)naked-res...

=head1 DESCRIPTION

Currently a very simple interface to L<Desktop::Notify>. Will offer more
options in the future.

=head1 OPTIONS

C<*> marks required options.

script/notify-desktop  view on Meta::CPAN


=head1 COMPLETION

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

=head2 bash

To activate bash completion for this script, put:

 complete -C notify-desktop notify-desktop

in your bash startup (e.g. F<~/.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 L<cpanm-shcompgen>
which can activate shell completion for scripts immediately.

=head2 tcsh

To activate tcsh completion for this script, put:

 complete notify-desktop 'p/*/`notify-desktop`/'

in your tcsh startup (e.g. F<~/.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 L<shcompgen> (see above).

=head2 other shells

For fish and zsh, install L<shcompgen> as described above.

t/00-compile.t  view on Meta::CPAN


use Test::More;

plan tests => 2 + ($ENV{AUTHOR_TESTING} ? 1 : 0);

my @module_files = (
    'App/DesktopNotifyUtils.pm'
);

my @scripts = (
    'script/notify-desktop'
);

# no fake home requested

my @switches = (
    -d 'blib' ? '-Mblib' : '-Ilib',
);

use File::Spec;
use IPC::Open3;

t/author-critic.t  view on Meta::CPAN

}


use strict;
use warnings;

# this test was generated with Dist::Zilla::Plugin::Test::Perl::Critic::Subset 3.001.006

use Test::Perl::Critic (-profile => "") x!! -e "";

my $filenames = ['lib/App/DesktopNotifyUtils.pm','script/notify-desktop'];
unless ($filenames && @$filenames) {
    $filenames = -d "blib" ? ["blib"] : ["lib"];
}

all_critic_ok(@$filenames);



( run in 0.911 second using v1.01-cache-2.11-cpan-299005ec8e3 )