Development

# Clone repository
git clone https://github.com/ZineCore2/server.git
cd server
git submodule update --init

# Setup environment
uv venv
source .venv/bin/activate
uv sync

# Configure database
createdb zinecore2
cd backend
DJANGO_SETTINGS_MODULE=zinecore.settings.development \
  ../.venv/bin/python manage.py migrate

# Load data
DJANGO_SETTINGS_MODULE=zinecore.settings.development \
  ../.venv/bin/python manage.py load_vocabularies

# Run tests
DJANGO_SETTINGS_MODULE=zinecore.settings.development \
  ../.venv/bin/python manage.py test

# Start development server
DJANGO_SETTINGS_MODULE=zinecore.settings.development \
  ../.venv/bin/python manage.py runserver

git checkout -b feature/descriptive-name

DJANGO_SETTINGS_MODULE=zinecore.settings.development \
  ../.venv/bin/python manage.py test

pip install django-debug-toolbar

INSTALLED_APPS += ['debug_toolbar']
MIDDLEWARE += ['debug_toolbar.middleware.DebugToolbarMiddleware']
INTERNAL_IPS = ['127.0.0.1']

pip install django-extensions

DJANGO_SETTINGS_MODULE=zinecore.settings.development \
  python manage.py shell_plus

Host: localhost
Port: 5433 (docker-compose) or 5432 (local)
Database: zinecore2
User: postgres
Password: postgres

server/
├── backend/                # Django project
│   ├── catalog/           # Zines (ZineCore2)
│   ├── agents/            # Agents (AgentCore2)
│   ├── holdings/          # Holdings (HoldingCore2)
│   ├── repositories/      # Repositories (RepoCore2)
│   ├── vocabularies/      # Controlled vocabularies
│   ├── geography/         # Geographic data
│   ├── core/              # Shared utilities
│   └── zinecore/          # Project settings
├── spec/                  # Specification (submodule)
└── docs/                  # Additional documentation

# catalog/views.py
from rest_framework.decorators import action
from rest_framework.response import Response

class ZineViewSet(viewsets.ModelViewSet):
    # ... existing code ...

    @action(detail=True, methods=['get'])
    def related(self, request, zine_id=None):
        """Get related zines"""
        zine = self.get_object()
        # Custom logic here
        return Response({'related': []})

curl http://localhost:8000/api/zines/zine_001/related/

cd spec
# Edit vocabularies/canonical/new-vocab.json

node scripts/build-vocabularies.js

# vocabularies/models.py
class NewVocab(BaseVocabulary):
    class Meta:
        verbose_name_plural = "new vocabs"

python manage.py makemigrations
python manage.py migrate
python manage.py load_vocabularies

# catalog/tests.py
class ZineTestCase(TestCase):
    def test_create_zine(self):
        # Test logic
        pass

def complex_function(param):
    """
    Brief description.

    Args:
        param: Description of param

    Returns:
        Description of return value
    """
    pass