Manual

Reference

Modules

  • A • B • C • D • E
  • F • G • H • I • L
  • M • N • O • P • S
  • T • U • X

Tools

Parse::CPAN::Meta

Perl 5 version 10.1 documentation
Go to top
Show page index • Show recent pages
Recently read

Parse::CPAN::Meta

NAME

Parse::CPAN::Meta - Parse META.yml and other similar CPAN metadata files

SYNOPSIS

  1.     #############################################
  2.     # In your file
  3.     
  4.     ---
  5.     rootproperty: blah
  6.     section:
  7.       one: two
  8.       three: four
  9.       Foo: Bar
  10.       empty: ~
  11.     
  12.     
  13.     
  14.     #############################################
  15.     # In your program
  16.     
  17.     use Parse::CPAN::Meta;
  18.     
  19.     # Create a YAML file
  20.     my @yaml = Parse::CPAN::Meta::LoadFile( 'Meta.yml' );
  21.     
  22.     # Reading properties
  23.     my $root = $yaml[0]->{rootproperty};
  24.     my $one  = $yaml[0]->{section}->{one};
  25.     my $Foo  = $yaml[0]->{section}->{Foo};

DESCRIPTION

Parse::CPAN::Meta is a parser for META.yml files, based on the parser half of YAML::Tiny.

It supports a basic subset of the full YAML specification, enough to implement parsing of typical META.yml files, and other similarly simple YAML files.

If you need something with more power, move up to a full YAML parser such as YAML, YAML::Syck or YAML::LibYAML.

Parse::CPAN::Meta provides a very simply API of only two functions, based on the YAML functions of the same name. Wherever possible, identical calling semantics are used.

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

FUNCTIONS

For maintenance clarity, no functions are exported.

Load

  1.   my @yaml = Load( $string );

Parses a string containing a valid YAML stream into a list of Perl data structures.

LoadFile

  1.   my @yaml = LoadFile( 'META.yml' );

Reads the YAML stream from a file instead of a string.

SUPPORT

Bugs should be reported via the CPAN bug tracker at

http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Parse-CPAN-Meta

AUTHOR

Adam Kennedy <adamk@cpan.org>

SEE ALSO

YAML, YAML::Syck, Config::Tiny, CSS::Tiny, http://use.perl.org/~Alias/journal/29427, http://ali.as/

COPYRIGHT

Copyright 2006 - 2009 Adam Kennedy.

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

The full text of the license can be found in the LICENSE file included with this module.

Page index