Adding code

Note

If you are creating stand-alone documentation, you can skip this chapter.

So you have some basic documentation, but no code to go with it!

Example

Let’s create a Python package called wordie. In the base directory of your project,

mkdir wordie

Now let’s create some files in the wordie directory. How about a module containing a class called Letters which has a method for randomly shuffling some letters. We first initialise the package,

__init__.py

from .letters import Letters

Then, we create the letters module,

letters.py

import random


class Letters:
    """Class for letters."""
    def __init__(self, s: str):
        if not s.isalpha():
            raise ValueError("String must be only letters.")
        self._s = s

    def __repr__(self):
        return f"Letters({self._s})"

    def __str__(self):
        return self._s

    def shuffle(self):
        """Shuffle the letters"""
        self._s = ''.join(random.sample(self._s, len(self._s)))

We can test this code by running this script in the project directory,

from wordie import Letters

l = Letters("abcdef")
print(l)
l.shuffle()
print(l)

which should print the original letters followed by the shuffled letters.