hythm7/pakku-spec

NAME

Pakku::Spec - Dependency Specification for Pakku Package Manager.

SYNOPSIS

use Pakku::Spec;

my $spec = Pakku::Spec.new: 'ModuleName:ver(0.0.1):auth<Camelia <[email protected]>>:api<>';

say $spec.spec;
# {api => , auth => Camelia <[email protected]>, from => raku, name => ModuleName, ver => 0.0.1}


$spec = Pakku::Spec.new: {:hints(${"by-kernel.name" => ${:linux(${:checksum(${"sha-256" => "E6836E32802555593AEDAFE1CC00752CBDA"}), :target("resources/libraries/"), :url("http://raku.org/")})}}), :name("archive:from<native>")};

say $spec.spec;
# {from => native, name => archive}

say $spec.hints;

# Pakku::Spec::Hints.new(url => "http://raku.org/", target => "resources/libraries/", checksum => Pakku::Spec::Hints::Checksum.new(type => "sha-256", hash => "E6836E32802555593AEDAFE1CC00752CBDA"), source => Pakku::Spec::Hints::Source)

DESCRIPTION

Pakku::Spec is a Dependency Specification used by Pakku.

Pakku::Spec parses the dependencies specified by Raku distributions as string like My::Dependency:ver<0.0.1+> or hash like { :name<MyLib>,:from<native> }. also parses the hints section if provided in a dependency to provide for example the correct name based on $*DISTRO or $*KERNEL

Pakku::Spec is mainly used by Pakku::Meta to parse the depends section in META6.json files.

INSTALLATION

pakku add Pakku::Spec

# or 

zef install Pakku::Spec

AUTHOR

Haytham Elganiny [email protected]

COPYRIGHT AND LICENSE

Copyright 2020 Haytham Elganiny

This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.

pakku-spec's Issues

Please improve documentation

It's really difficult to know, by just looking at this README, what the distribution is about. Just a link to the Pakku repo or web site would help, for instance, but additionally, some simple use case would also be helpful.