GitHubHelp

Jisan09/activity_tracker

Some random django code

★ 0Forks 0PythonGitHub ↗Compare

README

Activity Tracker API

A Django REST Framework (DRF) based backend for tracking user activities with statuses and metadata.

📌 Features

  • Token or Basic authentication support (default: BasicAuth)
  • Filterable logs by status, user, or action
  • Separate endpoint for status-only updates
  • Django admin and browsable API
  • Swagger UI for documentation
  • Test coverage for models and views

⚙️ Setup Instructions

  • Clone the Repository

    git clone https://github.com/jisan09/activity-tracker.git
cd activity-tracker

  • Create and Activate a Virtual Environment

    python3 -m venv .venv
source .venv/bin/activate

  • Install Dependencies

    pip install -r requirements.txt

  • Apply Migrations

    python manage.py migrate

  • Create Superuser

    python manage.py createsuperuser

  • Run Development Server

    python manage.py runserver

  • To populate sample data (optional)

    python manage.py seed_activity

✅ Running Tests

python manage.py test --keepdb

📄 API Documentation

📁 Project Structure

activity_tracker/
├── apps
│     ├── __init__.py
│     └── activity
│         ├── __init__.py
│         ├── admin.py
│         ├── apps.py
│         ├── filters.py
│         ├── management
│         │     └── commands
│         │         └── seed_activity.py
│         ├── migrations
│         │     ├── 0001_initial.py
│         │     └── __init__.py
│         ├── models.py
│         ├── serializers.py
│         ├── tests
│         │     ├── __init__.py
│         │     ├── test_model.py
│         │     └── test_view.py
│         ├── tests.py
│         ├── urls.py
│         └── views.py
├── core
│     ├── __init__.py
│     ├── settings.py
│     ├── urls.py
│     └── wsgi.py
├── README.md
├── manage.py
└── requirements.txt

🔀 Sample API Calls (cURL)

🔹 Create a Log Entry 
curl -su mdjisan:Jisan123 -X POST "http://127.0.0.1:8000/api/logs/" \
-H "Content-Type: application/json" \
-d '{
  "action": "UPLOAD_FILE",
  "status": "PENDING",
  "metadata": {
    "filename": "sample.txt"
  }
}' | python3 -m json.tool
🔹 List All Logs 
curl -su mdjisan:Jisan123 "http://127.0.0.1:8000/api/logs/" | python3 -m json.tool
🔹 Filter Logs by Status 
curl -su mdjisan:Jisan123 "http://127.0.0.1:8000/api/logs/?status=PENDING" | python3 -m json.tool
🔹 Filter Logs by User 
curl -su mdjisan:Jisan123 "http://127.0.0.1:8000/api/logs/?user_id=2" | python3 -m json.tool
🔹 Retrieve Log by ID 
curl -su mdjisan:Jisan123 "http://127.0.0.1:8000/api/logs/20/" | python3 -m json.tool
🔹 Update Log (PUT) 
curl -su mdjisan:Jisan123 -X PUT "http://127.0.0.1:8000/api/logs/20/" \
-H "Content-Type: application/json" \
-d '{
  "action": "UPLOAD_FILE",
  "status": "DONE",
  "metadata": {
    "filename": "updated.txt"
  }
}' | python3 -m json.tool
🔹 Update Status Only (PATCH) 
curl -su mdjisan:Jisan123 -X PATCH "http://127.0.0.1:8000/api/logs/20/update-status/" \
-H "Content-Type: application/json" \
-d '{
  "status": "IN_PROGRESS"
}' | python3 -m json.tool
🔹 Delete Log 
curl -su mdjisan:Jisan123 -X DELETE "http://127.0.0.1:8000/api/logs/33/" | python3 -m json.tool

Contributors

Jisan09

Issues