Finally a first version of my Module! Questions...

[cosmicperl]

Hi All,
  I've finally got the first version of my module ready and working. Albeit only in version 0.05, and distinctly lacking in features, it works all the same!
I've got my PAUSE account setup, and have applied for the namespace. Now I just need to package the .pm file appropriately. At the moment I just have the working .pm file. Nothing else. It includes =head data, etc. But that's all I have. It doesn't use any C or XS. I know I need a README file, etc before I gzip it up and upload it.
Could someone please direct me to a good guide on packaging this for CPAN, so that I get it right and don't make any mistakes.

Lyle Hopkins

Update... I'd also like to ensure that this module is capable of being automatically included in ActiveStates ppm repository.

UPDATE: Thanks to all the replies. They have certainly put me on the right track, should have the module uploaded shortly.

[Joost]

You need a bit more than just the .pm and README files to create a CPAN package. I think the best place to start is to read perlnewmod.

It's probably easiest to create an "empty" source tree using h2xs and then copy the code from your .pm file into the template in the new tree (and fill in the documentation).

When you've done that, you can run the usual

perl Makefile.PL
make
make test
make dist

to create the distribution tarball.

Also, you don't need to register a namespace. You can if you want to, but it's not required.

[glasswalk3r]

Also, you don't need to register a namespace. You can if you want to, but it's not required.

And is not that simple to get a namespace. If memory does not fails me, a new namespace will not be create unless that is a fairy amount of modules (like 5) that do something closely related.

[eyepopslikeamosquito]

Some PM nodes on writing modules for the CPAN:

• How to make a CPAN Module Distribution
• Simple Module Tutorial
• José's Guide for creating Perl modules
• Writing Solid CPAN Modules
• Best Module Starter?

And some external references:

• Guide to Creating Perl Modules by Ken Williams
• Perl Module Mechanics by Steven McDougall
• Making Perl Reusable with Modules by Andy Sylvester
• Writing Perl Modules for CPAN, book by Sam Tregar (can be freely downloaded from a link on this page)
• Making New Distributions by brian d foy (using Template Toolkit)

Before releasing your CPAN module, choose a module name and design an interface based on the general references above and on your own ideas, then post it here or on the [e-mail] mailing list, requesting feedback. It is vital to focus on interface early because once your module is released, any change you make to its interface will break your existing user's code (by contrast, anything else can be easily fixed in later releases).

[lima1]

An alternative to h2xs is Module::Starter. Damian Conway created the nice template Module::Starter::PBP (but read the bugreports!).

[randyk]

Update... I'd also like to ensure that this module is capable of being automatically included in ActiveStates ppm repository.

ActiveState uses an automated system that will build ppm packages and place them in their repository if the package, and all of it's dependencies, build and test OK against the relevant base ActivePerl distribution. So as long as your package satisfies that, it should be automatically added to ActiveState's repository - this might take a week or so since it first appears on CPAN. If there's a problem with this, you can request one to be manually made and added to the uwinnipeg repository.

[glasswalk3r]

Update... I'd also like to ensure that this module is capable of being automatically included in ActiveStates ppm repository.

First of all you should create a PPM package. There is documentation about this included in the ActivePerl distribution (see "Using PPM").

Unfornatelly, I'm not aware about how to request a space in a PPM repository. :-(

[grinder]

I'm not aware about how to request a space in a PPM repository

In the general case, if Activestate are able to build the module, it will be made available as a PPM package, following the same namespace layout as CPAN.

On the rare occasion that the module is not available in the AS repository, Randy Kobes's unwinnipeg site usually has it available (see link elsewhere in the thread). The other repository that cover the bits and pieces left over is Trouchelle.

Basically, though, if it's pure-Perl, Activestate will carry it.