Skip to content
Find file
Fetching contributors…
Cannot retrieve contributors at this time
44 lines (35 sloc) 2.71 KB
<html>
<head>
<title>CPAN Meta DB</title>
<link rel="stylesheet" href="http://miyagawa.github.com/screen.css" ?>
<style>
body { font-size: 1.1em }
.info { font-size: 0.9em }
#footer { margin-top: 100px; font-size: 0.8em; text-align: center }
</style>
</head>
<body>
<div class="container">
<h1>CPAN Meta DB</h1>
<p class="info">
This is (yet another) CPAN metadata database that provides REST API for the CPAN distributions, intended to be used by CPAN clients such as <a href="http://github.com/miyagawa/cpanminus">cpanminus</a>. Currently the only implemented endpoint is the resolver to get distribution file names from package names (a.k.a <code>02packages.details.txt.gz</code>) but there's a plan to implement more to extract information from <code>META.yml</code> etc. See also <a href="http://search.cpan.org/perldoc?CPANDB">CPANDB</a> and <a href="http://search.cpan.org/perldoc?App::CPANIDX">CPANIDX</a> for the similar works.
</p>
<h2>APIs</h2>
<dl>
<dt><code>/v1.0/package/Package::Name</code><dt>
<dd>Returns the latest distribution file path that contains the package and its version string ('undef' is a valid version string) in YAML format. Returns 404 status code if the package is not found.</dd>
</dl>
<h2 id="privacy">Notes</h2>
<p>
By using CPAN Meta DB through <a href="https://github.com/miyagawa/cpanminus">cpanm</a>, you're sending the module you're about to install, the version of cpanm installation, IP address as well as your local perl version (as of 1.6004 or later). You can opt it out by setting <code>--mirror-only</code> option to not use CPAN Meta DB for faster index resolution, or by using <code>--no-report-perl-version</code> since version 1.6008.
</p>
<p>
The collected data is stored securely on the application server (by hashing the IP address to be anonymized) and our CDN provider <a href="http://www.fastly.com">fastly</a> (<a href="http://www.fastly.com/terms">terms</a>), and used to make the service more reliable (e.g. blacklisting DoS attacks) and for data mining purposes such as <a href="http://cpanmetadb.plackperl.org/static/versions/index.html">perl version stats</a>. Unmasked IP addresses are never stored, published nor shared with third parties (besides Fastly, who serves the cached content in behalf of our servers).
</p>
<div id="footer">
This is yet another CPAN Meta DB, created by <a href="http://bulknews.typepad.com/">Tatsuhiko Miyagawa</a> for <a href="http://search.cpan.org/perldoc?App::cpanminus">cpanminus</a>.<br/>
Powered by <a href="http://www.fastly.com/">fastly</a>, <a href="http://www.linode.com/?r=425f2f427ba816f7d4fad073885a0e6b6914ebca">Linode</a> and the source code is available on <a href="http://github.com/miyagawa/cpanmetadb-perl">github</a>.
</div>
</div>
</body>
</html>
Something went wrong with that request. Please try again.