artesian-sdk 4.2.3.dev2__tar.gz → 4.2.3.dev6__tar.gz

{artesian_sdk-4.2.3.dev2 → artesian_sdk-4.2.3.dev6}/.github/workflows/python-tests.yml

@@ -49,7 +49,7 @@ jobs:
           pytest --junitxml=junit/test-results-${{ matrix.python-version }}-${{ matrix.os }}.xml
 
       - name: Upload pytest test results
-        uses: actions/upload-artifact@v5
+        uses: actions/upload-artifact@v6
         with:
           name: pytest-results-${{ matrix.python-version }}-${{ matrix.os }}
           path: junit/test-results-${{ matrix.python-version }}-${{ matrix.os }}.xml

{artesian_sdk-4.2.3.dev2 → artesian_sdk-4.2.3.dev6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: artesian-sdk
-Version: 4.2.3.dev2
+Version: 4.2.3.dev6
 Summary: Library provides read access to the Artesian API
 Author-email: ARK Lab <arklab@ark-energy.eu>
 Maintainer-email: ARK Lab <arklab@ark-energy.eu>
@@ -466,23 +466,53 @@ res = mds.searchFacet(page, pageSize, searchText, filters, sorts, doNotLoadAddit
 
 Artesian support Query over GME Public Offers which comes in a custom and dedicated format.
 
+Note (performance):
+GME Public Offer data is partitioned by date, offerType, status, and market. Requesting very narrow subsets (for example a single status or offerType in several separate requests) does not improve performance and can cause the same data to be fetched multiple times.
+For this reason, the examples below:
+	•	Use a large page size so that all data for a given (date, market, filters) is typically returned in a single page.
+	•	Loop over markets explicitly to cover all required markets without redundant fetches.
+
 ### Extract GME Public Offer
 
 ```Python
 from Artesian.GMEPublicOffers import GMEPublicOfferService, Market, Purpose, Status, Zone, Scope, UnitType, GenerationType, BAType
 
-qs = GMEPublicOfferService(cfg)
+/* your Artesian configuration */;
+
+var _cfg = new ArtesianServiceConfig(
+new Uri("https://arkive.artesian.cloud/{TENANT_NAME}/"),
+your_API_Key);
+
+qs = GMEPublicOfferService(_cfg)
+
+# Large page size: goal is to get all data for the given filters in one page
+PAGE_SIZE = 250000
 
-data = qs.createQuery() \
+# List of markets to cover. Extend as needed for your use case.
+markets = [
+    Market.MGP,
+    # Market.MSD,
+    # Market.MIT,
+]
+
+all_data = []
+
+for market in markets:
+
+data = (
+    qs.createQuery() \
     .forDate("2020-04-01") \
     .forMarket([Market.MGP]) \
     .forStatus(Status.ACC) \
     .forPurpose(Purpose.BID) \
     .forZone([Zone.NORD]) \
-    .withPagination(1,100) \
+    .withPagination(1,PAGE_SIZE) \
     .execute()
+    )
+    print(f"Fetched {len(data)} offers for market {market}")
+    all_data.extend(data)
 
-print(data)
+print(f"Total offers fetched: {len(all_data)}")
 ```
 
 To construct a GME Public Offer Extraction the following must be provided.

{artesian_sdk-4.2.3.dev2 → artesian_sdk-4.2.3.dev6}/README.md

@@ -411,23 +411,53 @@ res = mds.searchFacet(page, pageSize, searchText, filters, sorts, doNotLoadAddit
 
 Artesian support Query over GME Public Offers which comes in a custom and dedicated format.
 
+Note (performance):
+GME Public Offer data is partitioned by date, offerType, status, and market. Requesting very narrow subsets (for example a single status or offerType in several separate requests) does not improve performance and can cause the same data to be fetched multiple times.
+For this reason, the examples below:
+	•	Use a large page size so that all data for a given (date, market, filters) is typically returned in a single page.
+	•	Loop over markets explicitly to cover all required markets without redundant fetches.
+
 ### Extract GME Public Offer
 
 ```Python
 from Artesian.GMEPublicOffers import GMEPublicOfferService, Market, Purpose, Status, Zone, Scope, UnitType, GenerationType, BAType
 
-qs = GMEPublicOfferService(cfg)
+/* your Artesian configuration */;
+
+var _cfg = new ArtesianServiceConfig(
+new Uri("https://arkive.artesian.cloud/{TENANT_NAME}/"),
+your_API_Key);
+
+qs = GMEPublicOfferService(_cfg)
+
+# Large page size: goal is to get all data for the given filters in one page
+PAGE_SIZE = 250000
 
-data = qs.createQuery() \
+# List of markets to cover. Extend as needed for your use case.
+markets = [
+    Market.MGP,
+    # Market.MSD,
+    # Market.MIT,
+]
+
+all_data = []
+
+for market in markets:
+
+data = (
+    qs.createQuery() \
     .forDate("2020-04-01") \
     .forMarket([Market.MGP]) \
     .forStatus(Status.ACC) \
     .forPurpose(Purpose.BID) \
     .forZone([Zone.NORD]) \
-    .withPagination(1,100) \
+    .withPagination(1,PAGE_SIZE) \
     .execute()
+    )
+    print(f"Fetched {len(data)} offers for market {market}")
+    all_data.extend(data)
 
-print(data)
+print(f"Total offers fetched: {len(all_data)}")
 ```
 
 To construct a GME Public Offer Extraction the following must be provided.

{artesian_sdk-4.2.3.dev2 → artesian_sdk-4.2.3.dev6}/src/Artesian/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '4.2.3.dev2'
-__version_tuple__ = version_tuple = (4, 2, 3, 'dev2')
+__version__ = version = '4.2.3.dev6'
+__version_tuple__ = version_tuple = (4, 2, 3, 'dev6')
 
-__commit_id__ = commit_id = 'g764c5f131'
+__commit_id__ = commit_id = 'g4f5a4251f'

{artesian_sdk-4.2.3.dev2 → artesian_sdk-4.2.3.dev6}/src/artesian_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: artesian-sdk
-Version: 4.2.3.dev2
+Version: 4.2.3.dev6
 Summary: Library provides read access to the Artesian API
 Author-email: ARK Lab <arklab@ark-energy.eu>
 Maintainer-email: ARK Lab <arklab@ark-energy.eu>
@@ -466,23 +466,53 @@ res = mds.searchFacet(page, pageSize, searchText, filters, sorts, doNotLoadAddit
 
 Artesian support Query over GME Public Offers which comes in a custom and dedicated format.
 
+Note (performance):
+GME Public Offer data is partitioned by date, offerType, status, and market. Requesting very narrow subsets (for example a single status or offerType in several separate requests) does not improve performance and can cause the same data to be fetched multiple times.
+For this reason, the examples below:
+	•	Use a large page size so that all data for a given (date, market, filters) is typically returned in a single page.
+	•	Loop over markets explicitly to cover all required markets without redundant fetches.
+
 ### Extract GME Public Offer
 
 ```Python
 from Artesian.GMEPublicOffers import GMEPublicOfferService, Market, Purpose, Status, Zone, Scope, UnitType, GenerationType, BAType
 
-qs = GMEPublicOfferService(cfg)
+/* your Artesian configuration */;
+
+var _cfg = new ArtesianServiceConfig(
+new Uri("https://arkive.artesian.cloud/{TENANT_NAME}/"),
+your_API_Key);
+
+qs = GMEPublicOfferService(_cfg)
+
+# Large page size: goal is to get all data for the given filters in one page
+PAGE_SIZE = 250000
 
-data = qs.createQuery() \
+# List of markets to cover. Extend as needed for your use case.
+markets = [
+    Market.MGP,
+    # Market.MSD,
+    # Market.MIT,
+]
+
+all_data = []
+
+for market in markets:
+
+data = (
+    qs.createQuery() \
     .forDate("2020-04-01") \
     .forMarket([Market.MGP]) \
     .forStatus(Status.ACC) \
     .forPurpose(Purpose.BID) \
     .forZone([Zone.NORD]) \
-    .withPagination(1,100) \
+    .withPagination(1,PAGE_SIZE) \
     .execute()
+    )
+    print(f"Fetched {len(data)} offers for market {market}")
+    all_data.extend(data)
 
-print(data)
+print(f"Total offers fetched: {len(all_data)}")
 ```
 
 To construct a GME Public Offer Extraction the following must be provided.