Tips en aanbevelingen voor opvolgers

Deze pagina bevat de aanbevelingen voor toekomstige deelnemers aan de basis software opleiding.

OCR

In de zoektocht naar betere resultaten zijn we aan het einde van ons project gestuit op een wellicht betere OCR dan die we nu gebruiken. Nu wordt er gebruik gemaakt van tesseract, maar is een Python binding die gebruik kan worden, zodat tesseract beter werkt. Deze heet PyOCR en gemakkelijk te installeren via pip install. Een probeersel is gemaakt ter vervanging van het huidige Readimage.py programma. De resultaten zien er hoopvol uit, maar er is niet genoeg mee getest om te kunnen stellen dat deze beter is. Het bestand om te proberen is te vinden in de map .\\RekenRobot/TryOut/Python/ReadImagePyOCR.py. Voor meer informatie over OCR kijk op de Pythontips pagina.

Version Control

Na het installeren van Mercurial kun je in het bestand .hghgrc de adressen neerzetten van de forks die jullie gebruiken. Onder het kopje paths kun je de onderstaande regel toevoegen om het pushen en pullen makkelijker te maken.

[naam] = [bitbucket link]

#bijvoorbeeld:
guus = https://GuusvanBohemen@bitbucket.org/GuusvanBohemen/pathways-extensions-training

Als je nu een hg commando geeft naar een bepaalde link, kun je de naam gebruiken, ipv de link te kopiëren.

Documentatie

RST

Beter slecht gedocumenteerd als niet gedocumenteerd. Het is makkelijker om snel iets te typen en later weer weg te gooien dan dat je het uiteindelijke nergens hebt staan. Neem even de tijd om jezelf bekend te maken met de .rst syntax. Een aantal handige functies zijn:

'.. todo::'                 - Om automatische todo's op te geven, die zich op de todo pagina verzamelen.
'.. code-block::'           - Om code op een nette manier aan te geven.
'.. figure:: [path\figure]' - Om een plaatje te laten zien (werkt ook met "image", maar heeft dan weer andere functies).
':doc: [path\document]'     - Om te verwijzen naar een intern document.

Let ook goed op inspringingen en enters bij het aanroepen van functies!

Overige

Maak .bat bestanden aan met specifieke cmd regels, zet die op een logische plek, en voeg deze locatie to aan je path (Environmental Variable). Door het .bat bestand aan te roepen in cmd, voert deze de commando in de .bat uit. Wij hadden bijvoorbeeld de volgende ‘shortcuts’:
  • Navigeren naar de demo map: Het commando ‘cddemo’ navigeerde meteen naar de demo map van dit project. Het .bat bestand ‘cddemo.bat’ bevatte de regel:

    cd /d D:\Users\%username%\Documents\pathways-extensions-training\RekenRobot\Src\DisplayLezen\Demo

  • Bouwen van de documentatie: Het commando ‘sphinx’ bouwde automatisch de documentatie op. Het .bat bestand ‘sphinx.bat’ bevatte de regel:

    sphinx-build -c doc -b html -d tmp/sphinx_cache doc/ __result/html

  • Open van de teampagina: Het commando ‘team’ opende direct onze teampagina in IE. Het .bat bestand ‘team.bat’ bevatte de regels:

    start iexplore

    D:\Users\gbohemen\Documents\pathways-extensions-training\docs\__result\html\teams\2017.3_DuoPiNotti\index.html