Update README.md

Author: akshay56789

README.md

@@ -1,72 +1,57 @@
 # Python Anywhere CI/CD pipeline POC
 
+# Automating Code Deployment from GitHub to PythonAnywhere
 
-
-I have created CI/CD pipelines to automatically deploy code updates on Github repository to pythonanywhere web application. 
-
-Automating Code Deployment from GitHub to PythonAnywhere
-
-Overview
+## Overview
 
 This document provides a step-by-step guide to automatically deploy code updates from a GitHub repository to a PythonAnywhere web application using GitHub Actions and the PythonAnywhere API.
 
-1. Prerequisites
+## 1. Prerequisites
 
 Before setting up automation, ensure you have:
 
-A PythonAnywhere account (Free or Paid)
-
-A GitHub repository with your project
+- A PythonAnywhere account (Free or Paid)
+- A GitHub repository with your project
+- API access enabled on PythonAnywhere (for Free users)
+- A web app running on PythonAnywhere
 
-API access enabled on PythonAnywhere (for Free users)
-
-A web app running on PythonAnywhere
-
-2. Enable API Access on PythonAnywhere
+## 2. Enable API Access on PythonAnywhere
 
 To use the PythonAnywhere API:
 
-Go to PythonAnywhere Account Settings
-
-Scroll to API Token and click "Create API Token" (if not already created).
+1. Go to **PythonAnywhere Account Settings**
+2. Scroll to **API Token** and click **"Create API Token"** (if not already created).
+3. Copy the API Token, as it will be needed later.
 
-Copy the API Token, as it will be needed later.
+## 3. Clone Your GitHub Repository on PythonAnywhere
 
-3. Clone Your GitHub Repository on PythonAnywhere
-
-Open the Bash console on PythonAnywhere.
-
-Run the following command to clone your repository:
+Open the Bash console on PythonAnywhere and run the following commands:
 
+```bash
 git clone https://github.com/yourusername/yourrepository.git
-
-Navigate to your project directory:
-
 cd yourrepository
+```
 
-4. Automate Deployment Using GitHub Actions
+## 4. Automate Deployment Using GitHub Actions
 
 GitHub Actions will automatically update your PythonAnywhere code whenever you push changes.
 
-Step 1: Add API Token as a GitHub Secret
-
-Go to your GitHub repository → Settings → Secrets and variables → Actions
-
-Click "New Repository Secret"
-
-Add the API Token:
+### Step 1: Add API Token as a GitHub Secret
 
-Name: PA_API_TOKEN
+1. Go to **GitHub repository → Settings → Secrets and variables → Actions**
+2. Click **"New Repository Secret"**
+3. Add the API Token:
+   - **Name:** `PA_API_TOKEN`
+   - **Value:** Paste your PythonAnywhere API token
+4. Click **"Save"**.
 
-Value: Paste your PythonAnywhere API token
-
-Click "Save".
-
-Step 2: Create a GitHub Actions Workflow
+### Step 2: Create a GitHub Actions Workflow
 
 In your GitHub repository, create a file:
-📄 .github/workflows/deploy.yml
 
+📄 `.github/workflows/deploy.yml`
+
+```yaml
 name: Deploy to PythonAnywhere
 
 on:
@@ -94,63 +79,54 @@ jobs:
       run: |
         curl -s -X POST \
         "https://www.pythonanywhere.com/api/v0/user/${{ secrets.PA_USERNAME }}/webapps/${{ secrets.PA_USERNAME }}.pythonanywhere.com/reload/" \
-        -H "Authorization: Token ${{ secrets.PA_API_TOKEN }}" 
-        
-Step 3: Modify the Workflow File
-
-Replace your_username with your PythonAnywhere username.
-
-Replace yourrepository with your GitHub repository name.
-
-Replace your_console_id (Find it by listing consoles via API: https://www.pythonanywhere.com/api/v0/user/your_username/consoles/).
-
-Ensure the correct branch (main) is specified in the workflow.
+        -H "Authorization: Token ${{ secrets.PA_API_TOKEN }}"
+```
 
-5. Testing the Deployment
+### Step 3: Modify the Workflow File
 
-Push a change to your GitHub repository.
+- Replace **your_username** with your PythonAnywhere username.
+- Replace **yourrepository** with your GitHub repository name.
+- Replace **your_console_id** (Find it by listing consoles via API: `https://www.pythonanywhere.com/api/v0/user/your_username/consoles/`).
+- Ensure the correct branch (**main** or **master**) is specified in the workflow.
 
-Go to GitHub → Actions and verify the workflow execution.
+## 5. Testing the Deployment
 
-If successful, check your PythonAnywhere project for the updated code.
+1. Push a change to your GitHub repository.
+2. Go to **GitHub → Actions** and verify the workflow execution.
+3. If successful, check your PythonAnywhere project for the updated code.
+4. The web app will automatically reload after deployment.
 
-The web app will automatically reload after deployment.
-
-6. Manual Deployment (If Needed)
+## 6. Manual Deployment (If Needed)
 
 If GitHub Actions is not used, you can manually pull updates:
 
+```bash
 cd yourrepository
 git pull origin main
+```
 
 To reload the web app manually:
 
+```bash
 touch /var/www/your_username_pythonanywhere_com_wsgi.py
+```
 
-7. Troubleshooting
-
-Issue
-
-Solution
+## 7. Troubleshooting
 
-Authentication error
+| Issue | Solution |
+|--------|----------|
+| **Authentication error** | Ensure the API token is correctly added in GitHub Secrets. |
+| **Changes not reflecting** | Verify `git pull` works in the PythonAnywhere console. |
+| **Console ID issue** | Use API to list active consoles and find the correct `console_id`. |
 
-Ensure the API token is correctly added in GitHub Secrets.
+## Conclusion
 
-Changes not reflecting
-
-Verify git pull works in the PythonAnywhere console.
+This guide helps automate deployment from GitHub to PythonAnywhere using API calls. Once set up, every push to GitHub updates the PythonAnywhere project automatically and reloads the web app. 🚀
 
-Console ID issue
 
-Use API to list active consoles and find the correct console_id.
 
-Conclusion
 
-This guide helps automate deployment from GitHub to PythonAnywhere using API calls. Once set up, every push to GitHub updates the PythonAnywhere project automatically and reloads the web app. 🚀
 
 
 
-This should start the server on http://127.0.0.1:8000/ or http://localhost:8000/.
 
-Nice work