Skip to content

Feat: Modularize time-logging plugin #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
mdkaifansari04 wants to merge 13 commits into
base: main
Choose a base branch
from
Open

Feat: Modularize time-logging plugin #8

mdkaifansari04 wants to merge 13 commits into from

Conversation

@mdkaifansari04
Copy link

@mdkaifansari04 mdkaifansari04 commented Nov 20, 2025

Django Time Logging

A Django plugin for tracking time spent on GitHub issues with real-time timer functionality.
Fixes: #2

Features

  • Track time spent on specific GitHub issues
  • Real-time timer with live updates
  • Simple AJAX-based interface with no page reloads
  • Automatic duration calculation
  • View time log history
  • Direct integration with GitHub issues

Requirements

  • Python 3.11 or higher
  • Django 4.0 or higher

Installation

Install the plugin using pip:

pip install django-time-logging

Or install from source for development:

git clone https://github.com/OWASP-BLT/Fresh.git
cd Fresh/plugin/django-time-logging
pip install -e .

Configuration

Step 1: Add to Installed Apps

Add time_logging to your Django project's INSTALLED_APPS in settings.py:

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    
    # Add time_logging
    'time_logging',
    
    # Your other apps
]

Step 2: Configure URL Routes

Include the time logging URLs in your project's urls.py:

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    path('time-logging/', include('time_logging.urls')),
    # Your other URL patterns
]

Step 3: Run Migrations

Apply the database migrations:

python manage.py migrate time_logging

Step 4: Create Base Template

The plugin requires a base template at templates/base.html with the following blocks:

<!DOCTYPE html>
<html>
<head>
    <title>{% block title %}{% endblock %}</title>
    <meta name="description" content="{% block description %}{% endblock %}">
    <meta name="keywords" content="{% block keywords %}{% endblock %}">
</head>
<body>
    {% block content %}{% endblock %}
</body>
</html>

Usage

Accessing the Time Logger

Navigate to http://your-domain.com/time-logging/ in your browser.

Starting a Time Log

  1. Enter a valid GitHub issue URL (example: https://github.com/owner/repo/issues/123)
  2. Click the "Start Time Log" button
  3. The timer will begin tracking automatically

Stopping a Time Log

  1. Click the "Stop Time Log" button on the active timer
  2. The duration will be calculated and saved automatically

@mdkaifansari04
Add initial implementation of Django time logging plugin with models,…
95be125 
… admin, and configuration files
@mdkaifansari04
Enhance README with detailed plugin features, installation, and usage…
9960b39 
… instructions; add initial test cases for TimeLog model functionality.
@mdkaifansari04
refactor: updated the timelog model
27682ab
@mdkaifansari04
feat: add base and timelog template
e9c416a
@mdkaifansari04
refactor: remove unused user model import in TimeLog model
6111da3
@mdkaifansari04
refactor: updated the tests
d211d99
@mdkaifansari04
refactor: update the base html for time_logging
95c5976
@mdkaifansari04
feat: implement time logging functionality with AJAX support
758be4b 
refactor: enhance README with detailed installation and usage instructions
refactor: update .gitignore to exclude unnecessary files
refactor: create custom template filters for duration formatting
refactor: add time logging views and URL routing
refactor: create time log templates for improved user interface
@mdkaifansari04
refactor: remove unused djangorestframework dependency and CSRF token…
e73075f 
… handling
@mdkaifansari04
docs: add contributing guidelines and update README for clarity
10847dd
@mdkaifansari04
refactor: rename project from "django-time-logging" to "time-logging"
126bc90
@mdkaifansari04
refactor: update .gitignore to reflect project name change
9fe00d9
@mdkaifansari04
chore: update package name
4ac61f0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Time Logging: Modularize as a Django pluggable app.

1 participant

@mdkaifansari04