artemis-model

Welcome to artemis-model, the backbone repository that contains all the essential models used in both the artemis-api and the prophet project. This project includes asynchronous models used by artemis-api, such as Artist, and synchronous models like ArtistSync for other implementations.

Getting Started

To set up your development environment for artemis-model, follow these initial setup steps:

Install Dependencies

poetry install

Environment Setup (for running migrations)

Create a .env file in the artemis-model directory:

# .env
MIGRATION_MODE=aws
STAGE=dev

This will use AWS Secrets Manager to fetch dev database credentials.

Creating a New Model

To introduce a new model in the project, you should start by creating a mixin and then define two different model classes that inherit from this mixin.

Example: Adding a `LoginHistory` Model

Define the Mixin This mixin will include all the common attributes of your model.

class LoginHistoryMixin:
    """
    Stores the login history of users.
    """

    id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True, nullable=False)
    account_id: Mapped[uuid.UUID] = mapped_column(ForeignKey("user_account.id"), nullable=False, index=True)
    ip_address: Mapped[str] = mapped_column(nullable=True)
    created_at = mapped_column(DateTime, default=datetime.utcnow)

    @declared_attr
    def account(cls) -> Mapped["UserAccount"]:
        return relationship("UserAccount", back_populates="login_histories")

Inherit from Base Classes Create two classes that inherit from CustomBase and CustomSyncBase respectively, using the mixin for shared attributes.

class LoginHistorySync(CustomSyncBase, LoginHistoryMixin):
    pass

class LoginHistory(CustomBase, LoginHistoryMixin):
    pass

Version Management and Builds

Update the Project Version

# For patch version bump
make bump-model-patch

# For minor version bump
make bump-model-minor

# For major version bump
make bump-model-major

Build the Project

poetry build

Update Dependency in artemis-api

The make bump-model-* commands automatically update the dependency in artemis-api. If you need to do it manually, update the version in artemis-api/pyproject.toml.

Database Migrations

All database schema changes are managed through Alembic migrations in this project.

For complete documentation, see MIGRATIONS.md

Quick Reference

# Generate migration from model changes
alembic revision --autogenerate -m "add_user_email_column"

# Apply migrations to dev DB
alembic upgrade head

# Rollback last migration
alembic downgrade -1

# Check migration status
alembic current

Important Notes

All migrations live in alembic/versions/
We use the dev database for local development (via AWS Secrets Manager)
Always review auto-generated migrations before committing
Migrations are applied to dev/prod via ECS tasks during CI/CD deployment

See MIGRATIONS.md for the complete guide including production deployment workflow.

Metadata

Release files for artemis-model 0.1.300

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for artemis-model 0.1.300
File	Size	Uploaded
artemis_model-0.1.300.tar.gz	19.0 kB	Jan 30, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for artemis-model 0.1.300
File	Interpreter	ABI	Platform	Reset
artemis_model-0.1.300-py3-none-any.whl 33.4 kB Jan 30, 2026	Python 3	none	any	Details

Total release size: 52.4 kB

Release files / artemis_model-0.1.300.tar.gz

Download URL	artemis_model-0.1.300.tar.gz
Size	19.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`e0f74d91cef357d0554f789839d38d7eb57533302e232e96c2413e37ff9c788e`
BLAKE2b-256 checksum How to use checksums	`6076e2f242478ab7d73cac5bd13ca98dc22e36ca246589824058f4affcb857a8`
Upload date	Jan 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.13.7`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/jukeboxy/artemis
Publishing commit: github.com/jukeboxy/artemis/tree/176e6406a28b9d5b0eaad125140de175da8f5a9c

Workflow

Publishing configuration: github.com/jukeboxy/artemis/blob/176e6406a28b9d5b0eaad125140de175da8f5a9c/.github/workflows/deploy-model-pypi.yml
Publishing logs: github.com/jukeboxy/artemis/actions/runs/21526934197/attempts/1

Artifact

Subject: artemis_model-0.1.300.tar.gz
SHA-256 checksum: e0f74d91cef357d0554f789839d38d7eb57533302e232e96c2413e37ff9c788e Verifying attestations

Release files / artemis_model-0.1.300-py3-none-any.whl

Download URL	artemis_model-0.1.300-py3-none-any.whl
Size	33.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`8963d2a8eebc8ddd364d9e3337e567a7f1f6aa01d673998b2cb8b201100285fe`
BLAKE2b-256 checksum How to use checksums	`835fc144f4df61846d1dc68cca38c3eed181783ba680e999b194df525c3e2b13`
Upload date	Jan 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.13.7`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/jukeboxy/artemis
Publishing commit: github.com/jukeboxy/artemis/tree/176e6406a28b9d5b0eaad125140de175da8f5a9c

Workflow

Publishing configuration: github.com/jukeboxy/artemis/blob/176e6406a28b9d5b0eaad125140de175da8f5a9c/.github/workflows/deploy-model-pypi.yml
Publishing logs: github.com/jukeboxy/artemis/actions/runs/21526934197/attempts/1

Artifact

Subject: artemis_model-0.1.300-py3-none-any.whl
SHA-256 checksum: 8963d2a8eebc8ddd364d9e3337e567a7f1f6aa01d673998b2cb8b201100285fe Verifying attestations