contributors.py

"""Sphinx extension for listing code contributors to a release.

Usage::

   .. contributors:: v0.23.0..v0.23.1

This will be replaced with a message indicating the number of
code contributors and commits, and then list each contributor
individually.
"""
from docutils import nodes
from docutils.parsers.rst import Directive
import git

from announce import build_components


class ContributorsDirective(Directive):
    required_arguments = 1
    name = 'contributors'

    def run(self):
        range_ = self.arguments[0]
        try:
            components = build_components(range_)
        except git.GitCommandError:
            return [
                self.state.document.reporter.warning(
                    "Cannot find contributors for range '{}'".format(range_),
                    line=self.lineno)
            ]
        else:
            message = nodes.paragraph()
            message += nodes.Text(components['author_message'])

            listnode = nodes.bullet_list()

            for author in components['authors']:
                para = nodes.paragraph()
                para += nodes.Text(author)
                listnode += nodes.list_item('', para)

        return [message, listnode]


def setup(app):
    app.add_directive('contributors', ContributorsDirective)

    return {
        'version': '0.1',
        'parallel_read_safe': True,
        'parallel_write_safe': True,
    }