wrap this up in a nice CPAN friendly wrapper?
Closed this issue · 16 comments
Would you allow me to wrap this up in a nice little wrapper so it can be released to CPAN? Maybe using Module::Starter?
Oh! Sure, I've just gotten lazy... Please feel free!
(though technically, I think you have full right to go ahead and do that anyways ;)
I've made some changes in this direction here: git@github.com:cfedde/perl-firmata.git
Anybody who is more familiar with CPAN than I am would like to finish this work?
I've never uploaded a module to CPAN, but I would love to see this on CPAN. It would make installing it much easier.
I think all that is left to do is bundle the files (.tar.gz) and upload to CPAN. You need to request a PAUSE account then you will be able to upload to CPAN (using PAUSE).
https://pause.perl.org/pause/authenquery?ACTION=request_id
I can upload the module, but it would be linked to my PAUSE account.
Norbert,
Do you have a PAUSE id or would you like me to add this module to my id?
I have a PAUSE id (requestet it for perl-firmata), but never took the time to actually check out how it works.
Is it really thus simple? I thought cpan involves starting a local build after download (even if it's trivial), but actually I never tried (yet...)
Yes, it is that simple. Create a tar.gz or zip file with the module name and version and put all the files that are in the MANIFEST file in the archive. The file structure looks like it is already compatible with CPAN, so it should just need tar'd and uploaded.
The name of the file you upload is VERY important.
I am hosting the Perl Hardware Hackathon at YAPC::NA starting June 22 It would be great to have this on CPAN before then. What can we do to help make that happen?
If you would be able to provide a tested Build.PL and Makefile.PL and maybe a check for the dependency (Device::SerialPort or Win32::SerialPort) as described in http://learnperl.scratchcomputing.com/tutorials/configuration I'd be glad to upload to CPAN. Don't forget to check the generation of documentation, as this is what will show up on CPAN.
Hello!
I've added dist.ini, so that this module can be uploaded on CPAN easily. I've tested it on my debian system & I'm able to install the module from the resulting tarball. Just check some of the attributes at the starting of dist.ini (author, copyright_holder & version).
This is the concerned pull request #21
Thanks.
Hi again. There are only 12 days until YAPC::NA and it would be great if we could get this pushed to CPAN before then. Feel free to join #hardware on irc.perl.org if we can help.
Thanks again for talking over the module and offering to push it to CPAN.
@Sweet-kid: thanks a lot for your contribution. I've just uploaded to cpan: https://metacpan.org/release/NTRUCHSES/Device-Firmata-0.56, hope everything is fine for you guys. Feedback is encouraged ;-)
@ntruchsess you're welcome & thanks for merging my pull request :).
I tried to install this module from CPAN, but it's not working, this is what I am getting : https://gist.github.com/Sweet-kid/53e732103ca3d38e7ddf#file-gistfile1-txt
I got the listing of the tarball (from CPAN) & tarball which I myself created by using dzil build, both have different listings, as you could see here : https://gist.github.com/Sweet-kid/53e732103ca3d38e7ddf (gistfile2.txt is your tarball & gistfile3.sh is mine).
This line is missing in your tarball : https://gist.github.com/Sweet-kid/53e732103ca3d38e7ddf#file-gistfile3-sh-L2
Also, there's no xt/*
Did you use dzil to release the module on the CPAN or did something else?
Also, it'd be better to clean up some files, like license.txt, README (since module will be on CPAN, then user can install it just by doing cpanm Device::Firmata), ignore.txt (I think MANIFEST.SKIP is doing this job), Makefiles (because dzil will create them if we'll use dzil MakeMaker plugin), I don't know what does t do, so can't say that it needs to be removed.
I'll try to submit a PR with all this later in the day.
Thanks.
I used tar command manually - actually I never released a CPAN-installable module before ;-)
Had a look into what Makefile.PL actually does and noticed that you can do a 'perl Makefile.PL -> make dist' to create the CPAN-ready tarball. I then fixed MANIFEST, removed Makefile etc... (see 9160638) and uploaded the newly generated version 0.57 tar to CPAN http://metacpan.org/release/NTRUCHSES/Device-Firmata-0.57. As I also applied for module-name Device::Firmata yesterday it should be included in the cpan-meta index soon. (It allready made it to the modules list: http://www.cpan.org/modules/by-category/05_Networking_Devices_IPC/Device/)
Hope this does better now ;-)
Thanks for replying! :) I think we don't need a dist.ini & MANIFEST.SKIP then :)
closing as resolved ;-)