gregmalcolm/python_koans

============ Python Koans

.. image:: https://travis-ci.org/gregmalcolm/python_koans.png?branch=master :target: http://travis-ci.org/gregmalcolm/python_koans

.. image:: https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod :target: https://gitpod.io/#https://github.com/gregmalcolm/python_koans

.. image:: https://www.eclipse.org/che/contribute.svg :target: https://workspaces.openshift.com/f?url=https://gitpod.io/#https://github.com/gregmalcolm/python_koans

One click installation:

.. image:: https://www.eclipse.org/che/contribute.svg :target: https://workspaces.openshift.com/f?url=https://gitpod.io/#https://github.com/gregmalcolm/python_koans | or .. image:: https://gitpod.io/button/open-in-gitpod.svg :target: https://gitpod.io/#https://gitpod.io/#https://github.com/gregmalcolm/python_koans

|

Python Koans is a port of Edgecase's "Ruby Koans" which can be found at http://rubykoans.com/.

.. image:: https://user-images.githubusercontent.com/2614930/28401740-ec6214b2-6cd0-11e7-8afd-30ed3102bfd6.png

Python Koans is an interactive tutorial for learning the Python programming language by making tests pass.

Most tests are fixed by filling the missing parts of assert functions. Eg:

.. code-block:: python

self.assertEqual(__, 1+2)

which can be fixed by replacing the __ part with the appropriate code:

.. code-block:: python

self.assertEqual(3, 1+2)

Occasionally you will encounter some failing tests that are already filled out. In these cases you will need to finish implementing some code to progress. For example, there is an exercise for writing some code that will tell you if a triangle is equilateral, isosceles or scalene.

As well as being a great way to learn some Python, it is also a good way to get a taste of Test Driven Development (TDD).

Downloading Python Koans

Python Koans is available on GitHub:

• https://github.com/gregmalcolm/python_koans

You can clone with Git or download the source as a zip/gz/bz2.

Installing Python Koans

Aside from downloading or checking out the latest version of Python Koans, you need to install the Python interpreter.

At this time of writing, we support Python 3. The policy is to try to keep current with the latest production version.

You should be able to work with newer Python versions, but older ones will likely give you problems.

You can download Python from here:

• https://www.python.org/downloads/

After installing Python make sure the folder containing the python executable is in the system path. In other words, you need to be able to run Python from a command console. It will either be python3 or for Windows it will be python.exe.

If you have problems, this may help:

• https://www.python.org/about/gettingstarted/

Windows users may also want to update the line in the batch file run.bat to set the python path::

SET PYTHON_PATH=C:\Python39

Getting Started

Jake Hebbert has created a couple of screencasts available here:

https://www.youtube.com/watch?v=e2WXgXEjbHY&list=PL5Up_u-XkWgNcunP_UrTJG_3EXgbK2BQJ&index=1

Or if you prefer to read:

From a *nix terminal or Windows command prompt run::

.. code-block:: sh

python contemplate_koans.py

or:

.. code-block:: sh

python3 contemplate_koans.py

In my case I'm using Python 3 with Windows, so I fire up my command shell (cmd.exe) and run this:

.. image:: https://user-images.githubusercontent.com/2614930/28401747-f723ff00-6cd0-11e7-9b9a-a6993b753cf6.png

Apparently a test failed::

AssertionError: False is not True

It also tells me exactly where the problem is, it's an assert on line 12 of .\\koans\\about_asserts.py. This one is easy, just change False to True to make the test pass.

Sooner or later you will likely encounter tests where you are not sure what the expected value should be. For example:

.. code-block:: python

class Dog:
    pass

def test_objects_are_objects(self):
    fido = self.Dog()
    self.assertEqual(__, isinstance(fido, object))

This is where the Python Command Line can come in handy. In this case I can fire up the command line, recreate the scenario and run queries:

.. image:: https://user-images.githubusercontent.com/2614930/28401750-f9dcb296-6cd0-11e7-98eb-c20318eada33.png

Sniffer Support

Sniffer allows you to run the tests continuously. If you modify any files files in the koans directory, it will rerun the tests.

To set this up, you need to install sniffer:

.. code-block:: sh

python3 -m pip install sniffer

You should also run one of these libraries depending on your system. This will automatically trigger sniffer when a file changes, otherwise sniffer will have to poll to see if the files have changed.

On Linux:

.. code-block:: sh

python3 -m pip install pyinotify

On Windows:

.. code-block:: sh

python3 -m pip install pywin32

Also available here:

https://github.com/mhammond/pywin32/releases

On macOS:

.. code-block:: sh

python3 -m pip install MacFSEvents

Once it is set up, you just run:

.. code-block:: sh

sniffer

Just modify one of the koans files and you'll see that the tests are triggered automatically. Sniffer is controlled by scent.py.

Getting the Most From the Koans

Quoting the Ruby Koans instructions:

"In test-driven development the mantra has always been, red, green,
refactor. Write a failing test and run it (red), make the test pass
(green), then refactor it (that is look at the code and see if you
can make it any better). In this case you will need to run the koan
and see it fail (red), make the test pass (green), then take a
moment and reflect upon the test to see what it is teaching you
and improve the code to better communicate its intent (refactor)."

Finding More Koan Projects

There are number of other great Koan projects out there for various languages and frameworks. Most of them can be found in GitHub. Also there is a little koans activity on Bitbucket.

• GitHub koan projects: https://github.com/search?q=koans&ref=cmdform

• Bitbucket koan projects: https://bitbucket.org/repo/all?name=koans

Translations

Translations are always welcome! Feel free to add one to this README if you happen to work on one:

https://github.com/mswell/python_koans_br

Acknowledgments

Thanks go to Jim Weirich and Joe O'Brien for the original Ruby Koans that the Python Koans is based on! Also the Ruby Koans in turn borrows from Metakoans so thanks also go to Ara Howard for that!

Also thanks to everyone who has contributed to Python Koans! I got a great headstart by taking over a code base initiated by the combined Mikes of FPIP. So here's a little plug for their very cool Python podcast:

• https://www.frompythonimportpodcast.com/

A big thanks also to Mike Pirnat @pirnat and Kevin Chase @kjc have pitched in as co-maintainers at various times