Home Catalog

A Django application for managing home inventory with categorization and tracking features.

Features

• Shared Item Definitions: Item definitions are global and can be reused across different users' catalogs
• Personal Catalog Entries: Each user maintains their own catalog entries with individual tracking (to-buy status, quantities)
• Catalog Grouping: Organize items into custom groups for better categorization
• Catalog Sharing: Invitation system allows users to share catalogs with others
• RESTful API: Full API support for programmatic access
• Google OAuth Authentication: Secure login via Google accounts
• Docker Deployment: Containerized application for easy deployment
• Ansible Automation: Automated deployment and management scripts

Development Setup

1. Install uv:

pip install uv

2. Install dependencies:

uv sync --all-extras

3. Set up the database:

uv run manage.py migrate

4. Create a superuser:

uv run manage.py createsuperuser

Management Commands

Development Server

uv run manage.py dev

Format and Lint Code

uv run manage.py format

To automatically fix any fixable linting errors, run:

uv run manage.py format --fix

Deploy

uv run manage.py deploy

Testing

The project includes comprehensive tests for models, views, and functionality.

Before running the tests, make sure your database schema is up-to-date and static files are collected:

uv run manage.py migrate
uv run manage.py collectstatic

Using Django's test runner:

uv run manage.py test

Using pytest:

uv run pytest

With coverage report:

# Run tests with coverage report
uv run manage.py test_coverage

# Run tests with coverage report and generate HTML report
uv run manage.py test_coverage --html

Loading test data:

uv run manage.py loaddata catalog/fixtures/test_data.json

Docker Operations

Building Docker image:

uv run manage.py build

Running locally with Docker:

uv run manage.py docker

Project Structure

• catalog/ - Main application directory
  • models.py - Database models
  • tests.py - Test suite
  • admin.py - Admin interface configuration
  • management/commands/ - Custom management commands
• home_catalog/ - Project settings and configuration
• fixtures/ - Test data
• Dockerfile - Docker configuration
• ansible/ - Deployment automation

Contributing

1. Create a feature branch
2. Make your changes
3. Run tests to ensure everything works
4. Submit a pull request