Metadata-Version: 2.0
Name: django-github-issues
Version: 0.1.0
Summary: Django App to sync GitHub issues
Home-page: https://github.com/genomics-geek/django-github-issues
Author: Michael A. Gonzalez
Author-email: genomics.geek.04.22@gmail.com
License: MIT
Description-Content-Type: UNKNOWN
Keywords: django-github-issues
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.10
Classifier: Framework :: Django :: 1.11
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: djangorestframework (==3.7.7)
Requires-Dist: django-filter (==1.1.0)
Requires-Dist: django-genomix (==0.4.1)
Requires-Dist: django-user-activities (==0.3.2)
Requires-Dist: Pillow (==5.0.0)

=============================
Django GitHub Issues
=============================

.. image:: https://badge.fury.io/py/django-github-issues.svg
    :target: https://badge.fury.io/py/django-github-issues

.. image:: https://travis-ci.org/chopdgd/django-github-issues.svg?branch=develop
    :target: https://travis-ci.org/chopdgd/django-github-issues

.. image:: https://codecov.io/gh/chopdgd/django-github-issues/branch/develop/graph/badge.svg
    :target: https://codecov.io/gh/chopdgd/django-github-issues

.. image:: https://pyup.io/repos/github/chopdgd/django-github-issues/shield.svg
     :target: https://pyup.io/repos/github/chopdgd/django-github-issues/
     :alt: Updates

.. image:: https://pyup.io/repos/github/chopdgd/django-github-issues/python-3-shield.svg
      :target: https://pyup.io/repos/github/chopdgd/django-github-issues/
      :alt: Python 3

Django App to sync GitHub issues

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

The full documentation is at https://django-github-issues.readthedocs.io.

Quickstart
----------

Install Django GitHub Issues::

    pip install django-github-issues

Add it to your `INSTALLED_APPS`:

.. code-block:: python

    INSTALLED_APPS = (
        'rest_framework',
        'django_filters',
        'user_activities',
        ...
        'github_issues',
        ...
    )

Add Django GitHub Issues's URL patterns:

.. code-block:: python

    from github_issues import urls as github_issues_urls


    urlpatterns = [
        ...
        url(r'^', include(github_issues_urls, namespace='github_issues')),
        ...
    ]

Add the following to `settings.py`:

.. code-block:: python

    GITHUB_API_URL=
    GITHUB_ACCESS_TOKEN=

Features
--------

* Allows you to sync and track GitHub issues in your project.
* Allows users who may not have a GitHub user name to post an issue to your project.

Running Tests
-------------

Does the code actually work?

::

    source <YOURVIRTUALENV>/bin/activate
    (myenv) $ pip install tox
    (myenv) $ tox

Credits
-------

Tools used in rendering this package:

*  Cookiecutter_
*  `cookiecutter-djangopackage`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage




History
-------

0.1.0 (2018-01-18)
++++++++++++++++++

* First release on PyPI.


