cpan::meta::yaml(3pm) [mojave man page]

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

NAME

       CPAN::Meta::YAML - Read and write a subset of YAML for CPAN Meta files

VERSION

       version 0.008

SYNOPSIS

	   use CPAN::Meta::YAML;

	   # reading a META file
	   open $fh, "<:utf8", "META.yml";
	   $yaml_text = do { local $/; <$fh> };
	   $yaml = CPAN::Meta::YAML->read_string($yaml_text)
	     or die CPAN::Meta::YAML->errstr;

	   # finding the metadata
	   $meta = $yaml->[0];

	   # writing a META file
	   $yaml_text = $yaml->write_string
	     or die CPAN::Meta::YAML->errstr;
	   open $fh, ">:utf8", "META.yml";
	   print $fh $yaml_text;

DESCRIPTION

       This module implements a subset of the YAML specification for use in reading and writing CPAN metadata files like META.yml and MYMETA.yml.
       It should not be used for any other general YAML parsing or generation task.

       NOTE: META.yml (and MYMETA.yml) files should be UTF-8 encoded.  Users are responsible for proper encoding and decoding.	In particular, the
       "read" and "write" methods do not support UTF-8 and should not be used.

SUPPORT

       This module is currently derived from YAML::Tiny by Adam Kennedy.  If there are bugs in how it parses a particular META.yml file, please
       file a bug report in the YAML::Tiny bugtracker: <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=YAML-Tiny>

SEE ALSO

       YAML::Tiny, YAML, YAML::XS

SUPPORT

   Bugs / Feature Requests
       Please report any bugs or feature requests through the issue tracker at <http://rt.cpan.org/Public/Dist/Display.html?Name=CPAN-Meta-YAML>.
       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.

       <https://github.com/dagolden/cpan-meta-yaml>

	 git clone https://github.com/dagolden/cpan-meta-yaml.git

AUTHORS

       o   Adam Kennedy <adamk@cpan.org>

       o   David Golden <dagolden@cpan.org>

COPYRIGHT AND LICENSE

       This software is copyright (c) 2010 by Adam Kennedy.

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

perl v5.18.2							    2014-01-06						     CPAN::Meta::YAML(3pm)

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)