Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/briandfoy/object-iterate

Make Perl objects iterable as in Python
https://github.com/briandfoy/object-iterate

perl perl-module

Last synced: about 1 month ago
JSON representation

Make Perl objects iterable as in Python

Host: GitHub
URL: https://github.com/briandfoy/object-iterate
Owner: briandfoy
License: other
Created: 2009-11-23T07:05:21.000Z (about 15 years ago)
Default Branch: master
Last Pushed: 2024-04-11T16:54:23.000Z (9 months ago)
Last Synced: 2024-06-18T21:48:21.574Z (6 months ago)
Topics: perl, perl-module
Language: Perl
Homepage: https://metacpan.org/pod/Object::Iterate
Size: 199 KB
Stars: 5
Watchers: 4
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.pod
- Changelog: Changes
- License: LICENSE

Awesome Lists containing this project

README

=pod

=encoding utf8

=for HTML

=head1 The Object::Iterate module

This is the I for the L Perl module. You're
probably looking at this because you don't know where else to find
what you're looking for. Read this once and you might never have to
read one again for any Perl module.

I wrote this while playing with ways to visit all the parts of an
object's data structure. It's more of a demonstration than something I
expect you to use. Steal the code and inline it.

=head2 Documentation

To read about L, look at the embedded documentation
in the module itself. Inside the distribution, you can format it
with L:

% perl Makefile.PL
% make
% perldoc lib/Object/Iterate.pm

If you have already installed the module, you can specify the module
name instead of the file location:

% perldoc Object::Iterate

You can read the documentation and inspect the meta data at
L.

The standard module documentation has example uses in the SYNOPSIS
section, but you can also look in the I directory (if it's
there), or look at the test files in I.

=head2 Installation

You can install this module with a CPAN client, which will resolve
and install the dependencies:

% cpan Object::Iterate
% cpanm Object::Iterate

You can also install directly from the distribution directory, which
will also install the dependencies:

% cpan .
% cpanm .

You could install just this module manually:

% perl Makefile.PL
% make
% make test
% make install

You probably don't want to do that unless you're fiddling with the
module and only want to run the tests without installing anything.

=head2 Source location

The meta data, such as the source repository and bug tracker, is in
I or the I files it creates. You can find that on
those CPAN web interfaces, but you can also look at files directly in
the source repository:

=over 4

=item * L

=back

If you find a problem, file a ticket in the L:

=over 4

=item * L

=back

=head2 Getting help

Although I'm happy to hear from module users in private email,
that's the best way for me to forget to do something.

Besides the issue trackers, you can find help at
L or
L, both of which have many
competent Perlers who can answer your question, almost in real time.
They might not know the particulars of this module, but they can help
you diagnose your problem.