Skip to main content

EPİAŞ tarafından Şeffaflık Platformunda yayımlanmakta olan verileri çekmek için tasarlanmış Python kütüphanesi

Project 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?

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:

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)

df = gop.ptf(baslangic_tarihi='2019-01-01', bitis_tarihi='2019-01-01')

2. KGÜP Girebilecek Organizasyonlar

df = uretim.organizasyonlar()

3. Uzlaştırmaya Esas Veriş Miktarı (UEVM)

df = uretim.uevm(baslangic_tarihi='2019-01-01', bitis_tarihi='2019-01-01')

4. Dönemsel Serbest Tüketici Sayıları

df = tuketim.serbest_tuketici_sayisi("2019-01-01","2019-10-01")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for seffaflik, version 0.0.11
Filename, size File type Python version Upload date Hashes
Filename, size seffaflik-0.0.11-py3-none-any.whl (33.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size seffaflik-0.0.11.tar.gz (21.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page