hypot: The SWD3 Demo Software

Repository to demo the SWD3 course workflow. The course incorporates several good practices and approaches to develop a software.

We use the Hypotenuse problem as simple problem. The general design is

• 1 squared function
• 1 sum function
• 1 square root function
• 1 hypotenuse function that uses the other functions

Related Material

• Slides used in this course
• Complete RSE Course Material

Detailed Workflow

1. Local Setup: Install Git, Anaconda, VScode
2. Git Initialisation: Create a GitHub repository + Licence + .gitignore + Readme
3. GH Action Setup: GH Action for testing (Python application)
4. Working locally: Clone GH repository in local machine
5. Structure: Create project structure (source and test folders)
6. Test Driven Development: Setup tests
7. Development: write code
8. Simple Documentation: Add docstring (you can use autoDocstring - Python Docstring Generator on VS Code)
9. Deployment: Push to github
10. Advanced documentation: Create documentation using Sphinx and GH Action/Page
11. Local Install: Setup file and local installation
12. Release: Create a GitHub Release