Skip to content

Latest commit

 

History

History
153 lines (113 loc) · 5.93 KB

README.md

File metadata and controls

153 lines (113 loc) · 5.93 KB

📈 Rich-Tabanlı Terminal API İstemcisi

Hızlı bakış:

  • 🖥️ Monokai temalı Rich CLI arabirimi
  • 🔐 HMAC‑imzalı REST çağrıları + JWT token önbelleği / otomatik yenileme
  • 🔄 WebSocket heartbeat & otomatik reconnect, ayrı canlı log penceresi
  • 📊 Menü tabanlı Portföy / Hisse / Vadeli endpoint işlemleri
  • ⏱️ Basit rate‑limit ve arka planda session refresher
  • 📜 Renkli JSON panelleri & zengin hata bildirimleri

📂 Projedeki Dosyalar

Dosya / Dizin Açıklama Öne Çıkanlar
terminal_app.py Uygulamanın giriş noktası Tema, menüler, REST login, WS abonelik
api_client.py REST & WS yardımcı sınıflar HMAC imza, token saklama, throttle, session refresher
ws_logger.py WS mesajlarını ayrı ekranda izler Renkli JSON paneli, zaman damgası
config.py Kullanıcı-parametreleri (🛑 boş değerleri doldurun) API URL, anahtarlar, kullanıcı kimlik bilgileri
requirements.txt PIP bağımlılık listesi Python ≥ 3.10

🗺️ İçindekiler

  1. Özellikler
  2. Gereksinimler
  3. Yapılandırma
  4. Kullanım
  5. Geliştirici Notları
  6. Sık Sorulanlar
  7. Katkı & Lisans

✨ Özellikler
🎨 Zengin Arayüz Monokai renk paleti, paneller, tablolar
🔑 Güvenli Giriş HMAC-SHA256 imzası + JWT token, SMS-OTP
🕒 Rate-Limit İstek başına gecikme, 60 sn’de bir otomatik token yenileme
🌐 WebSocket TLS, heartbeat paketi, kopmada otomatik bağlanma
📈 Menü Akışı Portföy, Hisse, Vadeli, WS abonelik menüleri
📑 Renkli JSON json_panel() ile kolay okunur REST/WS yanıtı
🪄 Canlı WS Logu ws_logger.py gelen mesajları yeni konsolda gösterir

⚙️ Gereksinimler

Python 3.10+
rich        >= 13
requests    >= 2.32
websockets  >= 12
urllib3     >= 2

git clone https://github.com/BoraDurkun/Colendi-API-Python-Wrapper.git
cd Colendi-API-Python-Wrapper
# Linux/macOS
cp example.config.py config.py

# Windows (PowerShell/CMD)
copy example.config.py config.py

🛠️ Yapılandırma

config.py içeriğini mutlaka API bilgileriniz ile doldurun:

API_HOST   = "https://api.codyalgo.com:11443"
API_URL    = API_HOST
API_WS_URL = "wss://api.codyalgo.com:11443/ws"

API_KEY    = "🚀 Colendi Menkul değerler public-key bilginiz"
API_SECRET = "🔑 Colendi Menkul değerler secret-key bilginiz"
USERNAME   = "👤 Colendi Menkul değerler internet şubesi kullanıcı adınız "
PASSWORD   = "🔒 Colendi Menkul değerler internet şubesi şifreniz"

# Enum haritaları (gerekirse düzenleyin)
DIRECTION_MAP          = {1: "BUY", 2: "SELL"}
WEBSOCKET_SUBSCRIBE    = {1: "AddT", 2: "AddY", 3: "AddD"}
WEBSOCKET_UNSUBSCRIBE  = {1: "RemoveT", 2: "RemoveY", 3: "RemoveD"}

config.py ve çalışma anında oluşan api_settings.json .gitignore içinde kalmalıdır.

▶️ Kullanım

python terminal_app.py
  1. API Bilgileri ekranda görünür.
  2. Kayıtlı token geçerliyse direkt giriş; değilse OTP akışı başlar.
  3. Giriş başarılıysa Ana Menü gelir:
1) Portfolio Endpoints Menüsü
2) Stock Endpoints Menüsü
3) Future Endpoints Menüsü
4) WebSocket Abonelik Menüsü
*) Çıkış

WebSocket Aboneliği

[1] Abone Ol      # AddT / AddY / AddD ...
[2] Abonelikten Çık  # RemoveT / RemoveY / RemoveD ...
  • Mesaj tipini seçin
  • Sembolleri virgülle ayırarak girin (GARAN,AKBNK)
  • Başarılıysa ✓ onayı gelir; WS paketleri ws_logger penceresine düşer.

🧑‍💻 Geliştirici Notları

  • Threading + asyncio – WS ayrı daemon thread’de kendi event-loop’u ile çalışır.
  • Throttle – API.interval (varsayılan 1 sn) her istekten önce bekler.
  • Loglama – Tüm REST/WS olayları logs.log dosyasına INFO seviyesiyle yazılır.
  • Kod Stili – black --line-length 100 & ruff kullanmanız önerilir.

❓ Sık Sorulanlar

| Problem | Çözüm | | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | | | OTP yanıtında token yok | USERNAME / PASSWORD hatalı olabilir; broker hesabınızdaki SMS yetkisini kontrol edin. | | Sürekli ConnectionClosed | Ağ kesintisi veya sunucu idle-timeout. Uygulama otomatik yeniden bağlanır; gerekirse heartbeat_interval değerini azaltın. |

🤝 Katkı & Lisans

  • PR göndermeden önce fork → branch → değişiklik → PR adımlarını izleyin.
  • PR açıklamasına “neyi, neden” değiştirdiğinizi yazın, mümkünse test ekleyin.

Bu proje MIT lisansı ile dağıtılmaktadır – ayrıntı için LICENSE dosyasına bakın.