Metadata-Version: 2.0
Name: perceval
Version: 0.5.0.dev2
Summary: Fetch data from software repositories
Home-page: https://github.com/grimoirelab/perceval
Author: Bitergia
Author-email: sduenas@bitergia.com
License: GPLv3
Keywords: development repositories analytics git github bugzilla jira jenkins
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Requires-Dist: beautifulsoup4 (>=4.3.2)
Requires-Dist: python-dateutil (>=2.0.0)
Requires-Dist: requests (>=2.7.0)

Perceval |Build Status| |Coverage Status|
=========================================

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

Usage
-----

::

    usage: perceval [-c <file>] [-g] <backend> [<args>] | --help

    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
        gerrit           Fetch reviews from a Gerrit server
        git              Fetch commits from Git
        github           Fetch issues from GitHub
        gmane            Fetch messages from Gmane
        jenkins          Fetch builds from a Jenkins server
        jira             Fetch issues from JIRA issue tracker
        mbox             Fetch messages from MBox files
        mediawiki        Fetch pages and revisions from a MediaWiki site
        meetup           Fetch events from a Meetup group
        phabricator      Fetch tasks from a Phabricator site
        pipermail        Fetch messages from a Pipermail archiver
        redmine          Fetch issues from a Redmine server
        stackexchange    Fetch questions from StackExchange sites
        supybot          Fetch messages from Supybot log files
        telegram         Fetch messages from the Telegram server

    optional arguments:
      -h, --help            show this help message and exit
      -c FILE, --config FILE
                            set configuration file
      -g, --debug           set debug mode on

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

Requirements
------------

-  Python >= 3.4
-  python3-dateutil >= 2.0
-  python3-requests >= 2.7
-  python3-bs4 (beautifulsoup4) >= 4.3

Installation
------------

There are several ways for installing Perceval on your system: from
packages, from a docker image or from the source code.

Pip
~~~

Perceval can be installed using
`pip <https://pip.pypa.io/en/stable/>`__, a tool for installing Python
packages. To do it, run the next command:

::

    $ pip3 install perceval

Docker
~~~~~~

A Perceval Docker image is available at
`DockerHub <https://hub.docker.com/r/grimoirelab/perceval/>`__.

Detailed information on how to run and/or build this image can be found
`here <https://github.com/grimoirelab/perceval/tree/master/docker/images/>`__.

Source code
~~~~~~~~~~~

To install from the source code you will need to clone the repository
first:

::

    $ git clone https://github.com/grimoirelab/perceval.git

In this case,
`setuptools <http://setuptools.readthedocs.io/en/latest/>`__ package
will be required. Make sure it is installed before running the next
commands:

::

    $ pip3 install -r requirements.txt
    $ python3 setup.py install

Documentation
-------------

Documentation is generated automagically in the `ReadTheDocs Perceval
site <http://perceval.readthedocs.org/>`__.

Examples
--------

Askbot
~~~~~~

::

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

Bugzilla
~~~~~~~~

To fetch bugs from Bugzilla, you have two options:

a) Use the traditional backend

::

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

b) Use the REST API backend for Buzilla 5.0 (or higher) servers. We
   strongly recommend this backend when data is fetched from version
   servers >=5.0 because the retrieval process is much faster.

::

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

Confluence
~~~~~~~~~~

::

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

Discourse
~~~~~~~~~

::

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

Gerrit
~~~~~~

To run gerrit, you will need an authorized SSH private key:

::

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

To run the backend, execute the next command:

::

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

Git
~~~

::

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

Git 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.

::

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

Then, to run the backend, just execute the next command:

::

    $ perceval git /tmp/gitlog.log

GitHub
~~~~~~

::

    $ perceval github --owner elastic --repository filebeat --from-date '2016-01-01'

Gmane
~~~~~

::

    $ perceval gmane --offset 2000 'evince-list@gnome.org'

Jenkins
~~~~~~~

::

    $ perceval jenkins 'http://jenkins.cyanogenmod.com/'

JIRA
~~~~

::

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

MBox
~~~~

::

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

MediaWiki
~~~~~~~~~

::

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

Meetup
~~~~~~

::

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

Phabricator
~~~~~~~~~~~

::

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

Pipermail
~~~~~~~~~

::

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

Redmine
~~~~~~~

::

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

StackExchange
~~~~~~~~~~~~~

::

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

Supybot
~~~~~~~

::

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

Telegram
~~~~~~~~

Telegram backend needs an API token to authenticate the bot. In addition
and in order to fetch messages from a group or channel, privacy settings
must be disabled. To know how to create a bot, to obtain its token and
to configure it please read the `Telegram Bots docs
pages <https://core.telegram.org/bots>`__.

::

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

License
-------

Licensed under GNU General Public License (GPL), version 3 or later.

.. |Build Status| image:: https://travis-ci.org/grimoirelab/perceval.svg?branch=master
   :target: https://travis-ci.org/grimoirelab/perceval
.. |Coverage Status| image:: https://img.shields.io/coveralls/grimoirelab/perceval.svg
   :target: https://coveralls.io/r/grimoirelab/perceval?branch=master


