Metadata-Version: 2.3
Name: mykitchen
Version: 0.0.1
Author-email: author <author@example.com>
License-File: LICENSE
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.11
Requires-Dist: boto3
Requires-Dist: chromadb
Requires-Dist: diskcache
Requires-Dist: django-allauth[socialaccount]
Requires-Dist: django-compressor
Requires-Dist: django-extensions
Requires-Dist: django-health-check
Requires-Dist: django-lifecycle
Requires-Dist: django-ninja
Requires-Dist: django-q-registry
Requires-Dist: django-q2
Requires-Dist: django-storages[s3]
Requires-Dist: django-template-partials
Requires-Dist: django-unique-user-email
Requires-Dist: django[argon2]
Requires-Dist: djp
Requires-Dist: environs[django]
Requires-Dist: gunicorn
Requires-Dist: kitchenai-sdk==0.1.5a1
Requires-Dist: llama-index
Requires-Dist: llama-index-vector-stores-chroma
Requires-Dist: pillow
Requires-Dist: psycopg[binary]
Requires-Dist: sentry-sdk
Requires-Dist: starlette
Requires-Dist: tomli
Requires-Dist: uvicorn
Requires-Dist: whitenoise
Description-Content-Type: text/markdown

# mykitchen

[![falco](https://img.shields.io/badge/built%20with-falco-success)](https://github.com/Tobi-De/falco)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)

## Prerequisites

- `Python 3.11+`
- [hatch 1.9.1+](https://hatch.pypa.io/latest/)
- [just](https://github.com/casey/just)

## Development

### Setup project

Ensure that the Python version specified in your `.pre-commit-config.yaml` file aligns with the Python in your virtual environment.
Hatch can [manage your python installation](https://hatch.pypa.io/latest/tutorials/python/manage/) if needed.

```shell
just setup
```
Read the content of the justfile to understand what this command does. Essentially, it sets up your virtual environment, 
installs the dependencies, runs migrations, and creates a superuser with the credentials `admin@localhost` (email) and `admin` (password).

### Run the django development server

```shell
just server
```

> [!TIP]
> Run `just` to see all available commands.
