usage: perceval [-g] <backend> [<args>] | --help | --version | --list

Send Sir Perceval on a quest to retrieve and gather data from software
repositories.

Repositories are reached using specific backends. The most common backends
are:

    askbot           Fetch questions and answers from Askbot site
    bugzilla         Fetch bugs from a Bugzilla server
    bugzillarest     Fetch bugs from a Bugzilla server (>=5.0) using its REST API
    confluence       Fetch contents from a Confluence server
    discourse        Fetch posts from Discourse site
    dockerhub        Fetch repository data from Docker Hub site
    gerrit           Fetch reviews from a Gerrit server
    git              Fetch commits from Git
    github           Fetch issues, pull requests and repository information from GitHub
    gitlab           Fetch issues, merge requests from GitLab
    gitter           Fetch messages from a Gitter room
    googlehits       Fetch hits from Google API
    groupsio         Fetch messages from Groups.io
    hyperkitty       Fetch messages from a HyperKitty archiver
    jenkins          Fetch builds from a Jenkins server
    jira             Fetch issues from JIRA issue tracker
    launchpad        Fetch issues from Launchpad issue tracker
    mattermost       Fetch posts from a Mattermost server
    mbox             Fetch messages from MBox files
    mediawiki        Fetch pages and revisions from a MediaWiki site
    meetup           Fetch events from a Meetup group
    nntp             Fetch articles from a NNTP news group
    pagure           Fetch issues from Pagure
    phabricator      Fetch tasks from a Phabricator site
    pipermail        Fetch messages from a Pipermail archiver
    redmine          Fetch issues from a Redmine server
    rocketchat       Fetch messages from a Rocket.Chat channel
    rss              Fetch entries from a RSS feed server
    slack            Fetch messages from a Slack channel
    stackexchange    Fetch questions from StackExchange sites
    supybot          Fetch messages from Supybot log files
    telegram         Fetch messages from the Telegram server
    twitter          Fetch tweets from the Twitter Search API

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         show version
  -g, --debug           set debug mode on
  -l, --list            show available backends

Run 'perceval <backend> --help' to get information about a specific backend.

$ sudo apt-get install build-essential

$ sudo apt-get install git

$ pip install perceval

$ git clone https://github.com/chaoss/grimoirelab-perceval
$ cd grimoirelab-perceval

$ pip install .

$ pip install -e .

$ poetry install

$ poetry shell

Dueñas, S., Cosentino, V., Robles, G., & Gonzalez-Barahona, J. M. (2018, May). Perceval: software project data at your will. In Proceedings of the 40th International Conference on Software Engineering: Companion Proceeedings (pp. 1-4). ACM.

@inproceedings{duenas2018perceval,
  title={Perceval: software project data at your will},
  author={Due{\~n}as, Santiago and Cosentino, Valerio and Robles, Gregorio and Gonzalez-Barahona, Jesus M},
  booktitle={Proceedings of the 40th International Conference on Software Engineering: Companion Proceeedings},
  pages={1--4},
  year={2018},
  organization={ACM}
}

$ perceval askbot 'http://askbot.org/' --from-date '2016-01-01'

$ perceval bugzilla 'https://bugzilla.redhat.com/' --backend-user user --backend-password pass --from-date '2016-01-01'

$ perceval bugzillarest 'https://bugzilla.mozilla.org/' --backend-user user --backend-password pass --from-date '2016-01-01'

$ perceval confluence 'https://wiki.opnfv.org/' --from-date '2016-01-01'

$ perceval discourse 'https://foro.mozilla-hispano.org/' --from-date '2016-01-01'

$ perceval dockerhub grimoirelab perceval

$ eval `ssh-agent -s`
$ ssh-add ~/.ssh/id_rsa
Identity added: /home/user/.ssh/id_rsa (/home/user/.ssh/id_rsa)

$ perceval gerrit --user user 'review.openstack.org' --from-date '2016-01-01'

$ perceval git 'https://github.com/chaoss/grimoirelab-perceval.git' --from-date '2016-01-01'

$ perceval git https://<username>:<password>@repository-url

$ perceval git https://<username>:<api-token>@github.com/chaoss/grimoirelab-perceval

$ git log --raw --numstat --pretty=fuller --decorate=full --parents --reverse --topo-order -M -C -c --remotes=origin --all > /tmp/gitlog.log

$ perceval git --git-log '/tmp/gitlog.log' 'file:///myrepo.git'

$ perceval git '/tmp/gitlog.log'

$ perceval github elastic logstash --from-date '2016-01-01'

$ perceval github --category issue elastic logstash

$ perceval gitlab fdroid fdroiddata -t $GITLAB_TOKEN --from-date '2016-01-01'

$ perceval gitter -t 'abcdefghi' --from-date '2020-03-18' 'jenkinsci' 'jenkins'

$ perceval googlehits "bitergia grimoirelab"

$ perceval groupsio 'updates' -e '<[email protected]>' -p 'my-password' --from-date '2016-01-01'

$ perceval hyperkitty 'https://lists.mailman3.org/archives/list/[email protected]' --from-date 2017-01-01

$ perceval jenkins 'https://build.opnfv.org/ci/'

$ perceval jira 'https://tickets.puppetlabs.com' --project PUP --from-date '2016-01-01'

$ perceval launchpad ubuntu --from-date '2016-01-01'

$ perceval mattermost 'http://mattermost.example.com' jgw7jdmjkjf19ffkwnw59i5f9e --from-date '2016-01-01' -t 'abcdefghijk'

$ perceval mbox 'http://example.com' /tmp/mboxes/

$ perceval mediawiki 'https://wiki.mozilla.org' --from-date '2016-06-30'

$ perceval meetup 'Software-Development-Analytics' --from-date '2016-06-01' -t abcdefghijk

$ perceval nntp 'news.mozilla.org' 'mozilla.dev.project-link' --offset 10

$ perceval pagure '389-ds-base' --from-date '2020-03-06'

$ perceval phabricator 'https://secure.phabricator.com/' -t 123456789abcefe

$ perceval pipermail 'https://mail.gnome.org/archives/libart-hackers/'

$ perceval pipermail 'http://mail-archives.apache.org/mod_mbox/httpd-dev/'

$ perceval redmine 'https://www.redmine.org/' --from-date '2016-01-01' -t abcdefghijk

$ perceval rocketchat -t 'abchdefghij' -u '1234abcd' --from-date '2020-05-02' https://open.rocket.chat general

$ perceval rss 'https://blog.bitergia.com/feed/'

$ perceval slack C0001 --from-date 2016-01-12 -t abcedefghijk

$ perceval stackexchange --site stackoverflow --tagged python --from-date '2016-01-01' -t abcdabcdabcdabcd

$ perceval supybot 'http://channel.example.com' /tmp/supybot/

$ perceval telegram mybot -t 12345678abcdefgh --chats 1 2 -10

$ perceval twitter grimoirelab -t 12345678abcdefgh