webyneter/python-humble-utils

.. highlight:: shell

.. _developing-locally:

Developing Locally
==================

.. include:: ./includes/execution_context_notice.rst


Environment Setup
-----------------

#. Fork us on `GitHub`_.

#. Clone your fork locally::

    $ git clone git@github.com:<your username>/python-humble-utils.git

#. Create a `virtualenv`_ ; assuming you have `virtualenvwrapper`_ installed, this is how you do it::

    $ mkvirtualenv python_humble_utils
    $ cd <cloned project root>
    $ setvirtualenvproject

#. Initialize environment::

    $ python setup.py develop


.. _`GitHub`: https://github.com/webyneter/python-humble-utils/
.. _`virtualenv`: https://virtualenv.pypa.io/en/stable/
.. _`virtualenvwrapper`: https://virtualenvwrapper.readthedocs.io/en/stable/



Scenarios
---------


Updating Requirements
~~~~~~~~~~~~~~~~~~~~~

Project requirements must be declared and pinned in ``./requirements*.txt``.

To install/upgrade/uninstall dependencies into/in/from the environment::

    $ make install


.. _developing-locally-tox:

Running ``tox`` with Multiple Python Distributions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Running ``tox`` locally requires a number of Python distributions to be available,
which is a challenge, to say the least. `pyenv`_ helps overcome this major obstacle.

#. Follow `pyenv installation instructions`_ to install ``pyenv`` system-wide.

#. Install all versions of Python the project is tested against by ``tox`` (see ``./tox.ini``).

#. Run ``tox``::

    $ make test-all


.. _`pyenv`: https://github.com/pyenv/pyenv
.. _`pyenv installation instructions`: https://github.com/pyenv/pyenv#installation