Resources
=========

Tools and documentations that we'll use throughout this tutorial.

venv
----

See also: `Python venv tutorial`_ documentation.

It is recommended that you install the Python packages inside a virtual
environment. For this tutorial, we'll use ``venv`` (but feel free to use
any other wrapper you are comfortable with).

Create a new virtual environment using venv::

   python3.7 -m venv tutorial-env

Activate the virtual environment. On Unix, Mac OS::

   source tutorial-env/bin/activate

On Windows::

   tutorial-env\Scripts\activate.bat

GitHub API v3 documentation
---------------------------

- `Issues API`_

- `Pull requests API`_

- `Reactions API`_

- `Event Types & Payloads`_

octomachinery
-------------

- Installation:

  .. parsed-literal::

     python3.7 -m pip install octomachinery==\ |octomachinery_version|

- `octomachinery documentation`_

- `octomachinery`_ source code

- Owner: `Sviatoslav Sydorenko <https://twitter.com/webknjaz>`_

gidgethub
---------

- Installation: ``pip install gidgethub``.

- `gidgethub documentation`_

- `gidgethub`_ source code

- Owner: `Brett Cannon <https://brettsky.ca>`_


f-strings
---------

We will use some f-strings during this tutorial.

Check out Mariatta's `talk
<https://speakerdeck.com/mariatta/pep-498-the-monologue>`_ about
f-strings.

Example:

.. code:: python

   first_name = "bart"
   last_name = "simpson"

   # old style %-formatting
   print("Hello %s %s" % (first_name, last_name))

   # str.format
   print("Hello {first_name} {last_name}".format(first_name=first_name, last_name=last_name))

   # f-string
   print(f"Hello {first_name} {last_name}")

asyncio
-------

Both `octomachinery`_ and `gidgethub`_ are both async libraries. Read up
the `quick intro
<https://www.blog.pythonlibrary.org/2016/07/26/python-3-an-intro-to-asyncio/>`_
to asyncio.

Heroku
------

`Python on Heroku`_ documentation.


.. _`Python venv tutorial`: https://docs.python.org/3/tutorial/venv.html

.. _`Issues API`: https://developer.github.com/v3/issues/
.. _`Pull requests API`: https://developer.github.com/v3/pulls/
.. _`Reactions API`: https://developer.github.com/v3/reactions/
.. _`Event Types & Payloads`: https://developer.github.com/v3/activity/events/types/

.. _`octomachinery documentation`: https://docs.octomachinery.dev
.. _`gidgethub documentation`: https://gidgethub.readthedocs.io

.. _`octomachinery`: https://github.com/sanitizers/octomachinery
.. _`gidgethub`: https://github.com/brettcannon/gidgethub

.. _`Python on Heroku`: https://devcenter.heroku.com/categories/python