This repo contains work for mini-project 1. It sets up an environment on codespaces and uses Github Actions to run a Makefile for the following: make install
, make test
, make format
, make lint
.
Some important stuff included are:
-
Makefile
-
Dockerfile
-
A base set of libraries for devops and web
-
githubactions
The purpose of this project is to create a python template to use for later projects. To make sure github actions is working properly, I use a Makefile to test various parts of my code. To clarify, I made a simple function in main.py and use various test cases in test_main.py to make sure my code works correctly.
- open codespaces
- wait for container to be built and virtual environment to be activated with requirements.txt installed
- Format code
make format
- Lint code
make lint
eg: check lint errors:
![Screenshot 2023-09-06 at 10 11 38 PM](https://private-user-images.githubusercontent.com/36715338/266183857-98471323-112d-4818-9c3b-7fc15b9b7927.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzg5NzM2NjAsIm5iZiI6MTczODk3MzM2MCwicGF0aCI6Ii8zNjcxNTMzOC8yNjYxODM4NTctOTg0NzEzMjMtMTEyZC00ODE4LTljM2ItN2ZjMTViOWI3OTI3LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAyMDglMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMjA4VDAwMDkyMFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTJhNjM0OTYzNmU4OGRlMDcwNTA1NWU0MGVhNDc3MjNlMjA1Nzg1Y2E3OTA3MzhjNDU1ZTU5MDdhMTNjYjcwYjEmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.DoLxYC1r6hrO3XdUprv2a0Gp5s6qINe0p6poHtftNYU)
- Test code
make test
eg: check test cases:
![Screenshot 2023-09-06 at 10 11 58 PM](https://private-user-images.githubusercontent.com/36715338/266184071-caf8d3dc-4da0-4f76-9fe5-20805ecafa1a.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzg5NzM2NjAsIm5iZiI6MTczODk3MzM2MCwicGF0aCI6Ii8zNjcxNTMzOC8yNjYxODQwNzEtY2FmOGQzZGMtNGRhMC00Zjc2LTlmZTUtMjA4MDVlY2FmYTFhLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAyMDglMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMjA4VDAwMDkyMFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTdiZTM3ZTBjMzA3YzViYTY1ZWIyODI3OTc4NzM5NDM0NTUwNWJjOGQ5OTk3YzMyY2E4MGRiM2NmZTUzYjE5ZjUmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.hqey26ZXH2DBwip_aIyCQ3XQHikL2iRCjdTDebeyA5U)