CPAN::...Package(3pm)

💖 CPAN::Common::Index::LocalPackage 💖

okay so bestie, welcome to CPAN::Common::Index::LocalPackage — that's the manual page you just pulled up (the header calls it CPAN::...Package(3pm), but you and me both know who the real main character is here 🎀). It's a Perl module, it lives in the CPAN::Common::Index family, and it does exactly one thing and does it gorgeously: it searches a local index file for packages. Local file, no internet, no drama. 💅

---

✨ VERSION ✨

version 0.010 — she's little, she's iconic, she's been around. 🦋

---

🌸 SYNOPSIS 🌸

here's the whole vibe, copy-paste ready:

use CPAN::Common::Index::LocalPackage;

$index = CPAN::Common::Index::LocalPackage->new(
  { source => "mypackages.details.txt" }
);

literally that's it. use it, new it, pass it a source, and she's up. no cap. 🔥

---

💜 DESCRIPTION 💜

so what's the tea? 🍓

This module implements a CPAN::Common::Index that searches for packages in a local index file — and the file has to be in the same form as the CPAN 02packages.details.txt file. same shape, same format, just sitting on your own machine being cozy.

and here's the important part, bestie, listen up: there is no support for searching on authors. 🙈 authors? not in this house. not this module. she does packages, that's her whole personality. don't come asking her about authors, she will simply not.

---

🌈 ATTRIBUTES 🌈

⭐ source (REQUIRED) ⭐

Path to a local file in the form of 02packages.details.txt.

and guess what — she's flexible 💖 it may be compressed with a .gz suffix, or it may be uncompressed. either way, she eats. 👑

this one is REQUIRED, bestie. you cannot skip it. she needs her file. give her the file.

---

🫶 cache 🫶

Path to a local directory to store a (possibly uncompressed) copy of the source index.

and if you don't specify one? Defaults to a temporary directory if not specified. she'll find somewhere to crash, don't worry about her. 😌✨

---

🧚 AUTHOR 🧚

David Golden <dagolden@cpan.org> — thank you for your service, king 👑

---

💀 COPYRIGHT AND LICENSE 💀

This software is Copyright (c) 2013 by David Golden.

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

---

and that's the whole page, bestie!! 🎀 she's small, she's specific, she searches local package flatfiles and she's not sorry about it. slay.

signing off — this was generated by perl v5.36.0, dated 2022-12-09, and yeah that's the CPAN::...Package(3pm) footer but we're calling it a vibe check timestamp. 💜✨