redoing test cases

mdalvi · Oct 24, 2024 · b76600e · b76600e
1 parent 9ef5e37
commit b76600e
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 78 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,62 @@
-# zerodha_api
-Zerodha Kite API Wrapper 
+# Zerodha API
+[![codecov](https://codecov.io/github/mdalvi/zerodha_api/graph/badge.svg?token=ZYRWQBZG7J)](https://codecov.io/github/mdalvi/zerodha_api)
+
+This is a data aggregation wrapper for Zerodha's Kite Connect API that simplifies market data handling for machine learning and data analysis.
+
+## Features
+
+```python
+# TODO
+```
+## Installation
+
+```python
+# TODO
+```
+
+## Prerequisites
+
+```python
+# TODO
+```
+
+## Configuration
+
+```python
+# TODO
+```
+
+## Usage
+
+```python
+# TODO
+```
+
+## Key Components
+
+- `Connect`: Main class for interacting with Kite API
+- `Ticker`: WebSocket implementation for real-time market data
+- `Redis`: Caching layer for market data and state management
+- `Celery`: Asynchronous task processing for data handling
+
+## Development
+
+```bash
+# Install development dependencies
+poetry install ../zerodha_api/
+
+# Run tests
+pytest
+
+# Generate coverage report
+pytest --cov=./ --cov-report=xml
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Acknowledgments
+
+- [Zerodha Kite Connect API](https://kite.trade/docs/connect/v3/)
+- [KiteConnect Python Client](https://kite.trade/docs/pykiteconnect/v4/)
diff --git a/tests/test_sample.py → tests/test_connect.py b/tests/test_sample.py → tests/test_connect.py
diff --git a/tests/test_zerodha_api.py b/tests/test_zerodha_api.py