1.3 List of deliverables

We’ll take another look at the project, this time from the view of what files will be created. This will parallel the outline of the activities shown in the previous section.

The following outline shows many of the files in a completed project:

• The documentation in the docs directory. There will be other files in there, but you’ll be focused on the following files:

  • The Sphinx index.rst starter file with references to overview and API sections.

  • An overview.rst section with a summary of the project.

  • An api.rst section with .. automodule:: commands to pull in documentation from the application.

• A set of test cases in the tests directory.

  • Acceptance tests aimed at Behave (or the pytest-bdd plug-in for Gherkin). When using Behave, there will be two sub-directories: a features directory and a steps directory. Additionally, there will be an environment.py file.

  • Unit test modules written with the pytest framework. These all have a name that starts...