diff --git a/.devcontainer/.Dockerfile b/.devcontainer/.Dockerfile
index e69de29..1c3275e 100644
--- a/.devcontainer/.Dockerfile
+++ b/.devcontainer/.Dockerfile
@@ -0,0 +1,6 @@
+FROM python:3.12.5
+
+WORKDIR /app
+
+COPY requirements.txt .
+RUN pip install --no-cache-dir -r requirements.txt
\ No newline at end of file
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
index e69de29..f35055b 100644
--- a/.devcontainer/devcontainer.json
+++ b/.devcontainer/devcontainer.json
@@ -0,0 +1,25 @@
+{
+ "name": "My Dev Container",
+ "dockerFile": "Dockerfile",
+ // "features": {
+ // "ghcr.io/devcontainers/features/docker-in-docker:2": {}
+ // },
+ "customizations": {
+ "vscode": {
+ // "settings": {
+ // "python.pythonPath": "/usr/local/bin/python",
+ // "editor.formatOnSave": true
+ // },
+ "extensions": [
+ "ms-python.python",
+ "ms-python.vscode-pylance",
+ "ms-python.autopep8"
+ ]
+ }
+ },
+ //"postCreateCommand": "pip install -r requirements.txt", // Runs after the container is created, to install dependencies
+ "forwardPorts": [
+ 4040
+ ], // List of ports to forward from the container
+ "remoteUser": "vscode" // Default user to run commands as
+}
\ No newline at end of file
diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml
index e69de29..3d3ad48 100644
--- a/.github/workflows/main.yaml
+++ b/.github/workflows/main.yaml
@@ -0,0 +1,34 @@
+name: RamilIndividualProject1_GithubActions
+
+on:
+ push:
+ branches:
+ - main
+ pull_request:
+ branches:
+ - main
+
+jobs:
+ build-and-test:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v3
+
+ - name: Set up Python
+ uses: actions/setup-python@v4
+ with:
+ python-version: '3.12.5'
+
+ - name: Create environment
+ run: make install
+
+ - name: Format the code
+ run: make format
+
+ - name: Run Lint
+ run: make lint
+
+ - name: Run tests
+ run: make test_code
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..34ab06b
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+**cache**
\ No newline at end of file
diff --git a/Makefile b/Makefile
index 65f19a3..73acc73 100644
--- a/Makefile
+++ b/Makefile
@@ -1,18 +1,17 @@
install:
- pip install --upgrade pip && pip install -r requirements.txt
+ pip3 install -r requirements.txt
format:
- black *.py
-
+ black src/*.py
+ black test/*.py
+test_code:
+ pytest -vv --nbval -cov=my_lib -cov=main test/test_*.py *.ipynb
lint:
- ruff check *.py
-
+ ruff check src/*.py
+ ruff check test/*.py
container-lint:
docker run --rm -i hadolint/hadolint < .devcontainer/Dockerfile
-test:
- python -m pytest -vv --nbval -cov=my_lib -cov=main test_*.py *.ipynb
-
all: install format lint container-lint test
generate_and_push:
diff --git a/data/correlation_matrix.png b/data/correlation_matrix.png
new file mode 100644
index 0000000..3f5cf83
Binary files /dev/null and b/data/correlation_matrix.png differ
diff --git a/data/histogram.png b/data/histogram.png
new file mode 100644
index 0000000..34bff53
Binary files /dev/null and b/data/histogram.png differ
diff --git a/data/line_graph.png b/data/line_graph.png
new file mode 100644
index 0000000..4201617
Binary files /dev/null and b/data/line_graph.png differ
diff --git a/main.ipynb b/main.ipynb
new file mode 100644
index 0000000..1cdc71b
--- /dev/null
+++ b/main.ipynb
@@ -0,0 +1,304 @@
+{
+ "cells": [
+ {
+ "cell_type": "code",
+ "execution_count": 8,
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "import pandas as pd\n",
+ "from src.lib import (\n",
+ " get_data,\n",
+ " get_max_val,\n",
+ " get_min_val,\n",
+ " get_summary,\n",
+ " get_std_val,\n",
+ " get_histogram,\n",
+ " get_line_graph,\n",
+ " get_correlation_matrix,\n",
+ ")\n",
+ "\n",
+ "\n",
+ "remote_path = \"https://raw.githubusercontent.com/Ramil-cyber/Ramil-Individual-Project-1/refs/heads/main/data/shanghai_ranking_2024.csv\"\n",
+ "\n",
+ "\n",
+ "data = get_data(remote_path)"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": 9,
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "# NBVAL_IGNORE_OUTPUT\n",
+ "\n",
+ "\n",
+ "assert get_max_val(data, col=\"N&S\") == 100.0\n",
+ "assert get_min_val(data, col=\"PUB\") == 9.3"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": 3,
+ "metadata": {},
+ "outputs": [
+ {
+ "data": {
+ "text/html": [
+ "\n",
+ "\n",
+ "
\n",
+ " \n",
+ " \n",
+ " | \n",
+ " Alumni | \n",
+ " Award | \n",
+ " Hici | \n",
+ " N&S | \n",
+ " PUB | \n",
+ " PCP | \n",
+ "
\n",
+ " \n",
+ " \n",
+ " \n",
+ " | count | \n",
+ " 1000.000000 | \n",
+ " 1000.00000 | \n",
+ " 1000.000000 | \n",
+ " 989.000000 | \n",
+ " 1000.000000 | \n",
+ " 1000.000000 | \n",
+ "
\n",
+ " \n",
+ " | mean | \n",
+ " 4.509600 | \n",
+ " 3.78120 | \n",
+ " 10.734400 | \n",
+ " 10.575126 | \n",
+ " 35.113000 | \n",
+ " 19.655300 | \n",
+ "
\n",
+ " \n",
+ " | std | \n",
+ " 10.103201 | \n",
+ " 11.45538 | \n",
+ " 10.949265 | \n",
+ " 10.637247 | \n",
+ " 13.684495 | \n",
+ " 8.800436 | \n",
+ "
\n",
+ " \n",
+ " | min | \n",
+ " 0.000000 | \n",
+ " 0.00000 | \n",
+ " 0.000000 | \n",
+ " 0.000000 | \n",
+ " 9.300000 | \n",
+ " 8.600000 | \n",
+ "
\n",
+ " \n",
+ " | 25% | \n",
+ " 0.000000 | \n",
+ " 0.00000 | \n",
+ " 0.000000 | \n",
+ " 3.900000 | \n",
+ " 25.775000 | \n",
+ " 14.100000 | \n",
+ "
\n",
+ " \n",
+ " | 50% | \n",
+ " 0.000000 | \n",
+ " 0.00000 | \n",
+ " 9.200000 | \n",
+ " 7.300000 | \n",
+ " 31.700000 | \n",
+ " 17.600000 | \n",
+ "
\n",
+ " \n",
+ " | 75% | \n",
+ " 0.000000 | \n",
+ " 0.00000 | \n",
+ " 14.600000 | \n",
+ " 13.300000 | \n",
+ " 41.425000 | \n",
+ " 23.000000 | \n",
+ "
\n",
+ " \n",
+ " | max | \n",
+ " 100.000000 | \n",
+ " 100.00000 | \n",
+ " 100.000000 | \n",
+ " 100.000000 | \n",
+ " 100.000000 | \n",
+ " 100.000000 | \n",
+ "
\n",
+ " \n",
+ "
\n",
+ "