dkjason Development Assistant

This skill helps you work with the dkjason Python library, which provides JSON serialization with special support for Django QuerySets, ttcal objects, and custom serialization methods.

Project Context

dkjason is a Python library that extends JSON serialization capabilities to handle Django-specific and custom Python types. The intentional misspelling ("jason" vs "json") is a playful naming choice.

Key Commands

Running Tests

**CRITICAL**: Always clear `DJANGO_SETTINGS_MODULE` before running tests to avoid conflicts with test configuration.

```bash

Run all tests with coverage (Git Bash/WSL/Unix)

DJANGO_SETTINGS_MODULE= c:/srv/venv/dkjason311/Scripts/pytest -v --cov=dkjason tests

Run specific test file

DJANGO_SETTINGS_MODULE= c:/srv/venv/dkjason311/Scripts/pytest tests/test_jason.py -v

Run with coverage report showing missing lines

DJANGO_SETTINGS_MODULE= c:/srv/venv/dkjason311/Scripts/pytest --cov=dkjason --cov-report=term-missing tests

Run single test

DJANGO_SETTINGS_MODULE= c:/srv/venv/dkjason311/Scripts/pytest tests/test_jason.py::test_function_name -v

```

For Windows Command Prompt, use `set DJANGO_SETTINGS_MODULE= &&` prefix instead.

Development Tasks

```bash

Install in development mode

pip install -e .

Build distribution packages

python setup.py sdist bdist_wheel

Publish package

inv publish

```

Architecture Guidelines

Core Module: `dkjason/jason.py`

The main module contains:

Custom Serialization

Objects can implement `__json__()` method for custom serialization. Special types are encoded with `@type:value` format:

Dependencies

Testing Requirements

1. **Always use the dedicated virtualenv** at `/srv/venv/dkjason311`

2. **Clear DJANGO_SETTINGS_MODULE** before running tests - tests configure Django in `conftest.py`

3. Tests use SQLite database configured in `tests/conftest.py`

4. Main test files: `test_jason.py`, `test_dkjason_import.py`

Platform Notes

This project is developed on Windows:

Version Information

Current version is defined in both `dkjason/__init__.py` and `setup.py`. The package supports multiple Python versions with conditional dependencies in `requirements.txt`.

Step-by-Step Workflow

When asked to work on this codebase:

1. **For bug fixes or features**: Read the relevant module (`dkjason/jason.py` or test files) first

2. **Before running tests**: Verify virtualenv path and clear `DJANGO_SETTINGS_MODULE`

3. **After code changes**: Run tests with coverage to verify changes

4. **For serialization issues**: Check if type needs `__json__()` method or encoder update

5. **For version updates**: Update both `__init__.py` and `setup.py`

Important Constraints