Architecture’s Document

Python is surprisingly flexible when it comes to structuring your applications. On the one hand, this flexibility is great: it allows different use cases to use structures that are necessary for those use cases. On the other hand, though, it can be very confusing to the new developer.

Document Overview

Topic Description
Introduction Describes information about the purpose of this document.
Architectural Representation Provides a description of the software architecture for a better understanding of its structure and functioning.
In addition to showing how it is being represented.
Goals and Constraints Provides a description of the requirements and objectives of the software,
and whether they have any impact on the architecture.
Logical View Provides a description of the relevant parts related to the architecture of the design model.
References Relevant links and literatures to the development of this document.



This document aims to provide an overview of the architecture of the DODFMiner Library: it contains pertinent information about the architecture model adopted, such as diagrams that illustrate use cases, package diagram, among other resources.


Through this document, the reader will be able to understand the functioning of the DODFMiner Library, as well as the approach used in its development. In this way, it will be possible to have a broad understanding of its architecture.

Definitions, Acronyms and Abreviations

Acronym Definition
CLI Command Line Interface
DODF Diário Oficial do Distrito Federal

Revision History

Data Versão Descrição Autor
29/06/2020 1.0 Documment Creation Renato Nobre
16/07/2020 1.1.0 Documment Creation Renato Nobre & Khalil Casten

Architectural Representation

The main point to understand in this architecture is that the DODFMiner is a library and a CLI application simultaniously. DODFMiner can be integrated to another project or used standalone in a shell environment.

Being a library requires a given ammount of complexity. In larger applications, you may have one or more internal packages that provide specific functionality to a larger library you are packaging. This application follows this aspect, mining pdf documents, imply in many subpackages with specific functionality, that when working together, fulfill a greater aspect.

Relationship Diagram


Subpackages Structure

This applications follow the basic structure for a python library with multiple subpackages. It uses a common concept of core and helper files.

The core file is the main file in a package or subpackage, it contains the class with the main package execution. The helper file contains suporting functions to the package.

In summary, the project structure look as follows:

├── downloader
│   └──
├── extract
│   ├── polished
│      ├── acts
│         ├──
│         ├──
│         ├──
│         ├──
│         ├──
│         ├── models/
│         ├──
│         ├──
│         ├──
│         └──
│      ├── backend
│         ├──
│         └──
│      ├──
│      └──
│   └── pure
│       ├──
│       └── utils
│           ├──
│           ├──
│           └──


Following are some of the most essencial tecnologies used with the DODFMiner application

  1. MuPDF

    MuPDF is a free and open-source software framework written in C that implements a PDF, XPS, and EPUB parsing and rendering engine. It is used primarily to render pages into bitmaps, but also provides support for other operations such as searching and listing the table of contents and hyperlinks

  2. BeautifulSoup

    Beautiful Soup is a Python package for parsing HTML and XML documents. It creates a parse tree for parsed pages that can be used to extract data from HTML, which is useful for web scraping

  3. Pandas

    Pandas is a software library written for the Python programming language for data manipulation and analysis. In particular, it offers data structures and operations for manipulating numerical tables and time series. It is free software released under the three-clause BSD license

  4. Site do DODF

    Website where all of the DODFs are downloaded from.

Goals and Constraints

Non-functional Requirements

  • Be a library avaiable by pip on The Python Package Index (PyPI)

  • Work as a standalone command line application, installed globally without needing file execution

  • Support continuous deployment and continuous integration

  • The DODFMiner should be able to:

    • Download DODFs from the website

    • Extract pdf files to .txt and .json formats

    • Extract images and tables from the DODF

    • Extract DODF’s Acts and its proprieties to a dataframe or other desirable format

General Constraints

  • Have tested support for Mac and Linux users.

  • Have a docker installation method

  • Be open-source

  • Don’t use a database library

Tecnological Constraints

  • Python: Language used for development

  • MuPDF: Tool used for PDF extraction

  • BeautifulSoup: Library used for webscraping

  • Pandas: Library used for data handling and cration of dataframes

  • DODF Website: Website in which the DODFs are downloaded from

Logical View


DODFMiner is a library and CLI application made with the Python language, using MuPDF, BeautifulSoup, Pandas, and many others python libraries. The purpose of DODFMiner is to be an library and tool to fullfil the hole process of extraction of a official diary from federal district in Brazil.

Package Diagram


Class Diagram


Amika Architecture

Python Layouts