artemis-model 0.1.178__tar.gz

artemis_model-0.1.178/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: artemis-model
+Version: 0.1.178
+Summary: 
+Author: Jukeboxy
+Requires-Python: >=3.10.6,<4.0.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: alembic (>=1.13.1,<2.0.0)
+Requires-Dist: asyncpg (>=0.30.0,<0.31.0)
+Requires-Dist: greenlet (>=3.0.2,<4.0.0)
+Requires-Dist: pydantic (>=2.10.2,<3.0.0)
+Requires-Dist: python-slugify (>=8.0.4,<9.0.0)
+Requires-Dist: sqlalchemy (>=2.0.23,<3.0.0)
+Description-Content-Type: text/markdown
+
+# 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:
+
+1. **Environment Setup**
+
+```shell
+cp ./alembic/.env.example ./alembic/.env
+```
+
+After copying the example environment file, make sure to fill in the `.env` file with your specific configurations.
+
+2. **Install Dependencies**
+
+```shell
+poetry install --all-extras
+```
+
+This will install all necessary dependencies to get you started with `artemis-models` and `alembic`.
+
+## 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
+
+1. **Define the Mixin**
+This mixin will include all the common attributes of your model.
+
+```python
+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")
+```
+
+2. **Inherit from Base Classes**
+Create two classes that inherit from CustomBase and CustomSyncBase respectively, using the mixin for shared attributes.
+
+```python
+class LoginHistorySync(CustomSyncBase, LoginHistoryMixin):
+    pass
+
+class LoginHistory(CustomBase, LoginHistoryMixin):
+    pass
+```
+
+## Version Management and Builds
+
+1. **Update the Project Version**
+
+Open pyproject.toml and increment the minor version number.
+
+2. **Build the Project**
+
+```shell
+poetry build
+```
+
+3. **Update Dependency in artemis-api/prophet**
+
+If the build succeeds, remember to also bump the version number in the pyproject.toml of artemis-api and prophet to match the new version of artemis-model.
+
+## Using Alembic for Model Changes
+
+If modifications are necessary for any model:
+
+1. **Modify the Model**
+2. **Create an Alembic Revision**
+
+```shell
+alembic revision --autogenerate -m "Description of changes"
+```
+
+3. **Upgrade Database Schema**
+
+```shell
+alembic upgrade head
+```
+
+Ensure that the new Alembic script in the versions directory is committed to your git repository.
+Repeat the build and version update steps as necessary after making changes.
+
+

artemis_model-0.1.178/README.md

@@ -0,0 +1,96 @@
+# 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:
+
+1. **Environment Setup**
+
+```shell
+cp ./alembic/.env.example ./alembic/.env
+```
+
+After copying the example environment file, make sure to fill in the `.env` file with your specific configurations.
+
+2. **Install Dependencies**
+
+```shell
+poetry install --all-extras
+```
+
+This will install all necessary dependencies to get you started with `artemis-models` and `alembic`.
+
+## 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
+
+1. **Define the Mixin**
+This mixin will include all the common attributes of your model.
+
+```python
+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")
+```
+
+2. **Inherit from Base Classes**
+Create two classes that inherit from CustomBase and CustomSyncBase respectively, using the mixin for shared attributes.
+
+```python
+class LoginHistorySync(CustomSyncBase, LoginHistoryMixin):
+    pass
+
+class LoginHistory(CustomBase, LoginHistoryMixin):
+    pass
+```
+
+## Version Management and Builds
+
+1. **Update the Project Version**
+
+Open pyproject.toml and increment the minor version number.
+
+2. **Build the Project**
+
+```shell
+poetry build
+```
+
+3. **Update Dependency in artemis-api/prophet**
+
+If the build succeeds, remember to also bump the version number in the pyproject.toml of artemis-api and prophet to match the new version of artemis-model.
+
+## Using Alembic for Model Changes
+
+If modifications are necessary for any model:
+
+1. **Modify the Model**
+2. **Create an Alembic Revision**
+
+```shell
+alembic revision --autogenerate -m "Description of changes"
+```
+
+3. **Upgrade Database Schema**
+
+```shell
+alembic upgrade head
+```
+
+Ensure that the new Alembic script in the versions directory is committed to your git repository.
+Repeat the build and version update steps as necessary after making changes.
+

artemis_model-0.1.178/artemis_model/__init__.py

@@ -0,0 +1,22 @@
+from artemis_model.album import *  # noqa
+from artemis_model.approved_playlist_list import *  # noqa
+from artemis_model.artist import *  # noqa
+from artemis_model.auth import *  # noqa
+from artemis_model.category import *  # noqa
+from artemis_model.dj_set import *  # noqa
+from artemis_model.genre import *  # noqa
+from artemis_model.location import *  # noqa
+from artemis_model.location_genre_exclusion import *  # noqa
+from artemis_model.message import *  # noqa
+from artemis_model.organization import *  # noqa
+from artemis_model.organization_include_pal_setting import *  # noqa
+from artemis_model.playlist import *  # noqa
+from artemis_model.schedule import *  # noqa
+from artemis_model.setting import *  # noqa
+from artemis_model.track import *  # noqa
+from artemis_model.user import *  # noqa
+from artemis_model.zone import *  # noqa
+from artemis_model.otp import *  # noqa
+from artemis_model.banned_tracks import *  # noqa
+from artemis_model.zone_activity import *  # noqa
+from artemis_model.zone_state import *  # noqa

artemis_model-0.1.178/artemis_model/album.py

@@ -0,0 +1,69 @@
+"""Album models"""
+
+from datetime import datetime
+
+from sqlalchemy import Computed, ForeignKey, func, literal, text
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+
+from artemis_model.base import CustomSyncBase, CustomBase, TSVector, TimeStampMixin
+
+from sqlalchemy.ext.declarative import declared_attr
+
+
+def to_tsvector_ix(*columns):
+    s = " || ' ' || ".join(columns)
+    return func.to_tsvector(literal("english"), text(s))
+
+
+class AlbumMixin(TimeStampMixin):
+    id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    name: Mapped[str] = mapped_column(nullable=False)
+    description: Mapped[str | None] = mapped_column(nullable=True)
+    entry_date: Mapped[datetime] = mapped_column(nullable=False, default=datetime.utcnow)
+    disabled: Mapped[bool] = mapped_column(nullable=False, default=False)
+    legacy_id: Mapped[str] = mapped_column(nullable=False)
+    is_internal: Mapped[bool] = mapped_column(nullable=False, default=False)
+
+    name_tsv = mapped_column(
+        TSVector(),
+        Computed("to_tsvector('english', name)", persisted=True),
+    )
+
+    # __table_args__ = (
+    #     Index("fts_ix_album_name_tsv", to_tsvector_ix("name"), postgresql_using="gin"),
+    # )
+
+    @declared_attr
+    def artists(cls) -> Mapped[list["Artist"]]:
+        return relationship(secondary="album_artist_assoc", back_populates="albums")
+
+    @declared_attr
+    def tracks(cls) -> Mapped[list["Track"]]:
+        return relationship(
+            "Track",
+            back_populates="album",
+            cascade="all, delete-orphan",
+        )
+
+
+class AlbumSync(CustomSyncBase, AlbumMixin):
+    pass
+
+
+class Album(CustomBase, AlbumMixin):
+    pass
+
+
+class AlbumArtistAssocMixin:
+    album_id: Mapped[int] = mapped_column(ForeignKey("album.id"), primary_key=True, nullable=False)
+    artist_id: Mapped[int] = mapped_column(
+        ForeignKey("artist.id"), primary_key=True, nullable=False
+    )
+
+
+class AlbumArtistAssocSync(CustomSyncBase, AlbumArtistAssocMixin):
+    pass
+
+
+class AlbumArtistAssoc(CustomBase, AlbumArtistAssocMixin):
+    pass

artemis_model-0.1.178/artemis_model/approved_playlist_list.py

@@ -0,0 +1,55 @@
+import uuid
+from typing import List
+
+from sqlalchemy import ForeignKey
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+from sqlalchemy.ext.declarative import declared_attr
+
+from artemis_model.base import CustomSyncBase, TimeStampMixin, AuditMixin, CustomBase
+
+
+class ApprovedPlaylistListMixin(TimeStampMixin, AuditMixin):
+    id: Mapped[int] = mapped_column(autoincrement=True, primary_key=True, index=True)
+    name: Mapped[str] = mapped_column(nullable=False)
+    organization_id: Mapped[uuid.UUID] = mapped_column(
+        ForeignKey("organization.id"), nullable=False, index=True
+    )
+
+    @declared_attr
+    def organization(cls) -> Mapped["Organization"]:
+        return relationship("Organization", back_populates="approved_playlist_lists")
+
+    @declared_attr
+    def playlist_associations(cls) -> Mapped[List["ApprovedPlaylistListPlaylistAssoc"]]:
+        return relationship(cascade="all, delete-orphan")
+
+    @declared_attr
+    def playlists(cls) -> Mapped[List["Playlist"]]:
+        return relationship(
+            "Playlist", secondary="approved_playlist_list_playlist_assoc", viewonly=True
+        )
+
+
+class ApprovedPlaylistListSync(CustomSyncBase, ApprovedPlaylistListMixin):
+    pass
+
+
+class ApprovedPlaylistList(CustomBase, ApprovedPlaylistListMixin):
+    pass
+
+
+class ApprovedPlaylistListPlaylistAssocMixin(TimeStampMixin):
+    approved_playlist_list_id: Mapped[int] = mapped_column(
+        ForeignKey("approved_playlist_list.id"), primary_key=True, nullable=False
+    )
+    playlist_id: Mapped[int] = mapped_column(
+        ForeignKey("playlist.id"), primary_key=True, nullable=False
+    )
+
+
+class ApprovedPlaylistListPlaylistAssocSync(CustomSyncBase, ApprovedPlaylistListPlaylistAssocMixin):
+    pass
+
+
+class ApprovedPlaylistListPlaylistAssoc(CustomBase, ApprovedPlaylistListPlaylistAssocMixin):
+    pass

artemis_model-0.1.178/artemis_model/artist.py

@@ -0,0 +1,49 @@
+"""Artist models"""
+
+from datetime import datetime
+
+from sqlalchemy import Computed, func, literal, text
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+
+from artemis_model.base import CustomBase, CustomSyncBase, TSVector, TimeStampMixin
+
+from sqlalchemy.ext.declarative import declared_attr
+
+
+def to_tsvector_ix(*columns):
+    s = " || ' ' || ".join(columns)
+    return func.to_tsvector(literal("english"), text(s))
+
+
+class ArtistMixin(TimeStampMixin):
+    id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    name: Mapped[str] = mapped_column(nullable=False)
+    entry_date: Mapped[datetime] = mapped_column(nullable=False, default=datetime.utcnow)
+    disabled: Mapped[bool] = mapped_column(nullable=False, default=False)
+    is_internal: Mapped[bool] = mapped_column(nullable=False, default=False)
+    legacy_id: Mapped[str] = mapped_column(nullable=False)
+
+    name_tsv = mapped_column(
+        TSVector(),
+        Computed("to_tsvector('english', name)", persisted=True),
+    )
+
+    # __table_args__ = (
+    #     Index("fts_ix_artist_name_tsv", to_tsvector_ix("name"), postgresql_using="gin"),
+    # )
+
+    @declared_attr
+    def albums(cls) -> Mapped[list["Album"]]:
+        return relationship(secondary="album_artist_assoc", back_populates="artists")
+
+    @declared_attr
+    def tracks(cls) -> Mapped[list["Track"]]:
+        return relationship("Track", back_populates="artist", cascade="all, delete-orphan")
+
+
+class ArtistSync(CustomSyncBase, ArtistMixin):
+    pass
+
+
+class Artist(CustomBase, ArtistMixin):
+    pass

artemis_model-0.1.178/artemis_model/auth.py

@@ -0,0 +1,184 @@
+"""Auth models."""
+
+from enum import Enum
+import uuid
+from datetime import datetime
+from typing import Optional
+
+from pydantic import BaseModel
+from sqlalchemy import UUID, DateTime, ForeignKey, LargeBinary
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+from sqlalchemy.ext.declarative import declared_attr
+
+from artemis_model.base import CustomSyncBase, TimeStampMixin, CustomBase
+
+
+class UserUnverifiedAccountMixin(TimeStampMixin):
+    """
+    This table is used to store the account info of users who have requested an account but have not yet
+    been verified. Once the user has been verified, the account will be moved to the UserAccount table.
+    """
+
+    id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
+    email: Mapped[str] = mapped_column(index=True)
+    name: Mapped[str] = mapped_column(nullable=False)
+    mobile: Mapped[str] = mapped_column(nullable=True, index=True)
+    is_root_user: Mapped[bool] = mapped_column(default=True)
+    is_email_verified: Mapped[bool] = mapped_column(default=False)
+    is_mobile_verified: Mapped[bool] = mapped_column(default=False)
+    is_onboarded: Mapped[bool] = mapped_column(default=False)
+    password = mapped_column(LargeBinary, nullable=False)
+    provider: Mapped[str] = mapped_column(default="internal")
+
+
+class UserUnverifiedAccountSync(CustomSyncBase, UserUnverifiedAccountMixin):
+    pass
+
+
+class UserUnverifiedAccount(CustomBase, UserUnverifiedAccountMixin):
+    pass
+
+
+class UserAccountMixin(TimeStampMixin):
+    """
+    This table is used to store the account info of users who have been verified.
+    """
+
+    id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
+    email: Mapped[str] = mapped_column(index=True, unique=True)
+    name: Mapped[str] = mapped_column(nullable=False)
+    mobile: Mapped[Optional[str]] = mapped_column(nullable=True, unique=True, index=True)
+    password = mapped_column(LargeBinary, nullable=True)
+    provider: Mapped[str] = mapped_column(nullable=False)
+    oauth_id: Mapped[Optional[str]] = mapped_column(nullable=True, index=True)
+    image_url: Mapped[Optional[str]] = mapped_column(nullable=True)
+    is_email_verified: Mapped[bool] = mapped_column(default=False)
+    is_mobile_verified: Mapped[bool] = mapped_column(default=False)
+    is_root_user: Mapped[bool] = mapped_column(default=True)
+    is_super_admin: Mapped[bool] = mapped_column(default=False)
+    disabled: Mapped[bool] = mapped_column(default=False)
+    disabled_reason: Mapped[Optional[str]] = mapped_column(nullable=True)
+    is_onboarded: Mapped[bool] = mapped_column(default=False)
+
+    @declared_attr
+    def login_histories(cls) -> Mapped["LoginHistory"]:
+        return relationship("LoginHistory", back_populates="account")
+
+    @declared_attr
+    def user(cls) -> Mapped["User"]:
+        return relationship("User", back_populates="account")
+
+
+class UserAccountSync(CustomSyncBase, UserAccountMixin):
+    pass
+
+
+class UserAccount(CustomBase, UserAccountMixin):
+    pass
+
+
+class LoginHistoryMixin:
+    """
+    This table is used to store 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")
+
+
+class LoginHistorySync(CustomSyncBase, LoginHistoryMixin):
+    pass
+
+
+class LoginHistory(CustomBase, LoginHistoryMixin):
+    pass
+
+
+class OAuthCsrfStateMixin(TimeStampMixin):
+    id: Mapped[str] = mapped_column(primary_key=True, unique=True)
+    client_base_url: Mapped[str] = mapped_column(nullable=True)
+
+
+class OAuthCsrfStateSync(CustomSyncBase, OAuthCsrfStateMixin):
+    pass
+
+
+class OAuthCsrfState(CustomBase, OAuthCsrfStateMixin):
+    pass
+
+
+class OrionWebplayerCodeMixin(TimeStampMixin):
+    """Orion webplayer code mixin."""
+
+    id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
+    code_hash: Mapped[str] = mapped_column(
+        unique=True, nullable=False
+    )  # Argon2id of normalized code
+    name: Mapped[str] = mapped_column(nullable=False)
+    zone_id: Mapped[int] = mapped_column(nullable=False, index=True)
+
+
+class OrionWebplayerCodeSync(CustomSyncBase, OrionWebplayerCodeMixin):
+    pass
+
+
+class OrionWebplayerCode(CustomBase, OrionWebplayerCodeMixin):
+    pass
+
+
+class PlayerRefreshTokenMixin(TimeStampMixin):
+    """
+    Refresh token for Player.
+    We look up by token_id (PK), then verify `secret` against `secret_hash`.
+    """
+
+    # this is the public part we send to the client
+    id: Mapped[uuid.UUID] = mapped_column(
+        UUID(as_uuid=True),
+        primary_key=True,
+        default=uuid.uuid4,
+    )
+
+    code_id: Mapped[Optional[uuid.UUID]] = mapped_column(
+        UUID(as_uuid=True),
+        ForeignKey("orion_webplayer_code.id", ondelete="SET NULL"),
+        index=True,
+        nullable=True,
+    )
+
+    # store zone_id too (helps auth decisions / debugging)
+    zone_id: Mapped[Optional[int]] = mapped_column(index=True)
+
+    # bcrypt/argon2 hash of the secret part
+    secret_hash: Mapped[str] = mapped_column(nullable=False)
+
+
+class PlayerRefreshTokenSync(CustomSyncBase, PlayerRefreshTokenMixin):
+    pass
+
+
+class PlayerRefreshToken(CustomBase, PlayerRefreshTokenMixin):
+    pass
+
+
+class Scope(str, Enum):
+    """Scope enum."""
+
+    PLAYER = "player"
+    MANAGE = "manage"
+
+class TokenData(BaseModel):
+    """Token data."""
+
+    account_id: uuid.UUID
+    user_id: uuid.UUID
+    scope: Scope
+    

artemis_model-0.1.178/artemis_model/banned_tracks.py

@@ -0,0 +1,24 @@
+"""Banned Tracks per Zone Model"""
+
+from sqlalchemy import UUID, Integer
+from sqlalchemy.orm import Mapped, mapped_column
+from artemis_model.base import AuditMixin, TimeStampMixin, CustomSyncBase, CustomBase
+
+
+class BannedTracksMixin(TimeStampMixin, AuditMixin):
+    """Banned Tracks per Zone Model"""
+
+    zone_id: Mapped[int] = mapped_column(Integer, primary_key=True)
+    track_id: Mapped[UUID] = mapped_column(UUID(as_uuid=True), primary_key=True)
+
+
+class BannedTracksSync(CustomSyncBase, BannedTracksMixin):
+    """Banned Tracks per Zone Model"""
+
+    pass
+
+
+class BannedTracks(CustomBase, BannedTracksMixin):
+    """Banned Tracks per Zone Model"""
+
+    pass