artesian-sdk 3.1.3.dev5__tar.gz → 3.1.4.dev10__tar.gz

{artesian-sdk-3.1.3.dev5 → artesian_sdk-3.1.4.dev10}/.github/workflows/python-tests.yml

@@ -36,6 +36,14 @@ jobs:
       run: |
         flake8 .
 
+    - uses: jordemort/action-pyright@v1
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        reporter: github-check
+        lib: 
+        level: warning
+        filter_mode: file
+
     - name: Test Pytest
       run: |
         pytest --junitxml=junit/test-results-${{ matrix.python-version }}.xml

artesian_sdk-3.1.4.dev10/.vscode/extensions.json

@@ -0,0 +1,10 @@
+{
+    "recommendations": [
+        "ms-python.flake8",
+        "github.vscode-github-actions",
+        "ms-python.vscode-pylance",
+        "ms-python.python",
+        "ms-python.debugpy",
+        "ms-python.black-formatter"
+    ]
+}

{artesian-sdk-3.1.3.dev5 → artesian_sdk-3.1.4.dev10}/.vscode/settings.json

@@ -2,11 +2,9 @@
   "python.testing.pytestEnabled": true,
   "python.testing.unittestEnabled": false,
   "editor.fontSize": 16,
-  "python.formatting.provider": "none",
-  "python.linting.flake8Enabled": true,
   "editor.formatOnPaste": true,
   "editor.formatOnSave": true,
   "[python]": {
     "editor.defaultFormatter": "ms-python.black-formatter"
   }
-}
+}

{artesian-sdk-3.1.3.dev5 → artesian_sdk-3.1.4.dev10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: artesian-sdk
-Version: 3.1.3.dev5
+Version: 3.1.4.dev10
 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>
@@ -419,6 +419,48 @@ Latest Value to propagate the latest value, not older than a certain threshold e
  .withFillLatestValue("P5D", "True")
 ```
 
+### Query written Versions or Products
+
+Using MarketDataService is possible to query all the Versions and all the Products curves which has been written in a MarketData.
+
+```Python
+from Artesian.MarketData import MarketDataService
+
+mds = MarketDataService(cfg)
+
+```
+
+To list MarketData curves
+
+```Python
+page = 1
+pageSize = 100
+res = mds.readCurveRange(100042422, page, pageSize, versionFrom="2016-12-20" , versionTo="2019-03-12")
+```
+
+### Search the MarketData collection with faceted results
+
+Using MarketDataService is possible to query and search the MarketData collection with faceted results. Supports paging, filtering and free text.
+
+```Python
+from Artesian.MarketData import MarketDataService
+
+mds = MarketDataService(cfg)
+
+```
+
+To list MarketData curves
+
+```Python
+page = 1
+pageSize = 100
+searchText = "Riconsegnato_"
+filters = {"ProviderName": ["SNAM", "France"]}
+sorts=["MarketDataId asc"]
+doNotLoadAdditionalInfo=True
+res = mds.searchFacet(page, pageSize, searchText, filters, sorts, doNotLoadAdditionalInfo)
+```
+
 ## GME Public Offer
 
 Artesian support Query over GME Public Offers which comes in a custom and dedicated format.
@@ -799,6 +841,11 @@ auctionRows = MarketData.UpsertData(MarketData.MarketDataIdentifier('PROVIDER',
 
 ```
 
+
+## Delete Data in Artesian
+
+Using the MarketDataService is possible to delete MarketData and its curves.
+
 ### Delete MarketData in Artesian
 
 Using the MarketDataService is possible to delete MarketData and its curves.
@@ -815,46 +862,120 @@ mkservice.deleteMarketData(100042422)
 
 ```
 
-### Query written Versions or Products
+Depending on the Type of the MarketData, the DeletData should be composed as per example below.
 
-Using MarketDataService is possible to query all the Versions and all the Products curves which has been written in a MarketData.
+### Delete Data in an Actual Time Series
 
 ```Python
-from Artesian.MarketData import MarketDataService
+from Artesian import ArtesianConfig, Granularity, MarketData
+from Artesian.MarketData import AggregationRule
+from datetime import datetime
+from dateutil import tz
 
-mds = MarketDataService(cfg)
+cfg = ArtesianConfg()
 
+mkservice = MarketData.MarketDataService(cfg)
+
+mkdid = MarketData.MarketDataIdentifier('PROVIDER', 'MARKETDATANAME')
+deleteData = MarketData.DeleteData(
+    ID=mkdid,
+    timezone='CET',
+    rangeStart=datetime(2020, 1, 1, 6),
+    rangeEnd=datetime(2020, 1, 1, 18),
+)
+
+mkdservice.deleteData(deleteData)
 ```
 
-To list MarketData curves
+### Delete Data in an Versioned Time Series
 
 ```Python
-page = 1
-pageSize = 100
-res = mds.readCurveRange(100042422, page, pageSize, versionFrom="2016-12-20" , versionTo="2019-03-12")
+from Artesian import ArtesianConfig, Granularity, MarketData
+from Artesian.MarketData import AggregationRule
+from datetime import datetime
+from dateutil import tz
+
+cfg = ArtesianConfg()
+
+mkservice = MarketData.MarketDataService(cfg)
+
+mkdid = MarketData.MarketDataIdentifier('PROVIDER', 'MARKETDATANAME')
+deleteData = MarketData.DeleteData(
+    ID=mkdid,
+    timezone='CET',
+    rangeStart=datetime(2020, 1, 1, 0),
+    rangeEnd=datetime(2020, 1, 7, 0),
+    version=datetime(2020, 1, 1, 0)
+)
+
+mkdservice.deleteData(deleteData)
 ```
 
-### Search the MarketData collection with faceted results
+### Delte Data in a Market Assessment Time Series
 
-Using MarketDataService is possible to query and search the MarketData collection with faceted results. Supports paging, filtering and free text.
+```Python
+from Artesian import ArtesianConfig, Granularity, MarketData
+from datetime import datetime
+from dateutil import tz
+
+cfg = ArtesianConfg()
+mkservice = MarketData.MarketDataService(cfg)
+
+mkdid = MarketData.MarketDataIdentifier('PROVIDER', 'MARKETDATANAME')
+deleteData = MarketData.DeleteData(
+    ID= mkdid,
+    timezone='CET',
+    rangeStart=datetime(2020, 1, 1, 0),
+    rangeEnd=datetime(2020, 1, 3, 0),
+    product=["Feb-20"]
+)
+
+mkdservice.deleteData(deleteData)
+```
+
+### Delte Data in a Bid Ask Time Series
 
 ```Python
-from Artesian.MarketData import MarketDataService
+from Artesian import ArtesianConfig, Granularity, MarketData
+from datetime import datetime
+from dateutil import tz
 
-mds = MarketDataService(cfg)
+cfg = ArtesianConfg()
+mkservice = MarketData.MarketDataService(cfg)
+
+mkdid = MarketData.MarketDataIdentifier('PROVIDER', 'MARKETDATANAME')
+deleteData = MarketData.DeleteData(
+    ID= mkdid,
+    timezone='CET',
+    rangeStart=datetime(2020, 1, 1, 0),
+    rangeEnd=datetime(2020, 1, 3, 0),
+    product=["Feb-20"]
+)
 
+mkdservice.deleteData(deleteData)
 ```
 
-To list MarketData curves
+### Delete Data in an Auction Time Series
 
 ```Python
-page = 1
-pageSize = 100
-searchText = "Riconsegnato_"
-filters = {"ProviderName": ["SNAM", "France"]}
-sorts=["MarketDataId asc"]
-doNotLoadAdditionalInfo=True
-res = mds.searchFacet(page, pageSize, searchText, filters, sorts, doNotLoadAdditionalInfo)
+from Artesian import ArtesianConfig, Granularity, MarketData
+from Artesian.MarketData import AggregationRule
+from datetime import datetime
+from dateutil import tz
+
+cfg = ArtesianConfg()
+
+mkservice = MarketData.MarketDataService(cfg)
+
+mkdid = MarketData.MarketDataIdentifier('PROVIDER', 'MARKETDATANAME')
+deleteData = MarketData.DeleteData(
+    ID=mkdid,
+    timezone='CET',
+    rangeStart=datetime(2020, 1, 1, 6),
+    rangeEnd=datetime(2020, 1, 1, 18),
+)
+
+mkdservice.deleteData(deleteData)
 ```
 
 ## Jupyter Support

{artesian-sdk-3.1.3.dev5 → artesian_sdk-3.1.4.dev10}/README.md

@@ -365,6 +365,48 @@ Latest Value to propagate the latest value, not older than a certain threshold e
  .withFillLatestValue("P5D", "True")
 ```
 
+### Query written Versions or Products
+
+Using MarketDataService is possible to query all the Versions and all the Products curves which has been written in a MarketData.
+
+```Python
+from Artesian.MarketData import MarketDataService
+
+mds = MarketDataService(cfg)
+
+```
+
+To list MarketData curves
+
+```Python
+page = 1
+pageSize = 100
+res = mds.readCurveRange(100042422, page, pageSize, versionFrom="2016-12-20" , versionTo="2019-03-12")
+```
+
+### Search the MarketData collection with faceted results
+
+Using MarketDataService is possible to query and search the MarketData collection with faceted results. Supports paging, filtering and free text.
+
+```Python
+from Artesian.MarketData import MarketDataService
+
+mds = MarketDataService(cfg)
+
+```
+
+To list MarketData curves
+
+```Python
+page = 1
+pageSize = 100
+searchText = "Riconsegnato_"
+filters = {"ProviderName": ["SNAM", "France"]}
+sorts=["MarketDataId asc"]
+doNotLoadAdditionalInfo=True
+res = mds.searchFacet(page, pageSize, searchText, filters, sorts, doNotLoadAdditionalInfo)
+```
+
 ## GME Public Offer
 
 Artesian support Query over GME Public Offers which comes in a custom and dedicated format.
@@ -745,6 +787,11 @@ auctionRows = MarketData.UpsertData(MarketData.MarketDataIdentifier('PROVIDER',
 
 ```
 
+
+## Delete Data in Artesian
+
+Using the MarketDataService is possible to delete MarketData and its curves.
+
 ### Delete MarketData in Artesian
 
 Using the MarketDataService is possible to delete MarketData and its curves.
@@ -761,46 +808,120 @@ mkservice.deleteMarketData(100042422)
 
 ```
 
-### Query written Versions or Products
+Depending on the Type of the MarketData, the DeletData should be composed as per example below.
 
-Using MarketDataService is possible to query all the Versions and all the Products curves which has been written in a MarketData.
+### Delete Data in an Actual Time Series
 
 ```Python
-from Artesian.MarketData import MarketDataService
+from Artesian import ArtesianConfig, Granularity, MarketData
+from Artesian.MarketData import AggregationRule
+from datetime import datetime
+from dateutil import tz
 
-mds = MarketDataService(cfg)
+cfg = ArtesianConfg()
 
+mkservice = MarketData.MarketDataService(cfg)
+
+mkdid = MarketData.MarketDataIdentifier('PROVIDER', 'MARKETDATANAME')
+deleteData = MarketData.DeleteData(
+    ID=mkdid,
+    timezone='CET',
+    rangeStart=datetime(2020, 1, 1, 6),
+    rangeEnd=datetime(2020, 1, 1, 18),
+)
+
+mkdservice.deleteData(deleteData)
 ```
 
-To list MarketData curves
+### Delete Data in an Versioned Time Series
 
 ```Python
-page = 1
-pageSize = 100
-res = mds.readCurveRange(100042422, page, pageSize, versionFrom="2016-12-20" , versionTo="2019-03-12")
+from Artesian import ArtesianConfig, Granularity, MarketData
+from Artesian.MarketData import AggregationRule
+from datetime import datetime
+from dateutil import tz
+
+cfg = ArtesianConfg()
+
+mkservice = MarketData.MarketDataService(cfg)
+
+mkdid = MarketData.MarketDataIdentifier('PROVIDER', 'MARKETDATANAME')
+deleteData = MarketData.DeleteData(
+    ID=mkdid,
+    timezone='CET',
+    rangeStart=datetime(2020, 1, 1, 0),
+    rangeEnd=datetime(2020, 1, 7, 0),
+    version=datetime(2020, 1, 1, 0)
+)
+
+mkdservice.deleteData(deleteData)
 ```
 
-### Search the MarketData collection with faceted results
+### Delte Data in a Market Assessment Time Series
 
-Using MarketDataService is possible to query and search the MarketData collection with faceted results. Supports paging, filtering and free text.
+```Python
+from Artesian import ArtesianConfig, Granularity, MarketData
+from datetime import datetime
+from dateutil import tz
+
+cfg = ArtesianConfg()
+mkservice = MarketData.MarketDataService(cfg)
+
+mkdid = MarketData.MarketDataIdentifier('PROVIDER', 'MARKETDATANAME')
+deleteData = MarketData.DeleteData(
+    ID= mkdid,
+    timezone='CET',
+    rangeStart=datetime(2020, 1, 1, 0),
+    rangeEnd=datetime(2020, 1, 3, 0),
+    product=["Feb-20"]
+)
+
+mkdservice.deleteData(deleteData)
+```
+
+### Delte Data in a Bid Ask Time Series
 
 ```Python
-from Artesian.MarketData import MarketDataService
+from Artesian import ArtesianConfig, Granularity, MarketData
+from datetime import datetime
+from dateutil import tz
 
-mds = MarketDataService(cfg)
+cfg = ArtesianConfg()
+mkservice = MarketData.MarketDataService(cfg)
+
+mkdid = MarketData.MarketDataIdentifier('PROVIDER', 'MARKETDATANAME')
+deleteData = MarketData.DeleteData(
+    ID= mkdid,
+    timezone='CET',
+    rangeStart=datetime(2020, 1, 1, 0),
+    rangeEnd=datetime(2020, 1, 3, 0),
+    product=["Feb-20"]
+)
 
+mkdservice.deleteData(deleteData)
 ```
 
-To list MarketData curves
+### Delete Data in an Auction Time Series
 
 ```Python
-page = 1
-pageSize = 100
-searchText = "Riconsegnato_"
-filters = {"ProviderName": ["SNAM", "France"]}
-sorts=["MarketDataId asc"]
-doNotLoadAdditionalInfo=True
-res = mds.searchFacet(page, pageSize, searchText, filters, sorts, doNotLoadAdditionalInfo)
+from Artesian import ArtesianConfig, Granularity, MarketData
+from Artesian.MarketData import AggregationRule
+from datetime import datetime
+from dateutil import tz
+
+cfg = ArtesianConfg()
+
+mkservice = MarketData.MarketDataService(cfg)
+
+mkdid = MarketData.MarketDataIdentifier('PROVIDER', 'MARKETDATANAME')
+deleteData = MarketData.DeleteData(
+    ID=mkdid,
+    timezone='CET',
+    rangeStart=datetime(2020, 1, 1, 6),
+    rangeEnd=datetime(2020, 1, 1, 18),
+)
+
+mkdservice.deleteData(deleteData)
 ```
 
 ## Jupyter Support

{artesian-sdk-3.1.3.dev5 → artesian_sdk-3.1.4.dev10}/pyproject.toml

@@ -155,4 +155,11 @@ python_files = "Test*.py"
 testpaths = [
     "tests"
 ]
-addopts = "--doctest-modules --junitxml=junit/test-results.xml --cov=src --cov-report=xml --cov-report=html"
+addopts = "--doctest-modules --junitxml=junit/test-results.xml --cov=src --cov-report=xml --cov-report=html"
+
+[tool.pyright]
+include = ["src"]
+exclude = [
+  "**/node_modules",
+  "**/__pycache__"
+]

artesian_sdk-3.1.4.dev10/samples/TestWriteDataAndDeleteActual.py

@@ -0,0 +1,70 @@
+from datetime import datetime
+import Artesian
+from Artesian import Query
+from Artesian.Granularity import Granularity
+from Artesian.MarketData._Enum.MarketDataType import MarketDataType
+
+cfg = Artesian.ArtesianConfig("https://arkive.artesian.cloud/tenantName/", "APIKey")
+mkdservice = Artesian.MarketData.MarketDataService(cfg)
+
+actual = Artesian.MarketData.MarketDataEntityInput(
+    "PythonSDK",
+    "TestActualWriteAndDelete",
+    Granularity.Hour,
+    MarketDataType.ActualTimeSerie,
+    "CET",
+    tags={"TestSDKPython": ["PythonValue2"]},
+)
+
+registered = mkdservice.readMarketDataRegistryByName(
+    actual.providerName, actual.marketDataName
+)
+if registered is None:
+    registered = mkdservice.registerMarketData(actual)
+
+data = Artesian.MarketData.UpsertData(
+    Artesian.MarketData.MarketDataIdentifier(
+        actual.providerName, actual.marketDataName
+    ),
+    "UTC",
+    rows={datetime(2020, 1, 1, h): 42.0 + h / 24.0 for h in range(0, 23)},
+)
+
+mkdservice.upsertData(data)
+
+query = Query.QueryService(cfg)
+
+res = (
+    query.createActual()
+    .forMarketData([registered.marketDataId])
+    .inAbsoluteDateRange("2020-01-01", "2020-01-02")
+    .inTimeZone("CET")
+    .inGranularity(Granularity.Hour)
+    .execute()
+)
+
+print(res)
+
+#Delete data between 2020-01-01 06:00 and 2020-01-01 18:00
+deleteData = Artesian.MarketData.DeleteData(
+    ID=Artesian.MarketData.MarketDataIdentifier(registered.providerName, registered.marketDataName),
+    timezone="CET",
+    rangeStart=datetime(2020, 1, 1, 6),
+    rangeEnd=datetime(2020, 1, 1, 18),
+)
+
+mkdservice.deleteData(deleteData)
+
+res = (
+    query.createActual()
+    .forMarketData([registered.marketDataId])
+    .inAbsoluteDateRange("2020-01-01", "2020-01-02")
+    .inTimeZone("CET")
+    .inGranularity(Granularity.Hour)
+    .execute()
+)
+
+print(res)
+
+#Delete the curve completely
+mkdservice.deleteMarketData(registered.marketDataId)

artesian_sdk-3.1.4.dev10/samples/TestWriteDataAndDeleteAuction.py

@@ -0,0 +1,82 @@
+from datetime import datetime
+import Artesian
+from Artesian import Query
+from dateutil import tz
+from Artesian import MarketData
+from Artesian.Granularity import Granularity
+
+cfg = Artesian.ArtesianConfig("https://arkive.artesian.cloud/tenantName/", "APIKey")
+mkdservice = Artesian.MarketData.MarketDataService(cfg)
+
+auction = Artesian.MarketData.MarketDataEntityInput(
+    "PythonSDK",
+    "TestAuctionWriteAndDelete",
+    Granularity.Hour,
+    MarketData.MarketDataType.Auction,
+    "CET",
+    tags={"TestSDKPython": ["PythonValue2"]},
+)
+
+registered = mkdservice.readMarketDataRegistryByName(
+    auction.providerName, auction.marketDataName
+)
+if registered is None:
+    registered = mkdservice.registerMarketData(auction)
+
+auctionRowData={datetime(2020, 1, 1, h): MarketData.AuctionBids(
+            datetime(2020, 1, 1),
+            bid=[
+                MarketData.AuctionBidValue(11.0, 12.0),
+                MarketData.AuctionBidValue(13.0, 14.0),
+            ],
+            offer=[
+                MarketData.AuctionBidValue(21.0, 22.0),
+                MarketData.AuctionBidValue(23.0, 24.0),
+            ],
+        ) for h in range(0, 23)}
+
+auctionRows = MarketData.UpsertData(
+    Artesian.MarketData.MarketDataIdentifier(
+        auction.providerName, auction.marketDataName
+    ),
+    "UTC",
+    auctionRows=auctionRowData,
+    downloadedAt=datetime(2020, 1, 3).replace(tzinfo=tz.UTC),
+)
+
+mkdservice.upsertData(auctionRows)
+
+query = Query.QueryService(cfg)
+
+res = (
+    query.createAuction()
+    .forMarketData([registered.marketDataId])
+    .inAbsoluteDateRange("2020-01-01", "2020-01-02")
+    .inTimeZone("CET")
+    .execute()
+)
+
+print(res)
+
+#Delete data between 2020-01-01 06:00 and 2020-01-01 18:00
+deleteData = Artesian.MarketData.DeleteData(
+    ID=Artesian.MarketData.MarketDataIdentifier(registered.providerName, registered.marketDataName),
+    timezone="CET",
+    rangeStart=datetime(2020, 1, 1, 6),
+    rangeEnd=datetime(2020, 1, 1, 18),
+)
+
+mkdservice.deleteData(deleteData)
+
+res = (
+    query.createAuction()
+    .forMarketData([registered.marketDataId])
+    .inAbsoluteDateRange("2020-01-01", "2020-01-02")
+    .inTimeZone("CET")
+    .execute()
+)
+
+print(res)
+
+#Delete the curve completely
+mkdservice.deleteMarketData(registered.marketDataId)