NAME

    Alien::Plotly::Orca - Finds or installs plotly-orca

VERSION

    version 0.0000_02

SYNOPSIS

        use Alien::Plotly::Orca;
        use Config;
    
        if (Alien::Plotly::Orca->install_type eq 'share') {
            $ENV{PATH} = join(
                $Config{path_sep},
                Alien::Plotly::Orca->bin_dir,
                $ENV{PATH}
            );
    
            # get version
            my $version = Alien::Plotly::Orca->version;
        }
    
        # If install_type is not 'share' then it means plotly-orca
        # was detected from PATH when Alien::Plotly::Orca was installed.
        # So in either case now you should be able to do,
        print `orca -h`;

DESCRIPTION

    This module finds plotly-orca <https://github.com/plotly/orca> or
    installs it.

    For installation it uses prebuilt packages and would supports 3 OS
    platforms: Windows, Linux and OSX. For Windows and OSX it would get
    package from Anaconda's plotly repo. For Linux it would get the
    AppImage file from plotly-orca's github release page.

CAVEATS

    On Linux plotly-orca requires X service. If your host is headless you
    mostly need xvfb <https://en.wikipedia.org/wiki/Xvfb>, either ran as a
    service, or ran as a wrapper every time like xvfb-run orca ....

    For Mac OSX I can't really test it as I don't have such a system at
    hand. Travis CI does not seem to support Perl for OSX...

SEE ALSO

    Alien, Chart::Plotly

    https://github.com/plotly/orca

AUTHOR

    Stephan Loyd <sloyd@cpan.org>

COPYRIGHT AND LICENSE

    This software is copyright (c) 2019 by Stephan Loyd.

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

