Skip to content

Monkey DAO

Simple Data Access Object (DAO) pattern specification for Python.

Installation guide

pip install monkey-dao

Project layout

.venv               # The virtual environement of the project
build/
    lib
    site            # The documentation site generated by MKdocs
src/
    docs/
        index.md    # The documentation homepage.
        api/        # Source code documentation.
        ...         # Other markdown pages, images and other files.
    main/
        python      # Python source code.
    it/
        python      # Source code for Python integration tests.
    ut/
        python      # Source code for Python unit tests.
.gitignore
mkdocs.yml          # The MKDocs configuration file.
pyproject.toml      # The project descriptors
README.rst          # General information about the project

Project tools

MKDocs

For full documentation visit mkdocs.org.

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Theme : Material