artemis-model 0.1.66__py3-none-any.whl

artemis_model/setting.py

@@ -0,0 +1,45 @@
+from sqlalchemy import ForeignKey, JSON
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+
+from artemis_model.base import TimeStampMixin, CustomSyncBase, CustomBase
+
+from sqlalchemy.ext.declarative import declared_attr
+
+
+class SettingMixin(TimeStampMixin):
+    """
+        Exclusion Schema
+        {
+            "genres": {
+                "<genre_id>": "<genre_name>",
+                "<genre_id>": "<genre_name>",
+                ...
+            },
+            "artists": {
+                "<artist_id>": "<artist_name>",
+                "<artist_id>": "<artist_name>",
+                ...
+            },
+            "tracks": {
+                "<track_id>": "<track_name>",
+                "<track_id>": "<track_name>",
+                ...
+            },
+            "exclude_pal": True/False
+        }
+    """
+    id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    zone_id: Mapped[int] = mapped_column(ForeignKey("zone.id"), index=True)
+    exclusion: Mapped[JSON] = mapped_column(JSON, nullable=True)
+
+    @declared_attr
+    def zone(cls) -> Mapped["Zone"]:
+        return relationship(back_populates="setting")
+
+
+class SettingSync(CustomSyncBase, SettingMixin):
+    pass
+
+
+class Setting(CustomBase, SettingMixin):
+    pass

artemis_model/track.py

@@ -0,0 +1,123 @@
+import uuid
+from datetime import datetime
+from typing import List
+
+from sqlalchemy import UUID, Computed, ForeignKey, 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 TrackMixin(TimeStampMixin):
+    id: Mapped[uuid.UUID] = mapped_column(
+        UUID(as_uuid=True), primary_key=True, default=uuid.uuid4
+    )
+    name: Mapped[str] = mapped_column(nullable=False)
+    album_id: Mapped[uuid.UUID] = mapped_column(ForeignKey("album.id"), nullable=False)
+    artist_id: Mapped[uuid.UUID] = mapped_column(
+        ForeignKey("artist.id"), nullable=False
+    )
+    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)
+    is_parental_advisory: Mapped[bool] = mapped_column(nullable=False, default=False)
+    decade: Mapped[int] = mapped_column(nullable=True)
+    duration: Mapped[int] = mapped_column(nullable=True)
+
+    name_tsv = mapped_column(
+        TSVector(),
+        Computed("to_tsvector('english', name)", persisted=True),
+    )
+
+    @declared_attr
+    def track_playlist_associations(cls) -> Mapped[list["PlaylistTrackAssoc"]]:
+        return relationship(
+            back_populates="track", cascade="all, delete-orphan"
+        )
+
+    @declared_attr
+    def dj_set_track_associations(cls) -> Mapped[list["DjSetTrackAssoc"]]:
+        return relationship(
+            back_populates="track", cascade="all, delete-orphan"
+        )
+
+    @declared_attr
+    def album(cls) -> Mapped["Album"]:
+        return relationship("Album", back_populates="tracks")
+
+    @declared_attr
+    def artist(cls) -> Mapped["Artist"]:
+        return relationship("Artist", back_populates="tracks")
+
+    @declared_attr
+    def genres(cls) -> Mapped[List["Genre"]]:
+        return relationship(
+            "Genre", secondary="track_genre_assoc", back_populates="tracks"
+        )
+
+    @declared_attr
+    def label(cls) -> Mapped["TrackLabel"]:
+        return relationship(
+            "TrackLabel",
+            back_populates="track",
+            cascade="all, delete-orphan",
+        )
+
+    # __table_args__ = (
+    #     Index("fts_ix_track_name_tsv", to_tsvector_ix("name"), postgresql_using="gin"),
+    # )
+
+
+class TrackSync(CustomSyncBase, TrackMixin):
+    pass
+
+
+class Track(CustomBase, TrackMixin):
+    pass
+
+
+class TrackGenreAssocMixin:
+    track_id: Mapped[uuid.UUID] = mapped_column(
+        UUID(as_uuid=True), ForeignKey("track.id"), primary_key=True
+    )
+    genre_id: Mapped[int] = mapped_column(ForeignKey("genre.id"), primary_key=True)
+
+
+class TrackGenreAssocSync(CustomSyncBase, TrackGenreAssocMixin):
+    pass
+
+
+class TrackGenreAssoc(CustomBase, TrackGenreAssocMixin):
+    pass
+
+
+class TrackLabelMixin:
+    id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    track_id: Mapped[uuid.UUID] = mapped_column(
+        UUID(as_uuid=True), ForeignKey("track.id"), primary_key=True
+    )
+    name: Mapped[str] = mapped_column(nullable=False)
+    isrc: Mapped[str] = mapped_column(nullable=False)
+    legacy_id: Mapped[str] = mapped_column(nullable=False)
+
+    @declared_attr
+    def track(cls) -> Mapped[Track]:
+        return relationship("Track", back_populates="label")
+
+
+class TrackLabelSync(CustomSyncBase, TrackLabelMixin):
+    pass
+
+
+class TrackLabel(CustomBase, TrackLabelMixin):
+    pass

artemis_model/user.py

@@ -0,0 +1,73 @@
+import uuid
+from typing import List
+
+from sqlalchemy import UUID, ForeignKey
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+from sqlalchemy.ext.associationproxy import AssociationProxy, association_proxy
+from artemis_model.base import TimeStampMixin, CustomSyncBase, CustomBase
+from artemis_model.permission import UserPermissionAssoc
+from sqlalchemy.ext.declarative import declared_attr
+
+
+class UserMixin(TimeStampMixin):
+    """
+    This table is used to store the user itself.
+    """
+
+    id: Mapped[uuid.UUID] = mapped_column(
+        UUID(as_uuid=True), primary_key=True, default=uuid.uuid4
+    )
+    account_id: Mapped[uuid.UUID] = mapped_column(
+        ForeignKey("user_account.id"), nullable=False, index=True
+    )
+
+    @declared_attr
+    def user_location_associations(cls) -> Mapped[List["UserLocationAssoc"]]:
+        return relationship(
+            back_populates="user",
+            cascade="all, delete-orphan",
+        )
+
+    @declared_attr
+    def user_permission_associations(cls) -> Mapped[List["UserPermissionAssoc"]]:
+        return relationship(
+            cascade="all, delete-orphan",
+        )
+
+    @declared_attr
+    def account(cls) -> Mapped["UserAccount"]:
+        return relationship("UserAccount", back_populates="user")
+
+    @declared_attr
+    def organizations(cls) -> Mapped[List["Organization"]]:
+        return relationship(
+            secondary="organization_user_assoc", back_populates="users"
+        )
+
+    @declared_attr
+    def locations(cls) -> Mapped[List["Location"]]:
+        return relationship(
+            secondary="user_location_assoc", viewonly=True
+        )
+
+    @declared_attr
+    def permission_ids(cls) -> AssociationProxy[List["Permission"] | None]:
+        return association_proxy(
+            "user_permission_associations",
+            "permission",
+            creator=lambda permission_id: UserPermissionAssoc(permission_id=permission_id),
+        )
+
+    @declared_attr
+    def permissions(cls) -> Mapped[list["Permission"]]:
+        return relationship(
+            secondary="user_permission_assoc", viewonly=True
+        )
+
+
+class UserSync(CustomSyncBase, UserMixin):
+    pass
+
+
+class User(CustomBase, UserMixin):
+    pass

artemis_model/zone.py

@@ -0,0 +1,69 @@
+import uuid
+
+from sqlalchemy import UUID, Boolean, ForeignKey, Integer, String, DateTime
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+
+from artemis_model.base import CustomBase, TimeStampMixin, CustomSyncBase
+
+from sqlalchemy.ext.declarative import declared_attr
+
+
+class ZoneMixin(TimeStampMixin):
+    id: Mapped[int] = mapped_column(Integer, autoincrement=True, primary_key=True)
+    name: Mapped[str] = mapped_column(String, nullable=False)
+    disabled: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False)
+
+    # Player relations will be added later.
+    location_id: Mapped[uuid.UUID] = mapped_column(
+        UUID(as_uuid=True), ForeignKey("location.id"), index=True
+    )
+    message_frequency: Mapped[int] = mapped_column(nullable=False, default=1)
+    legacy_id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), nullable=True)
+
+    @declared_attr
+    def location(cls) -> Mapped["Location"]:
+        return relationship(back_populates="zones")
+
+    @declared_attr
+    def schedules(cls) -> Mapped[list["Schedule"]]:
+        return relationship(back_populates="zone")
+
+    @declared_attr
+    def message_play_details(cşs) -> Mapped[list["MessagePlayDetail"]]:
+        return relationship(back_populates="zone")
+
+    @declared_attr
+    def license(cls) -> Mapped["License"]:
+        return relationship(back_populates="zone", uselist=False)
+
+    @declared_attr
+    def setting(cls) -> Mapped["Setting"]:
+        return relationship(back_populates="zone", uselist=False)
+
+
+class ZoneSync(CustomSyncBase, ZoneMixin):
+    pass
+
+
+class Zone(CustomBase, ZoneMixin):
+    pass
+
+
+class LicenseMixin(TimeStampMixin):
+    id: Mapped[int] = mapped_column(autoincrement=True, primary_key=True)
+    zone_id: Mapped[int] = mapped_column(ForeignKey("zone.id"), nullable=False)
+    license_type: Mapped[str] = mapped_column(nullable=False, default="FREE")
+    valid_until: Mapped[DateTime] = mapped_column(DateTime, nullable=True)
+    expired: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False)
+
+    @declared_attr
+    def zone(cls) -> Mapped["Zone"]:
+        return relationship(back_populates="license", uselist=False)
+
+
+class LicenseSync(CustomSyncBase, LicenseMixin):
+    pass
+
+
+class License(CustomBase, LicenseMixin):
+    pass

artemis_model-0.1.66.dist-info/METADATA

@@ -0,0 +1,113 @@
+Metadata-Version: 2.1
+Name: artemis-model
+Version: 0.1.66
+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
+Requires-Dist: alembic (>=1.13.1,<2.0.0)
+Requires-Dist: asyncpg (>=0.29.0,<0.30.0)
+Requires-Dist: greenlet (>=3.0.2,<4.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.66.dist-info/RECORD

@@ -0,0 +1,22 @@
+artemis_model/__init__.py,sha256=ioJbxHgpk27FMPMDlM--9ZzSDKZet98VzW0wDjU2DqI,693
+artemis_model/album.py,sha256=cnjrE0catTK24uWTrAoRcZUQB3CPt5l8s9PeM2sxLrc,2103
+artemis_model/artist.py,sha256=Mx2bnl7bxqm2ELjDIePGFfIkQU_DbnfOTc507dzh14g,1577
+artemis_model/auth.py,sha256=WVonoYbCE0uvRuPR2Fz1hZJ-xmbyTuBVt6H51X6OfEs,4087
+artemis_model/base.py,sha256=21Isonytb_iWfmde4u8LiU6a27h7mkgnwncTAKi9ezY,6768
+artemis_model/category.py,sha256=jhCZrK-LxPmc0pXmVifAZWdCENssBTzdTmC3nqqZc6s,1761
+artemis_model/dj_set.py,sha256=-0rU2xOAJ4vecite8yKFmp9yFLPZurFrdFmYAjPHtso,3848
+artemis_model/genre.py,sha256=oMs1ZZfr0SZWmWzW9PEPuaNcatfeIx53nk5M3DPodrQ,1615
+artemis_model/location.py,sha256=T6TlUCXxGyicYtb39dw7XjbCSNECZnMPYahxtOtyEiE,4687
+artemis_model/message.py,sha256=gua3X_1hS7akmS42wQGtL0I-FCJUHdTBM4n2DW4hTxQ,3280
+artemis_model/organization.py,sha256=hu9jKB2qu57BwN0sUUK13p3tC-Hqw9EghFMqjFP9Pr4,2387
+artemis_model/otp.py,sha256=TjZ_EHeIedjsLIqyZTtzd0s6Uc-1dleMEV8DhzsW44o,1046
+artemis_model/permission.py,sha256=sEBRN-bQJl2TNtRJ5LRuySoEbW1lY4DCoyRk0nOM-kY,1503
+artemis_model/playlist.py,sha256=MPdb9uKZd2f0M2A_V5OUAz-fG7u2FhN2ztlxXblYpps,5890
+artemis_model/schedule.py,sha256=Noj6CAcw4xJS8wvtiLiPNvQyzjImU8wuhKo0c6c2zb4,1155
+artemis_model/setting.py,sha256=McWbeDZP45km3VSSwP1BgAmmjO4qCL0pTnOmJVAz0WI,1265
+artemis_model/track.py,sha256=XOSUEqGvz0XladvriWFNXdwvVKYlwvQlbcqW7E-mEuU,3774
+artemis_model/user.py,sha256=ZtZVwavSPoQmYM1_MarMULy-DJa2pH482G_G8su0b6c,2211
+artemis_model/zone.py,sha256=iGRUtzUwKh9LHT3MOfzzg1DnkPBts_ZBzZVTi2EmIgs,2282
+artemis_model-0.1.66.dist-info/METADATA,sha256=M9JkDUwKqlXod4ST3wWslrD1RdpkAbe_8nlOesjoGFk,3351
+artemis_model-0.1.66.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+artemis_model-0.1.66.dist-info/RECORD,,

artemis_model-0.1.66.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.0
+Root-Is-Purelib: true
+Tag: py3-none-any