eptr2 1.1.4.dev0__tar.gz → 1.2.0.dev0__tar.gz

eptr2-1.2.0.dev0/.gitignore

@@ -0,0 +1,167 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+**/.DS_Store
+data/
+runs/
+.vscode/
+helpdocs/
+creds/

{eptr2-1.1.4.dev0 → eptr2-1.2.0.dev0}/PKG-INFO

@@ -1,25 +1,23 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: eptr2
-Version: 1.1.4.dev0
+Version: 1.2.0.dev0
 Summary: EPIAS Transparency Platform v2.0 Python client by Robokami Data
-License: Apache-2.0
-Author: Tideseed
-Author-email: info@tideseed.com
-Requires-Python: >=3.9, !=2.7.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*, !=3.8.*
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
+Author-email: Tideseed <info@tideseed.com>
+License: Apache License 2.0
+License-File: LICENSE
+Requires-Python: !=3.9.7,>=3.9.6
+Requires-Dist: pytz>=2024.1
+Requires-Dist: urllib3==2.5.0
 Provides-Extra: allextras
+Requires-Dist: pandas>=2.1.3; extra == 'allextras'
+Requires-Dist: requests>=2.32.4; extra == 'allextras'
+Requires-Dist: streamlit>=1.48.0; extra == 'allextras'
+Requires-Dist: tornado>=6.5.0; extra == 'allextras'
 Provides-Extra: dataframe
-Requires-Dist: pandas (>=2.1.3) ; extra == "dataframe" or extra == "allextras"
-Requires-Dist: pytz (>=2024.1)
-Requires-Dist: requests (>=2.32.4) ; extra == "allextras"
-Requires-Dist: streamlit (>=1.48.0) ; extra == "allextras"
-Requires-Dist: tornado (>=6.5.0) ; extra == "allextras"
-Requires-Dist: urllib3 (==2.5.0)
+Requires-Dist: pandas>=2.1.3; extra == 'dataframe'
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == 'dev'
+Requires-Dist: python-dotenv>=0.19.1; extra == 'dev'
 Description-Content-Type: text/markdown
 
 ![PyPI - Version](https://img.shields.io/pypi/v/eptr2) ![PyPI - Downloads](https://img.shields.io/pypi/dm/eptr2) 
@@ -28,6 +26,9 @@ Description-Content-Type: text/markdown
 
 This document is a quickstart guide for `eptr2` package. It is a Python client for [EPIAS Transparency Platform v2.0](https://seffaflik.epias.com.tr/home) API. It is an unofficial package with Apache License 2.0.
 
++ For live demo, please visit <https://eptr2demo.streamlit.app/>
++ For local demo, you can run `eptr2demo` at terminal after installing the library.
+
 ## Installation
 
 You can easily install it from PyPI with the following commmand.
@@ -275,4 +276,3 @@ df2 = get_bpm_period(
 )
 ```
 
-

{eptr2-1.1.4.dev0 → eptr2-1.2.0.dev0}/README.md

@@ -4,6 +4,9 @@
 
 This document is a quickstart guide for `eptr2` package. It is a Python client for [EPIAS Transparency Platform v2.0](https://seffaflik.epias.com.tr/home) API. It is an unofficial package with Apache License 2.0.
 
++ For live demo, please visit <https://eptr2demo.streamlit.app/>
++ For local demo, you can run `eptr2demo` at terminal after installing the library.
+
 ## Installation
 
 You can easily install it from PyPI with the following commmand.

eptr2-1.2.0.dev0/eptr2/tutorials/composite/pages/4_/360/237/222/260_Fiyat_ve_Maliyetler.py

@@ -0,0 +1,147 @@
+def price_and_cost_call():
+    ss = st.session_state
+
+    pb = st.progress(0, text="Veri alınıyor...")
+    df = get_hourly_price_and_cost_data(
+        eptr=ss["eptr"],
+        start_date=str(ss["price_cost_start_date"]),
+        end_date=str(ss["price_cost_end_date"]),
+        include_contract_symbol=True,
+        include_wap=True,
+        add_kupst_cost=True,
+    )
+    pb.progress(100, text="Veri alındı.")
+    time.sleep(0.3)
+    pb.empty()
+
+    if ss.get("price_cost_column_names_tr", False):
+        df = df.rename(
+            columns={
+                "date": "Tarih-Saat",
+                "mcp": "PTF",
+                "wap": "WAP",
+                "smp": "SMF",
+                "contract": "GİP Kontrat",
+                "pos_imb_price": "Pozitif Deng Fiyatı",
+                "neg_imb_price": "Negatif Deng Fiyatı",
+                "system_direction": "Sistem Yönü",
+                "sd_sign": "SY İşareti",
+                "pos_imb_cost": "Pozitif Deng Maliyeti",
+                "neg_imb_cost": "Negatif Deng Maliyeti",
+                "kupst_cost": "Birim KÜPST",
+            }
+        )
+
+    ss["price_and_cost_data"] = df.copy()
+
+
+def price_and_cost_code():
+    ss = st.session_state
+
+    text = f"""
+    from eptr2 import EPTR2
+    from eptr2.composite import get_hourly_price_and_cost_data
+    df = get_hourly_price_and_cost_data(
+        eptr=eptr,
+        start_date="{str(ss["price_cost_start_date"])}",
+        end_date="{str(ss["price_cost_end_date"])}",
+        include_contract_symbol=True,
+        include_wap=True,
+        add_kupst_cost=True
+    )
+    """
+
+    st.code(text, language="python")
+
+
+def price_and_cost_main():
+    st.title("Fiyat ve Maliyetler")
+    ss = st.session_state
+
+    # st.json(ss)
+
+    if "eptr" not in ss:
+        st.badge(
+            "EPTR2'ye bu servis için bağlı değilsiniz. Ana sayfadan giriş yapabilirsiniz.",
+            color="red",
+            icon="❌",
+        )
+        st.stop()
+    else:
+        eptr: EPTR2 = ss["eptr"]
+
+    sidebar_common()
+    tomorrow_str = offset_date_by_n_days(str(get_today_utc3()), n=1)
+
+    date_cols = st.columns([2, 2, 3, 1])
+    with date_cols[0]:
+        start_date = st.date_input(
+            "Başlangıç Tarihi",
+            value=get_previous_day(),
+            key="price_cost_start_date",
+            max_value=tomorrow_str,
+        )
+
+    with date_cols[1]:
+        end_date = st.date_input(
+            "Bitiş Tarihi",
+            value=min(
+                tomorrow_str,
+                max(
+                    str(start_date),
+                    (
+                        str(ss["price_cost_end_date"])
+                        if ss.get("price_cost_end_date", "") != ""
+                        else get_previous_day()
+                    ),
+                ),
+            ),
+            key="price_cost_end_date",
+            min_value=start_date,
+            max_value=tomorrow_str,
+        )
+
+    with date_cols[2]:
+        st.write('<div style="height: 28px;"></div>', unsafe_allow_html=True)
+        st.button(
+            "Hesapla",
+            type="secondary",
+            key="price_cost_calculate",
+            icon="💰",
+            on_click=price_and_cost_call,
+        )
+
+    st.checkbox(
+        "Sütun İsimlerini Düzenle", key="price_cost_column_names_tr", value=True
+    )
+
+    if "price_and_cost_data" in ss:
+        st.subheader("Fiyat ve Maliyetler")
+        st.caption("Not: Bu tabloyu sağ üst köşeden csv olarak indirebilirsiniz.")
+
+        st.dataframe(
+            ss["price_and_cost_data"], use_container_width=True, hide_index=True
+        )
+        price_and_cost_code()
+
+
+if __name__ == "__main__":
+
+    import streamlit as st
+    from eptr2 import EPTR2
+    from eptr2.composite import get_hourly_price_and_cost_data
+    from eptr2.util.time import get_previous_day, get_today_utc3, offset_date_by_n_days
+    import re
+    import pandas as pd
+    from eptr2.tutorials.composite.common import sidebar_common
+    import time
+
+    st.set_page_config(
+        page_title="Fiyat ve Maliyetler",
+        page_icon="💰",
+        layout="wide",
+        initial_sidebar_state="auto",
+        menu_items=None,
+    )
+
+    price_and_cost_main()

{eptr2-1.1.4.dev0 → eptr2-1.2.0.dev0}/eptr2/tutorials/composite//342/255/220/357/270/217_Ana_Sayfa.py

@@ -101,7 +101,16 @@ def composite_main():
         """
             Bu sayfa, istediğiniz organizasyon, istediğiniz UEVÇB ve istediğiniz dönem aralığı için KGÜP ve KUDÜP verilerini bir arada çekmenizi sağlayan kompozit fonksiyonu çalıştırır."""
     )
-
+    st.divider()
+    st.page_link(
+        "pages/4_💰_Fiyat_ve_Maliyetler.py",
+        label="**Fiyat ve Maliyetler**",
+        icon="💰",
+    )
+    st.markdown(
+        """
+            Bu sayfa, istediğiniz tarih aralığı için PTF, SMF, AOF verilerini ve ilgili hesaplamaları (dengesizlik fiyat ve maliyetleri, KÜPST) bir arada çekmenizi sağlayan kompozit fonksiyonu çalıştırır."""
+    )
     st.divider()
     st.markdown("Diğer kompozit fonksiyonlar da yakında burada...")
 
@@ -113,6 +122,8 @@ if __name__ == "__main__":
     import os
     from eptr2.tutorials.composite.common import sidebar_common
 
+    streamlit_cloud_warning = False
+
     st.set_page_config(
         page_title="eptr2 Kompozit Fonksiyonlar",
         page_icon="👩‍💻",
@@ -121,4 +132,8 @@ if __name__ == "__main__":
         menu_items=None,
     )
 
+    if streamlit_cloud_warning:
+        st.warning(
+            "Bu site dış bir platform olan [Streamlit Community Cloud](https://share.streamlit.io/) üzerinde çalışmaktadır ve sadece demo amaçlıdır. Erişim bilgilerinizi paylaşırken dikkatli olmanızı ve sık sık güncellemenizi tavsiye ederiz."
+        )
     composite_main()

{eptr2-1.1.4.dev0 → eptr2-1.2.0.dev0}/eptr2/util/time.py

@@ -3,6 +3,25 @@ import pytz
 from typing import Literal
 
 
+def contract_duration(
+    contract: str, return_type: Literal["hours", "minutes", "seconds"] = "seconds"
+) -> float:
+    close_dt = contract_close_time(contract)
+    open_dt = close_dt.replace(hour=18) - timedelta(days=1)
+    duration = close_dt - open_dt
+    seconds = duration.total_seconds()
+    if return_type == "seconds":
+        return seconds
+    elif return_type == "minutes":
+        return seconds / 60
+    elif return_type == "hours":
+        return seconds / 3600
+    else:
+        raise ValueError(
+            f"Invalid return type {return_type}. Use one of ['seconds', 'minutes', 'hours']"
+        )
+
+
 def check_iso_format(
     val: str | datetime,
     strict_hour_format: bool = False,
@@ -346,13 +365,20 @@ def get_time_min_max_price_map():
     return map_l
 
 
-def contract_to_floor_ceil_prices(c):
+def contract_to_floor_ceil_prices(c: str | None = None):
     """
     Given a contract return the min and max prices
     """
 
-    the_date = contract_to_datetime(c).date()
+    ### Min max price map is always sorted by date descending
     mm_map = get_time_min_max_price_map()
+
+    ### If contract is not given return the latest
+    if c is None:
+        return mm_map[0]
+
+    the_date = contract_to_datetime(c).date()
+
     for x in mm_map:
         if the_date >= datetime.strptime(x["date"], "%Y-%m-%d").date():
             return x
@@ -375,13 +401,13 @@ def get_probable_settlement_date(x: str | None = None, settlement_day=15):
 
     if x.month == 12:
         # If the month is December, we set the next month to January of the next year
-        x = x.replace(year=x.year + 1, month=1)
+        x = x.replace(day=settlement_day, year=x.year + 1, month=1)
     else:
         # Otherwise, we just increment the month by 1
-        x = x.replace(month=x.month + 1)
+        x = x.replace(day=settlement_day, month=x.month + 1)
 
     probable_settlement_date = x.replace(
-        day=settlement_day,
+        # day=settlement_day,
         hour=0,
         minute=0,
         second=0,
@@ -457,3 +483,34 @@ def get_start_end_dates_period(period: str):
     end_date = end_date.strftime("%Y-%m-%d")
 
     return start_date, end_date
+
+
+## https://stackoverflow.com/a/68321739/3608936
+def contract_remaining_time_formatted(
+    contract: str,
+    day_label="D",
+    hour_label="H",
+    minute_label="m",
+    second_label="s",
+    no_time_label="-",
+) -> str:
+    seconds = time_to_contract_close(contract)
+    if seconds is not None:
+        seconds = int(seconds)
+        d = seconds // (3600 * 24)
+        h = seconds // 3600 % 24
+        m = seconds % 3600 // 60
+        s = seconds % 3600 % 60
+        if d > 0:
+            return "{:02d}{} {:02d}{} {:02d}{} {:02d}{}".format(
+                d, day_label, h, hour_label, m, minute_label, s, second_label
+            )
+        elif h > 0:
+            return "{:02d}{} {:02d}{} {:02d}{}".format(
+                h, hour_label, m, minute_label, s, second_label
+            )
+        elif m > 0:
+            return "{:02d}{} {:02d}{}".format(m, minute_label, s, second_label)
+        elif s > 0:
+            return "{:02d}{}".format(s, second_label)
+    return no_time_label

eptr2-1.2.0.dev0/pyproject.toml

@@ -0,0 +1,40 @@
+[project]
+name = "eptr2"
+version = "1.2.0.dev0"
+description = "EPIAS Transparency Platform v2.0 Python client by Robokami Data"
+authors = [
+    {name = "Tideseed", email = "info@tideseed.com"}
+]
+license = {text = "Apache License 2.0"}
+readme = "README.md"
+requires-python = ">=3.9.6,!=3.9.7"
+dependencies = [
+    "urllib3==2.5.0",
+    "pytz>=2024.1",
+]
+
+[project.optional-dependencies]
+dataframe = ["pandas>=2.1.3"]
+allextras = [
+    "pandas>=2.1.3",
+    "streamlit>=1.48.0",
+    "tornado>=6.5.0",
+    "requests>=2.32.4"
+]
+dev = [
+    "pytest>=7.4.0",
+    "python-dotenv>=0.19.1",
+]
+
+[project.scripts]
+eptr2demo = "eptr2.tutorials:run_composite_app"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.uv]
+dev-dependencies = [
+    "pytest>=7.4.0",
+    "python-dotenv>=0.19.1",
+]

eptr2-1.2.0.dev0/tests/__init__.py

@@ -0,0 +1,5 @@
+import pytest
+
+
+def common_params():
+    return {"start_date": "2025-02-05", "end_date": "2025-02-05"}

eptr2-1.2.0.dev0/tests/composite/test_consumption.py

@@ -0,0 +1,32 @@
+## Add test for eptr2/composite/mms.py
+from eptr2.composite.consumption import get_hourly_consumption_and_forecast_data
+from dotenv import load_dotenv, find_dotenv
+from eptr2 import EPTR2
+import pytest
+from tests import common_params
+import pandas as pd
+
+
+@pytest.fixture
+def cons_params():
+    d = common_params()
+    d = {k: v for k, v in d.items() if k in ["start_date", "end_date"]}
+    return d
+
+
+def test_eptr2_consumption(cons_params):
+    is_env_ok = load_dotenv(".env")
+    assert is_env_ok
+
+    eptr = EPTR2()
+    df = get_hourly_consumption_and_forecast_data(
+        eptr=eptr,
+        start_date=cons_params["start_date"],
+        end_date=cons_params["end_date"],
+        include_contract_symbol=True,
+    )
+
+    assert df is not None
+    assert len(df) > 0
+    assert isinstance(df, pd.DataFrame)
+    assert "contract" in df

eptr2-1.2.0.dev0/tests/composite/test_mms.py

@@ -0,0 +1,37 @@
+## Add test for eptr2/composite/mms.py
+from eptr2.composite.mms import get_mms_detail
+from dotenv import load_dotenv, find_dotenv
+from eptr2 import EPTR2
+import pytest
+from tests import common_params
+
+
+@pytest.fixture
+def mms_params():
+    d = common_params()
+    d = {k: v for k, v in d.items() if k in ["start_date", "end_date"]}
+    return d
+
+
+def test_eptr2_composite_mms(mms_params):
+    is_env_ok = load_dotenv(".env")
+    assert is_env_ok
+
+    eptr = EPTR2()
+    d = get_mms_detail(
+        eptr=eptr,
+        start_date=mms_params["start_date"],
+        end_date=mms_params["end_date"],
+        verbose=True,
+        include_contract_symbol=True,
+        include_summary=True,
+    )
+    assert d is not None
+    assert "detail" in d
+    assert "summary" in d
+    assert d["detail"] is not None
+    assert d["summary"] is not None
+    assert len(d["detail"]) > 0
+    assert len(d["summary"]) > 0
+    assert "contract" in d["detail"]
+    assert "contract" in d["summary"]

eptr2-1.2.0.dev0/tests/composite/test_price_and_cost.py

@@ -0,0 +1,57 @@
+## Add test for eptr2/composite/mms.py
+from eptr2.composite.price_and_cost import (
+    get_hourly_price_and_cost_data,
+    get_hourly_imbalance_data,
+)
+from dotenv import load_dotenv, find_dotenv
+from eptr2 import EPTR2
+import pytest
+from tests import common_params
+import pandas as pd
+
+
+@pytest.fixture
+def pc_params():
+    d = common_params()
+    d = {k: v for k, v in d.items() if k in ["start_date", "end_date"]}
+    return d
+
+
+def test_eptr2_price_and_cost(pc_params):
+    is_env_ok = load_dotenv(".env")
+    assert is_env_ok
+
+    eptr = EPTR2()
+    df = get_hourly_price_and_cost_data(
+        eptr=eptr,
+        start_date=pc_params["start_date"],
+        end_date=pc_params["end_date"],
+        verbose=True,
+        include_contract_symbol=True,
+        include_wap=True,
+        add_kupst_cost=True,
+    )
+
+    assert df is not None
+    assert len(df) > 0
+    assert isinstance(df, pd.DataFrame)
+    assert "contract" in df
+
+
+def test_eptr2_imbalance(pc_params):
+    is_env_ok = load_dotenv(".env")
+    assert is_env_ok
+
+    eptr = EPTR2()
+    df = get_hourly_imbalance_data(
+        eptr=eptr,
+        start_date=pc_params["start_date"],
+        end_date=pc_params["end_date"],
+        verbose=True,
+        include_contract_symbol=True,
+    )
+
+    assert df is not None
+    assert len(df) > 0
+    assert isinstance(df, pd.DataFrame)
+    assert "contract" in df