Automatisk dokumentation av Python-moduler

Abstract

Detta examensarbete gjordes på uppdrag av Neotide Ab, ett mjukvaruföretag i Vasa som specialiserar sig på databas- och nätverkslösningar för sjukvårdsdistrikt, kommuner och städer i Finland. Uppdraget var att skapa en tilläggsmodul till deras rapporteringsprogram Exreport. Tillägget skall automatiskt skapa dokumentation utgående från de databashämtningsmoduler som existerar i en kunds Exreport-system. Målet med dokumentationen är att ge kunder en översiktlig bild varifrån den data som rapporteras i Exreport har sitt ursprung.

Examensarbetet gjordes med programmeringsspråket Python och använder sig av dokumentationsverktyget Sphinx.

Resultat blev ett tillägg till Neotides rapporteringsverktyg som automatiskt generar en webbsida med all information om de olika modulerna och databaserna som finns i en specifik kunds rapporteringssystem.

Tämä opinnäytetyö tehtiin Neotide Oy:lle, joka on ohjelmistoyritys Vaasassa. Neotide on erikoistunut tietokanta- ja verkkopohjaisiin ratkaisuihin sairaanhoitopiireille, kunnille ja kaupungeille. Tehtävä oli kehittää lisäysmoduuli heidän raporttisovellukselle Exreport. Moduulin pitää automaattisesti luoda dokumentointi, joka perustuu tietokantamoduuleihin, jotka ovat olemassa asiakkaan Exreport-järjestelmässä. Dokumentoinnin tarkoitus on antaa asiakkaille yleiskatsauksen siitä, mistä Exreportissa oleva tieto on tullut.

Opinnäytetyö on tehty ohjelmointikielellä Python ja käyttää dokumentointityökalua Sphinx.

Tulos oli lisäys Neotiden raporttisovellukselle joka automaattisesti luo verkkosivun kaikilla tiedolla erilaisista moduuleista ja tietokannoista, jotka ovat asiakkaan raporttisovelluksessa.

This Bachelor’s thesis was made for Neotide Oy, a software company in Vasa that specialises in Database- and network solutions for health care districts, municipalities and cities in Finland. The task was to create an addon module for their reporting system Exreport. The module shall automatically create documentation from the database modules that exists in a customer’s Exreport-system. The purpose of the documentation is to give customers a summary of where the data that Exreport shows has its origin.

The thesis was made with the programming language Python and the documentation tool Sphinx.

The result is an addon to Neotides reporting system that automatically generates a website with information about the different modules and databases that exists in specific customers reporting system.