Dokumentation och testning i praktiken

Mjukvaruutvecklingsprinciper i Python

Adam Spannbauer

Machine Learning Engineer at Eastman

Dokumentera projekt med Sphinx

  Exempel på Sphinx-sida

Mjukvaruutvecklingsprinciper i Python

Dokumentera klasser

class Document:
    """Analyze text data

    :param text: text to analyze

    :ivar text: text originally passed to the instance on creation
    :ivar tokens: Parsed list of words from text
    :ivar word_counts: Counter containing counts of hashtags used in text
    """
    def __init__(self, text):
        ...
Mjukvaruutvecklingsprinciper i Python

Kontinuerlig integrationstestning

    Travis CI-logotyp

Exempel på Travis-utdata – misslyckad körning

Mjukvaruutvecklingsprinciper i Python

Kontinuerlig integrationstestning

  Exempel på Travis-utdata – godkänd körning

Mjukvaruutvecklingsprinciper i Python

Länkar och fler verktyg

  • Sphinx – Generera snygg dokumentation
  • Travis CI – Testa din kod kontinuerligt
  • GitHub & GitLab – Lagra dina projekt med git
  • Codecov – Identifiera var dina tester kan förbättras
  • Code Climate – Analysera din kod för ökad läsbarhet
Mjukvaruutvecklingsprinciper i Python

Nu kör vi en övning!

Mjukvaruutvecklingsprinciper i Python

Preparing Video For Download...