Parse::CPAN::Meta(3pm)					 Perl Programmers Reference Guide				    Parse::CPAN::Meta(3pm)

NAME

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

SYNOPSIS

	   #############################################
	   # In your file

	   ---
	   rootproperty: blah
	   section:
	     one: two
	     three: four
	     Foo: Bar
	     empty: ~

	   #############################################
	   # In your program

	   use Parse::CPAN::Meta;

	   # Create a YAML file
	   my @yaml = Parse::CPAN::Meta::LoadFile( 'Meta.yml' );

	   # Reading properties
	   my $root = $yaml[0]->{rootproperty};
	   my $one  = $yaml[0]->{section}->{one};
	   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
	 my @yaml = Load( $string );

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

   LoadFile
	 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 <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.

perl v5.12.1							    2010-04-26						    Parse::CPAN::Meta(3pm)