MetaCPAN aims to provide a free, open web service which provides metadata for CPAN modules.
MetaCPAN is based on Elasticsearch, so it provides a RESTful interface as well
as the option to create complex queries. The docs/
directory
provides a good starting point for REST access to MetaCPAN.
MetaCPAN allows authors to add custom metadata about themselves to the index. Log in to MetaCPAN to add more information about yourself.
If you want to run MetaCPAN locally, we encourage you to start with metacpan-docker. However, you may still find some info here:
You can restart Elasticsearch (ES) manually if you need to troubleshoot.
sudo service elasticsearch restartIf you are unable to access [[http://localhost:9200]] (give it a few seconds) you should kill the Elasticsearch process and run it in foreground to see the debug output
sudo service elasticsearch stop
cd /opt/elasticsearch
sudo bin/elasticsearch -fIf you get a "Can't start up: not enough memory" error when trying to start Elasticsearch, you likely need to update your JRE. On Ubuntu:
# fixes "not enough memory" errors
sudo apt-get install openjdk-6-jre(Note: If you intend to try indexing a full MiniCPAN, you may find that Elasticsearch wants to use more open filehandles than your system allows by default. This script can be used to start ES with the appropriate ulimit adjustment).
The test suite accesses Elasticsearch on port 9900. The developer VM should have a dedicated test instance running in the background already, but if you want to run it manually:
cd /opt/elasticsearch
sudo bin/elasticsearch -f -Des.http.port=9900 -Des.cluster.name=testingThen run the test suite:
cd /home/metacpan/metacpan-api
./bin/prove tThe test suite has to pass all tests.
./bin/run bin/metacpan mapping --delete--delete will drop all indices first to clear the index from test data.
./bin/run bin/metacpan release /path/to/cpan/authors/id/You should note that you can index either your CPAN mirror or a minicpan mirror. You can even index just parts of a mirror:
./bin/run bin/metacpan release /path/to/cpan/authors/id/{A,B}./bin/run bin/metacpan latest --cpan /path/to/cpan/./bin/run bin/metacpan author --cpan /path/to/cpan/Note that minicpan doesn't provide the 00whois.xml file which is used to generate the index; you will have to download it manually (it is in the authors/ directory) in order to index authors.
wget -O /path/to/cpan/authors/00whois.xml cpan.cpantesters.org/authors/00whois.xmlIt also doesn't include author.json files, so that data will also be missing unless you get it from somewhere else.
Start API server on port 5000
./bin/run plackup -p 5000 -rThis will start a single-threaded test server. If you need extra performance,
use Starman instead.
For a full list of options:
./bin/run bin/metacpan release --helpIf you'd like to get involved, find us at #metacpan on irc.perl.org or open an issue on GitHub and let us know what you'd like to start working on.
You can find us at #metacpan on irc.perl.org Access it via web interface.
![metacpan-automation[bot] avatar](https://avatars.githubusercontent.com/in/371366?v=4 "metacpan-automation[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent