Welcome to DevOps World, a simple Python application designed to be tested and deployed through a complete DevOps workflow. This repository focuses on the application, including setup, dependencies, and basic usage.
This repository contains a simple Python application slightly more interesting than "Hello World". In this journey, I'm focusing on the DevOps stack. This repo is only for the application, as separate repos were set up for infrastructure, security, and monitoring configurations. As the project progresses, the repository links below will expand with details on cloud deployment, CI/CD pipelines, security scanning, and monitoring practices.
- DevOps Infrastructure:
devops-infra - DevOps Security:
devops-security - DevOps Monitoring:
devops-monitoring
You’ll want a dependable tool for editing and managing your files — modern IDEs make that process much more efficient. While it's technically possible to build everything using something like Notepad, modern IDEs offer far more—integrated debugging, IntelliSense, and a smoother development experience overall. There are excellent open-source options, so explore a few and choose one that suits your workflow.
Here's what I used
- Visual Studio Code (or any IDE that supports the latest version of Python)
- Python (latest version recommended)
- pip (for dependency management)
- Git (to clone the repository)
- Obsidian - started using this for markdown editing, but decided VS Code is enough for my needs and fits my workflow better.
Clone the repository and move into the project directory
git clone https://github.com/yourusername/devops-world.git
cd devops-world-
Windows:
- Download Python from python.org.
- Run the installer and check the box to add Python to PATH.
- Verify installation:
python --version
-
Mac/Linux:
- Install Python via your package manager:
brew install python # macOS sudo apt install python3 # Debian/Ubuntu
- Verify installation:
python3 --version
- Install Python via your package manager:
Create and activate a virtual environment to isolate dependencies:
- Windows:
python -m venv venv .\venv\Scripts\activate
If
pythondoesn't work, trypy -m venv venv.
- Mac/Linux:
python3 -m venv venv
source venv/bin/activate■ You'll know it's activated when you see (venv) in your terminal.
Install all required Python packages using:
pip install -r requirements.txtNote: All required Python packages (including Flask) will be installed automatically from
requirements.txt. You do not need to install them individually.
Start the Flask app with:
python src/app.pyIf
pythondoesn't work, trypython3 app.py.
In your browser, navigate to http://127.0.0.1:5000/ to see the running app.
To stop the server, press Ctrl+C in the terminal.
Tip: You can use the integrated terminal in Visual Studio Code for all commands above.
This section provides a high-level view of the application directory structure. As the CI/CD stack takes shape, I anticipate breaking out iss_service.py into a dedicated microservice for improved modularity. Initially, src/ and templates/ were placed at the top level. But as the project matured, I moved templates/ under src/ to better align with Flask’s organizational conventions and keep app-specific logic and views together. (And yes—templates/index.html will be removed soon... possibly before anyone reads this.)
devops-world/
│── .github/
│ └── workflows/
│ └── security_scan.yml # GitHub Actions workflow for security scanning
│ └── docker-build.yml
│ └── ci-dev.yml
│── requirements.txt # Python dependencies
│── README.md # Project documentation
│── .gitignore # Git ignore rules
│── src/ # Application source code
│ ├── app.py # Main application script
│ └── iss_service.py # API call to location of ISS
│── config/ # Configuration files (YAML, etc.)
│── templates/ # HTML templates for Flask
│── Dockerfile # docker build
This project uses a modular GitHub Actions setup to enforce code quality, validate infrastructure, and streamline delivery across environments. Each .yml workflow is purpose-built for clarity and separation of concerns:
ci-dev.yml — Python Dev Validation
Validates Python code on development branches and pull requests. Runs:
- Linting with Flake8
- Security scans with Bandit
- Tests via Pytest
- Secret scanning using TruffleHog
docker-dev.yml — Docker Quality Gate
Lint-checks and builds Docker images on dev-style branches (feature/*, hotfix/*, release/*) without pushing. Keeps Dockerfiles validated early in the cycle.
pr-validation.yml — Pull Request Docker Checks
Lint-checks and builds Docker images for all PRs targeting main. Uses Hadolint and build testing for early-stage validation.
docker-release.yml — Production Push
Builds and pushes Docker images to DockerHub from main and release/* branches. Includes tagging, login, and secure push pipelines.
Manual GitHub Actions for branch logic + context inspection
→ See debug workflows
After setting up the repositories and scaffolding the application, I focused on establishing a strong CI/CD framework. Although the order suited this exploratory build, I’d reverse it in a production context—starting with a robust CI/CD pipeline. Laying that foundation early promotes good engineering hygiene—enforcing automated scans, pull request gates, and approval workflows before anything lands in main. As I continue to build out the project, I will likely reorder these pages, but for now, the journey continues. My next stop in the journey was devops-infra for the Terraform setup.
This project is licensed under Creative Commons Attribution 4.0 International License (CC-BY-4.0).
🔗 Full license details: CC-BY-4.0
While this project is publicly available under an open license, contributions are currently not being accepted.
You're welcome to use, fork, or adapt the scripts for your infrastructure work. If you find them helpful, a star or mention is always appreciated.
Developed and maintained by ITByteEnthusiast.