Parse::CPAN::Meta (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Parse::CPAN::Meta.3perl".)

NAME

Parse::CPAN::Meta - Parse META.yml and META.json CPAN metadata files

VERSION

version 1.4414

SYNOPSIS

    #############################################
    # In your file
    
    ---
    name: My-Distribution
    version: 1.23
    resources:
      homepage: "http://example.com/dist/My-Distribution"
    
    
    #############################################
    # In your program
    
    use Parse::CPAN::Meta;
    
    my $distmeta = Parse::CPAN::Meta->load_file('META.yml');
    
    # Reading properties
    my $name     = $distmeta->{name};
    my $version  = $distmeta->{version};
    my $homepage = $distmeta->{resources}{homepage};

DESCRIPTION

Parse::CPAN::Meta is a parser for .json and .yml files, using and/or CPAN::Meta::YAML.

Parse::CPAN::Meta provides three methods: "load_file", "load_json_string", and "load_yaml_string". These will read and deserialize

metafiles, and are described below in detail.

Parse::CPAN::Meta provides a legacy

of only two functions, based on the functions of the same name. Wherever possible, identical calling semantics are used. These may only be used with sources.

All error reporting is done with exceptions (die'ing).

Note that

files are expected to be in encoding, only. When converted string data, it must first be decoded from

METHODS

load_file

  my $metadata_structure = Parse::CPAN::Meta->load_file('META.json');

  my $metadata_structure = Parse::CPAN::Meta->load_file('META.yml');

This method will read the named file and deserialize it to a data structure, determining whether it should be

or based on the filename. The file will be read using the ``:utf8'' layer.

load_yaml_string

  my $metadata_structure = Parse::CPAN::Meta->load_yaml_string($yaml_string);

This method deserializes the given string of

and returns the first document in it. ( metadata files should always have only one document.) If the source was encoded, the string must be decoded before calling "load_yaml_string".

load_json_string

  my $metadata_structure = Parse::CPAN::Meta->load_json_string($json_string);

This method deserializes the given string of

and the result. If the source was encoded, the string must be decoded before calling "load_json_string".

load_string

  my $metadata_structure = Parse::CPAN::Meta->load_string($some_string);

If you don't know whether a string contains

or data, this method will use some heuristics and guess. If it can't tell, it assumes

yaml_backend

  my $backend = Parse::CPAN::Meta->yaml_backend;

Returns the module name of the

serializer. See `` for details.

json_backend

  my $backend = Parse::CPAN::Meta->json_backend;

Returns the module name of the

serializer. This will either be or . Even if "PERL_JSON_BACKEND" is set, this will return as further delegation is handled by the module. See `` for details.

FUNCTIONS

For maintenance clarity, no functions are exported by default. These functions are available for backwards compatibility only and are best avoided in favor of "load_file".

Load

  my @yaml = Parse::CPAN::Meta::Load( $string );

Parses a string containing a valid

stream into a list of Perl data structures.

LoadFile

  my @yaml = Parse::CPAN::Meta::LoadFile( 'META.yml' );

Reads the

stream from a file instead of a string.

ENVIRONMENT

PERL_JSON_BACKEND

By default, will be used for deserializing data. If the "PERL_JSON_BACKEND" environment variable exists, is true and is not `` then the module (version 2.5 or greater) will be loaded and used to interpret "PERL_JSON_BACKEND". If is not installed or is too old, an exception will be thrown.

PERL_YAML_BACKEND

By default, CPAN::Meta::YAML will be used for deserializing data. If the "PERL_YAML_BACKEND" environment variable is defined, then it is interpreted as a module to use for deserialization. The given module must be installed, must load correctly and must implement the "Load()" function or an exception will be thrown.

SUPPORT

Bugs / Feature Requests

Please report any bugs or feature requests through the issue tracker at <rt.cpan.org/Public/Dist/Display.html?Name=Parse-CPAN-Meta>. You will be notified automatically of any progress on your issue.

Source Code

This is open source software. The code repository is available for public review and contribution under the terms of the license.

<github.com/Perl-Toolchain-Gang/Parse-CPAN-Meta>

  git clone github.com/Perl-Toolchain-Gang/Parse-CPAN-Meta.git

AUTHORS

*

Adam Kennedy <adamk@cpan.org>

*

David Golden <dagolden@cpan.org>

CONTRIBUTORS

*

Graham Knop <haarg@haarg.org>

*

Joshua ben Jore <jjore@cpan.org>

*

Neil Bowers <neil@bowers.com>

*

Ricardo Signes <rjbs@cpan.org>

*

Steffen Mueller <smueller@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Adam Kennedy and Contributors.

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