Skip to content

Commit 66faea2

Browse files
authored
final md hopefully
fix bunch of stuff
1 parent deaeca0 commit 66faea2

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
# Shipmint
3-
Shipmint is a Python data querying and export tool built for running analytical SQL queries on the [dvdrental](https://neon.com/postgresql/postgresql-getting-started/postgresql-sample-database) dataset. It connects to a PostgreSQL database, executes pre-defined queries, and exports the results to CSV files.
3+
Shipmint is a data querying and export tool built with Python for running analytical SQL queries on the [dvdrental](https://neon.com/postgresql/postgresql-getting-started/postgresql-sample-database) dataset. It connects to a PostgreSQL database, executes pre-defined queries, and exports the results to CSV files.
44

55
This project includes a working **Continuous Integration and Continuous Delivery (CI/CD) pipeline** using GitHub Actions that builds and pushes a Docker image to **Azure Container Registry** and deploys it via **Azure Container Instances**.
66

@@ -40,11 +40,11 @@ shipmint/
4040
- **GitHub Actions**: CI/CD pipeline<br>
4141

4242
### Python libraries used:<br>
43-
- **psycopg2** – Used to connect and interact with the PostgreSQL database.<br>
44-
- **os** – Handles interaction with the operating system, such as environment variables and file paths.<br>
45-
- **csv** – Used for reading and writing CSV files, primarily for data export/import.<br>
46-
- **time** – Utilized during development and testing for adding delays (for stuff like while waiting for Azure containers or services to be ready).<br>
47-
- **dotenv** – Loads environment variables from a .env file, for keeping sensitive configs like db credentials out of source code.<br>
43+
- `psycopg2` – Used to connect and interact with the PostgreSQL database.<br>
44+
- `os` – Handles interaction with the operating system, such as environment variables and file paths.<br>
45+
- `csv` – Used for reading and writing CSV files, primarily for data export/import.<br>
46+
- `time` – Utilized during development and testing for adding delays (for stuff like while waiting for Azure containers or services to be ready).<br>
47+
- `dotenv` – Loads environment variables from a .env file, for keeping sensitive configs like db credentials out of source code.<br>
4848

4949

5050

@@ -94,6 +94,8 @@ AZURE_SUBSCRIPTION_ID
9494
ACI_NAME
9595
```
9696

97+
98+
9799
---
98100

99101
## 🔧 CI/CD Pipeline
@@ -106,6 +108,15 @@ On push to master, the GitHub Actions workflow will:
106108
4. Deploy a new container to ACI.
107109
5. Wait for the container to finish execution.
108110
6. Delete the container (optional cleanup).
111+
112+
<p align="center">
113+
<img src="assets/azure1.png" alt="Azure1" width="800"/>
114+
</p>
115+
116+
<p align="center">
117+
<img src="assets/azure2.png" alt="Azure2" width="800"/>
118+
</p>
119+
109120
---
110121

111122
## 📜 License

0 commit comments

Comments
 (0)