Metadata-Version: 2.1
Name: seffaflik
Version: 0.0.11
Summary: EPİAŞ tarafından Şeffaflık Platformunda yayımlanmakta olan verileri çekmek için tasarlanmış Python kütüphanesi
Home-page: https://github.com/nurisensoy/seffaflik
Author: Dr. Nuri Şensoy
Author-email: nuri.sensoy@epias.com.tr
License: UNKNOWN
Description: 
        # Kurulum
        ### Gereksinimler
        seffaflik kütüphanesinin kullanımı için gerekli paketler:
        * pandas
        * requests
        * python-dateutils
        
        Not: İlgili paketler aşağıda belirtilen yükleme yöntemini izlediğiniz taktirde otomatik olarak yüklenecektir.
        ### pip aracılığıyla en son sürümü yükleyin
        ```
        $ pip install seffaflik
        ```
        
        ### Kimlik (Client Id) Oluşturulması
        Kütüphane yükleme işlemini tamamladıktan sonra kütüphane aracılığıyla veri çekiş işlemini gerçekleştirebilmeniz için 
        temin etmiş olduğunuz **istemci taniticisi (client id)** ile aşağıda belirtilen kimlik oluşturma sürecini de tamamlamış 
        olmanız gerekmektedir. [İstemci tanitici (client id) nasıl temin edilir?](https://nurisensoy.github.io/seffaflikplatformu/nedir)
        
        ```python
        import seffaflik
        seffaflik.Kimlik(istemci_taniticisi="abcdefg")
        ```
        Yukarıdaki işlemi gerçekleştirmenizden sonra ana dizininize özel bir
        .seffaflik/.kimlik dosyası yerleştirilir. ~/.seffaflik/.kimlik dosyanız aşağıdaki
        gibi görünmelidir:
        ```
        {
          "istemci_taniticisi": "abcdefg"
        }
        ```
        Not: İstemci Tanıtıcı geçerliliğini koruduğu sürece kimlik oluşturma işleminin tekrar gerçekleştirilmesine 
        gerek duyulmamaktadır.
        
        
        # Kullanım
        Kütüphane yükleme ve kimlik oluşturma işlemleri tamamladıktan sonra kütüphane aracılığıyla şeffaflık platformundan 
        kolaylıkla veri çekiş işlemine başlanabilmektedir. Kütüphanenin paketleri, alt-paketleri ve modülleri şu şekilde 
        tasarlanmıştır:
        ```
        seffaflik/
        └── elektrik/
            ├── piyasalar/
            │   ├── dengesizlik.py
            │   ├── dgp.py
            │   ├── genel.py
            │   ├── gip.py    
            │   ├── gop.py
            │   ├── ia.py  
            │   └── yanhizmetler.py
            ├── santraller.py
            ├── tuketim.py
            ├── yekdem.py
            └── uretim.py
            
        ```
        Bu çerçevede tüm modüller şu şekilde import edilebilir:
        ```python
        from seffaflik.elektrik import santraller, tuketim, uretim, yekdem
        from seffaflik.elektrik.piyasalar import dengesizlik, dgp, genel, gip, gop, ia, yanhizmetler
        ```
        ### Örnek İstekler
        Yukarıda belirtilen modüller import edildikten sonra aşağıda belirtilen örnek istekler yapılabilecektir.
        #### 1. Piyasa Takas Fiyatı (PTF)
        ```python
        df = gop.ptf(baslangic_tarihi='2019-01-01', bitis_tarihi='2019-01-01')
        ```
        #### 2. KGÜP Girebilecek Organizasyonlar
        ```python
        df = uretim.organizasyonlar()
        ```
        #### 3. Uzlaştırmaya Esas Veriş Miktarı (UEVM)
        ```python
        df = uretim.uevm(baslangic_tarihi='2019-01-01', bitis_tarihi='2019-01-01')
        ```
        #### 4. Dönemsel Serbest Tüketici Sayıları
        ```python
        df = tuketim.serbest_tuketici_sayisi("2019-01-01","2019-10-01")
        ```
        
Keywords: seffaflik,transparency,Turkish Electricity Market
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
