unique-quartr 0.1.0__py3-none-any.whl

unique_quartr/constants/document_types.py

@@ -0,0 +1,75 @@
+from enum import IntEnum
+
+
+class DocumentType(IntEnum):
+    SLIDES = 5
+    REPORT = 6
+    QUARTERLY_REPORT_10Q = 7
+    EARNINGS_RELEASE_8K = 10
+    ANNUAL_REPORT_10K = 11
+    ANNUAL_REPORT = 12
+    ANNUAL_REPORT_20F = 13
+    EARNINGS_RELEASE_6K = 14
+    TRANSCRIPT = 15
+    INTERIM_REPORT = 17
+    ANNUAL_REPORT_40F = 18
+    PRESS_RELEASE = 19
+    EARNINGS_RELEASE = 20
+    IN_HOUSE_TRANSCRIPT = 22
+
+    @property
+    def form(self) -> str | None:
+        forms = {
+            self.QUARTERLY_REPORT_10Q: "10-Q",
+            self.EARNINGS_RELEASE_8K: "8-K",
+            self.ANNUAL_REPORT_10K: "10-K",
+            self.ANNUAL_REPORT_20F: "20-F",
+            self.EARNINGS_RELEASE_6K: "6-K",
+            self.ANNUAL_REPORT_40F: "40-F",
+            self.IN_HOUSE_TRANSCRIPT: "In-house transcript",
+        }
+        return forms.get(self)
+
+    @property
+    def name(self) -> str:
+        names = {
+            self.SLIDES: "Slides",
+            self.REPORT: "Report",
+            self.QUARTERLY_REPORT_10Q: "Quarterly report",
+            self.EARNINGS_RELEASE_8K: "Earnings release",
+            self.ANNUAL_REPORT_10K: "Annual report",
+            self.ANNUAL_REPORT: "Annual report",
+            self.ANNUAL_REPORT_20F: "Annual report",
+            self.EARNINGS_RELEASE_6K: "Earnings release",
+            self.TRANSCRIPT: "Transcript",
+            self.INTERIM_REPORT: "Interim report",
+            self.ANNUAL_REPORT_40F: "Annual report",
+            self.PRESS_RELEASE: "Press release",
+            self.EARNINGS_RELEASE: "Earnings release",
+            self.IN_HOUSE_TRANSCRIPT: "In-house transcript",
+        }
+        return names[self]
+
+    @property
+    def emoji(self) -> str:
+        emojis = {
+            self.TRANSCRIPT: "🗒️",
+            self.SLIDES: "📊",
+            self.REPORT: "📄",
+            self.QUARTERLY_REPORT_10Q: "📑",
+            self.EARNINGS_RELEASE_8K: "📢",
+            self.ANNUAL_REPORT_10K: "📘",
+            self.ANNUAL_REPORT_20F: "📙",
+            self.EARNINGS_RELEASE_6K: "📣",
+            self.INTERIM_REPORT: "📜",
+            self.ANNUAL_REPORT_40F: "📕",
+            self.PRESS_RELEASE: "🗞️",
+            self.EARNINGS_RELEASE: "💰",
+            self.IN_HOUSE_TRANSCRIPT: "🎤",
+        }
+        return emojis[self]
+
+    def get_file_prefix(self) -> str:
+        if self.form:
+            return f"{self.name} ({self.form})"
+        return self.name

unique_quartr/constants/event_types.py

@@ -0,0 +1,151 @@
+from enum import IntEnum, StrEnum
+
+
+class EventType(StrEnum):
+    ANALYST_DAY = "Analyst Day"
+    ANNUAL_GENERAL_MEETING = "Annual General Meeting"
+    BUSINESS_COMBINATION = "Business Combination"
+    C_LEVEL_SITDOWN = "C-level Sitdown"
+    CAPITAL_MARKETS_DAY = "Capital Markets Day"
+    CAPITAL_RAISE = "Capital Raise"
+    CONFERENCE = "Conference"
+    EARNINGS_CALL = "Earnings Call"
+    EXTRAORDINARY_GENERAL_MEETING = "Extraordinary General Meeting"
+    FDA_ANNOUNCEMENT = "FDA Announcement"
+    FIRESIDE_CHAT = "Fireside Chat"
+    INVESTOR_DAY = "Investor Day"
+    M_AND_A_ANNOUNCEMENT = "M&A Announcement"
+    OUTLOOK_GUIDANCE_UPDATE = "Outlook / Guidance Update"
+    PARTNERSHIPS_COLLABORATIONS = "Partnerships / Collaborations"
+    PRODUCT_SERVICE_LAUNCH = "Product / Service Launch"
+    SLIDES = "Slides"
+    TRADING_UPDATE = "Trading Update"
+    UPDATE_BRIEFING = "Update / Briefing"
+
+
+class EventSubType(IntEnum):
+    # Analyst Day
+    ANALYST_DAY = 33
+
+    # Annual General Meeting
+    AGM = 4
+    SCHEME_MEETING = 284
+
+    # Business Combination
+    BUSINESS_COMBINATION = 32
+
+    # C-level Sitdown
+    C_LEVEL_SITDOWN = 13
+    CEO_SITDOWN = 14
+
+    # Capital Markets Day
+    CMD = 2
+
+    # Capital Raise
+    CAPITAL_RAISE = 18
+
+    # Conference
+    CONFERENCE = 237
+
+    # Earnings Call
+    Q1 = 26
+    Q2 = 27
+    Q3 = 28
+    Q4 = 29
+    H1 = 35
+    H2 = 36
+
+    # Extraordinary General Meeting
+    EGM = 6
+
+    # FDA Announcement
+    FDA_ANNOUNCEMENT = 19
+
+    # Fireside Chat
+    FIRESIDE_CHAT = 12
+
+    # Investor Day
+    INVESTOR_DAY = 31
+
+    # M&A Announcement
+    M_AND_A_ANNOUNCEMENT = 17
+
+    # Outlook / Guidance Update
+    GUIDANCE = 8
+
+    # Partnerships / Collaborations
+    PARTNERSHIP = 10
+    COLLABORATION = 11
+
+    # Product / Service Launch
+    PRODUCT_LAUNCH = 23
+    SERVICE_LAUNCH = 24
+
+    # Slides
+    INVESTOR_PRESENTATION = 275
+    CORPORATE_PRESENTATION = 279
+    COMPANY_PRESENTATION = 283
+
+    # Trading Update
+    TRADING_UPDATE = 202
+
+    # Update / Briefing
+    STATUS_UPDATE = 21
+    INVESTOR_UPDATE = 239
+    ESG_UPDATE = 240
+    STUDY_UPDATE = 280
+    STUDY_RESULT = 281
+    KOL_EVENT = 285
+
+
+EVENT_TYPE_MAPPING = {
+    EventType.ANALYST_DAY: [EventSubType.ANALYST_DAY],
+    EventType.ANNUAL_GENERAL_MEETING: [
+        EventSubType.AGM,
+        EventSubType.SCHEME_MEETING,
+    ],
+    EventType.BUSINESS_COMBINATION: [EventSubType.BUSINESS_COMBINATION],
+    EventType.C_LEVEL_SITDOWN: [
+        EventSubType.C_LEVEL_SITDOWN,
+        EventSubType.CEO_SITDOWN,
+    ],
+    EventType.CAPITAL_MARKETS_DAY: [EventSubType.CMD],
+    EventType.CAPITAL_RAISE: [EventSubType.CAPITAL_RAISE],
+    EventType.CONFERENCE: [EventSubType.CONFERENCE],
+    EventType.EARNINGS_CALL: [
+        EventSubType.Q1,
+        EventSubType.Q2,
+        EventSubType.Q3,
+        EventSubType.Q4,
+        EventSubType.H1,
+        EventSubType.H2,
+    ],
+    EventType.EXTRAORDINARY_GENERAL_MEETING: [EventSubType.EGM],
+    EventType.FDA_ANNOUNCEMENT: [EventSubType.FDA_ANNOUNCEMENT],
+    EventType.FIRESIDE_CHAT: [EventSubType.FIRESIDE_CHAT],
+    EventType.INVESTOR_DAY: [EventSubType.INVESTOR_DAY],
+    EventType.M_AND_A_ANNOUNCEMENT: [EventSubType.M_AND_A_ANNOUNCEMENT],
+    EventType.OUTLOOK_GUIDANCE_UPDATE: [EventSubType.GUIDANCE],
+    EventType.PARTNERSHIPS_COLLABORATIONS: [
+        EventSubType.PARTNERSHIP,
+        EventSubType.COLLABORATION,
+    ],
+    EventType.PRODUCT_SERVICE_LAUNCH: [
+        EventSubType.PRODUCT_LAUNCH,
+        EventSubType.SERVICE_LAUNCH,
+    ],
+    EventType.SLIDES: [
+        EventSubType.INVESTOR_PRESENTATION,
+        EventSubType.CORPORATE_PRESENTATION,
+        EventSubType.COMPANY_PRESENTATION,
+    ],
+    EventType.TRADING_UPDATE: [EventSubType.TRADING_UPDATE],
+    EventType.UPDATE_BRIEFING: [
+        EventSubType.STATUS_UPDATE,
+        EventSubType.INVESTOR_UPDATE,
+        EventSubType.ESG_UPDATE,
+        EventSubType.STUDY_UPDATE,
+        EventSubType.STUDY_RESULT,
+        EventSubType.KOL_EVENT,
+    ],
+}

unique_quartr/endpoints/api.py

@@ -0,0 +1,62 @@
+from string import Template
+
+from pydantic import BaseModel
+from unique_toolkit._common.endpoint_builder import HttpMethods, build_api_operation
+from unique_toolkit._common.endpoint_requestor import (
+    RequestContext,
+)
+
+from unique_quartr.settings import quartr_settings
+
+from .schemas import (
+    PaginatedDocumentResponseDto,
+    PaginatedDocumentTypeResponseDto,
+    PaginatedEventResponseDto,
+    PublicV3DocumentsGetParametersQuery,
+    PublicV3DocumentTypesGetParametersQuery,
+    PublicV3EventsGetParametersQuery,
+)
+
+
+class EmptyModel(BaseModel): ...
+
+
+def get_quartr_context(*, company_id: str):
+    if quartr_settings.quartr_api_creds is None:
+        raise ValueError("Quartr API credentials are not set")
+
+    if company_id not in quartr_settings.quartr_api_activated_companies:
+        raise ValueError(f"Company {company_id} is not activated for Quartr API")
+
+    return RequestContext(
+        base_url="https://api.quartr.com",
+        headers={
+            "Content-Type": "application/json",
+            "X-Api-Key": quartr_settings.quartr_api_creds.api_key,
+        },
+    )
+
+
+QuartrEventsApiOperation = build_api_operation(
+    method=HttpMethods.GET,
+    path_template=Template("/public/v3/events"),
+    path_params_constructor=EmptyModel,
+    payload_constructor=PublicV3EventsGetParametersQuery,
+    response_model_type=PaginatedEventResponseDto,
+)
+
+QuartrDocumentsApiOperation = build_api_operation(
+    method=HttpMethods.GET,
+    path_template=Template("/public/v3/documents"),
+    path_params_constructor=EmptyModel,
+    payload_constructor=PublicV3DocumentsGetParametersQuery,
+    response_model_type=PaginatedDocumentResponseDto,
+)
+
+QuartrDocumentsTypesApiOperation = build_api_operation(
+    method=HttpMethods.GET,
+    path_template=Template("/public/v3/document-types"),
+    path_params_constructor=EmptyModel,
+    payload_constructor=PublicV3DocumentTypesGetParametersQuery,
+    response_model_type=PaginatedDocumentTypeResponseDto,
+)