{
    "user": "grimoirelab",
    "name": "perceval",
    "namespace": "grimoirelab",
    "repository_type": "image",
    "status": 1,
    "description": "Perceval Docker image to work in standalone mode",
    "is_private": false,
    "is_automated": true,
    "can_edit": false,
    "star_count": 1,
    "pull_count": 398,
    "last_updated": "2017-05-10T08:12:52.217787Z",
    "build_on_cloud": null,
    "has_starred": false,
    "full_description": "# Perceval [![Build Status](https://travis-ci.org/grimoirelab/perceval.svg?branch=master)](https://travis-ci.org/grimoirelab/perceval) [![Coverage Status](https://img.shields.io/coveralls/grimoirelab/perceval.svg)](https://coveralls.io/r/grimoirelab/perceval?branch=master)\n\nSend Sir Perceval on a quest to retrieve and gather data from software\nrepositories.\n\n## Usage\n\n```\nusage: perceval [-c <file>] [-g] <backend> [<args>] | --help | --version\n\nRepositories are reached using specific backends. The most common backends\nare:\n    askbot           Fetch questions and answers from Askbot site\n    bugzilla         Fetch bugs from a Bugzilla server\n    bugzillarest     Fetch bugs from a Bugzilla server (>=5.0) using its REST API\n    confluence       Fetch contents from a Confluence server\n    discourse        Fetch posts from Discourse site\n    gerrit           Fetch reviews from a Gerrit server\n    git              Fetch commits from Git\n    github           Fetch issues from GitHub\n    gmane            Fetch messages from Gmane\n    hyperkitty       Fetch messages from a HyperKitty archiver\n    jenkins          Fetch builds from a Jenkins server\n    jira             Fetch issues from JIRA issue tracker\n    mbox             Fetch messages from MBox files\n    mediawiki        Fetch pages and revisions from a MediaWiki site\n    meetup           Fetch events from a Meetup group\n    nntp             Fetch articles from a NNTP news group\n    phabricator      Fetch tasks from a Phabricator site\n    pipermail        Fetch messages from a Pipermail archiver\n    redmine          Fetch issues from a Redmine server\n    rss              Fetch entries from a RSS feed server\n    slack            Fetch messages from a Slack channel\n    stackexchange    Fetch questions from StackExchange sites\n    supybot          Fetch messages from Supybot log files\n    telegram         Fetch messages from the Telegram server\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -v, --version         show version\n  -c FILE, --config FILE\n                        set configuration file\n  -g, --debug           set debug mode on\n\nRun 'perceval <backend> --help' to get information about a specific backend.\n```\n\n## Requirements\n\n* Python >= 3.4\n* python3-dateutil >= 2.6\n* python3-requests >= 2.7\n* python3-bs4 (beautifulsoup4) >= 4.3\n* python3-feedparser >= 5.1.3\n\n## Installation\n\nThere are several ways for installing Perceval on your system: from packages,\nfrom a docker image or from the source code.\n\n### Pip\n\nPerceval can be installed using [pip](https://pip.pypa.io/en/stable/), a tool\nfor installing Python packages. To do it, run the next command:\n\n```\n$ pip3 install perceval\n```\n\n### Docker\n\nA Perceval Docker image is available at [DockerHub](https://hub.docker.com/r/grimoirelab/perceval/).\n\nDetailed information on how to run and/or build this image can be found [here](https://github.com/grimoirelab/perceval/tree/master/docker/images/).\n\n### Source code\n\nTo install from the source code you will need to clone the repository first:\n\n```\n$ git clone https://github.com/grimoirelab/perceval.git\n```\n\nIn this case, [setuptools](http://setuptools.readthedocs.io/en/latest/) package will be required.\nMake sure it is installed before running the next commands:\n\n```\n$ pip3 install -r requirements.txt\n$ python3 setup.py install\n```\n\n## Documentation\n\nDocumentation is generated automagically in the [ReadTheDocs Perceval site](http://perceval.readthedocs.org/).\n\n## Examples\n\n### Askbot\n```\n$ perceval askbot 'http://askbot.org/' --from-date '2016-01-01'\n```\n\n### Bugzilla\nTo fetch bugs from Bugzilla, you have two options:\n\na) Use the traditional backend\n\n```\n$ perceval bugzilla 'https://bugzilla.redhat.com/' --backend-user user --backend-password pass --from-date '2016-01-01'\n```\n\nb) Use the REST API backend for Buzilla 5.0 (or higher) servers. We strongly recommend\nthis backend when data is fetched from version servers >=5.0 because the retrieval\nprocess is much faster.\n\n```\n$ perceval bugzillarest 'https://bugzilla.mozilla.org/' --backend-user user --backend-password pass --from-date '2016-01-01'\n```\n\n### Confluence\n```\n$ perceval confluence 'https://wiki.opnfv.org/' --from-date '2016-01-01'\n```\n\n### Discourse\n```\n$ perceval discourse 'https://foro.mozilla-hispano.org/' --from-date '2016-01-01'\n```\n\n### Gerrit\nTo run gerrit, you will need an authorized SSH private key:\n\n```\n$ eval `ssh-agent -s`\n$ ssh-add ~/.ssh/id_rsa\nIdentity added: /home/user/.ssh/id_rsa (/home/user/.ssh/id_rsa)\n```\n\nTo run the backend, execute the next command:\n\n```\n$ perceval gerrit --user user 'review.openstack.org' --from-date '2016-01-01'\n```\n\n### Git\n\nTo run this backend execute the next command. Take into account that to run\nthis backend Git program has to be installed on your system.\n\n```\n$ perceval git 'https://github.com/grimoirelab/perceval.git' --from-date '2016-01-01'\n```\n\nGit backend can also work with a Git log file as input. We recommend to use the next command to get the most complete log file.\n\n```\ngit log --raw --numstat --pretty=fuller --decorate=full --parents --reverse --topo-order -M -C -c --remotes=origin --all > /tmp/gitlog.log\n```\n\nThen, to run the backend, just execute any of the next commands:\n\n```\n$ perceval git --git-log '/tmp/gitlog.log' 'file:///myrepo.git'\n```\n\nor\n\n```\n$ perceval git '/tmp/gitlog.log'\n```\n\n### GitHub\n```\n$ perceval github elastic logstash --from-date '2016-01-01'\n```\n\n### Gmane\n```\n$ perceval gmane --offset 2000 'evince-list@gnome.org'\n```\n\n### HyperKitty\n```\n$ perceval hyperkitty 'https://lists.mailman3.org/archives/list/mailman-users@mailman3.org' --from-date 2017-01-01\n```\n\n### Jenkins\n```\n$ perceval jenkins 'http://jenkins.cyanogenmod.org/'\n```\n\n### JIRA\n```\n$ perceval jira 'https://tickets.puppetlabs.com' --project PUP --from-date '2016-01-01'\n```\n\n### MBox\n```\n$ perceval mbox 'http://example.com' /tmp/mboxes/\n```\n\n### MediaWiki\n```\n$ perceval mediawiki 'https://wiki.mozilla.org' --from-date '2016-06-30'\n```\n\n### Meetup\n```\n$ perceval meetup 'Software-Development-Analytics' --from-date '2016-06-01' -t abcdefghijk\n```\n\n### NNTP\n```\n$ perceval nntp 'news.mozilla.org' 'mozilla.dev.project-link' --offset 10\n```\n\n### Phabricator\n```\n$ perceval phabricator 'https://secure.phabricator.com/' -t 123456789abcefe\n```\n\n### Pipermail\n```\n$ perceval pipermail 'https://mail.gnome.org/archives/libart-hackers/'\n```\n\nPipermail also is able to fetch data from Apache's `mod_box` interface:\n```\n$ perceval pipermail 'http://mail-archives.apache.org/mod_mbox/httpd-dev/'\n```\n\n### Redmine\n```\n$ perceval redmine 'https://www.redmine.org/' --from-date '2016-01-01' -t abcdefghijk\n```\n\n### RSS\n```\n$ perceval rss 'https://blog.bitergia.com/feed/'\n```\n\n### Slack\n```\n$ perceval slack C0001 --from-date 2016-01-12 -t abcedefghijk\n```\n\n### StackExchange\n```\n$ perceval stackexchange --site stackoverflow --tagged python --from-date '2016-01-01' --token abcdabcdabcdabcd\n```\n\n### Supybot\n```\n$ perceval supybot 'http://channel.example.com' /tmp/supybot/\n```\n\n### Telegram\n\nTelegram backend needs an API token to authenticate the bot. In addition and\nin order to fetch messages from a group or channel, privacy settings must be\ndisabled. To know how to create a bot, to obtain its token and to configure it\nplease read the [Telegram Bots docs pages](https://core.telegram.org/bots).\n\n```\n$ perceval telegram mybot -t 12345678abcdefgh --chats 1 2 -10\n```\n\n## License\n\nLicensed under GNU General Public License (GPL), version 3 or later.\n",
    "affiliation": null,
    "permissions": {
        "read": true,
        "write": false,
        "admin": false
    }
}
