tradekartapi 0.1.0__tar.gz

tradekartapi-0.1.0/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: tradekartapi
+Version: 0.1.0
+Summary: Tradekart wrapper SDK for Groww trading APIs
+Author-email: Vikalp <tradekart@gmail.com>, Siddhant <tradekart@gmail.com>, Lakshay <tradekart@gmail.com>
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: growwapi
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3.2; extra == "dev"
+Requires-Dist: ruff>=0.12.1; extra == "dev"
+Requires-Dist: build>=1.2.2; extra == "dev"
+Requires-Dist: twine>=5.1.1; extra == "dev"
+Provides-Extra: aws
+Requires-Dist: boto3>=1.34.0; extra == "aws"
+
+# README #
+
+This README would normally document whatever steps are necessary to get your application up and running.
+
+### What is this repository for? ###
+
+* Quick summary
+* Version
+* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo)
+
+### How do I get set up? ###
+
+* Summary of set up
+* Configuration
+* Dependencies
+* Database configuration
+* How to run tests
+* Deployment instructions
+
+### Contribution guidelines ###
+
+* Writing tests
+* Code review
+* Other guidelines
+
+### Who do I talk to? ###
+
+* Repo owner or admin
+* Other community or team contact

tradekartapi-0.1.0/README.md

@@ -0,0 +1,29 @@
+# README #
+
+This README would normally document whatever steps are necessary to get your application up and running.
+
+### What is this repository for? ###
+
+* Quick summary
+* Version
+* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo)
+
+### How do I get set up? ###
+
+* Summary of set up
+* Configuration
+* Dependencies
+* Database configuration
+* How to run tests
+* Deployment instructions
+
+### Contribution guidelines ###
+
+* Writing tests
+* Code review
+* Other guidelines
+
+### Who do I talk to? ###
+
+* Repo owner or admin
+* Other community or team contact

tradekartapi-0.1.0/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tradekartapi"
+dynamic = ["version"]
+description = "Tradekart wrapper SDK for Groww trading APIs"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+authors = [
+  { name = "Vikalp", email = "tradekart@gmail.com" },
+  { name = "Siddhant", email = "tradekart@gmail.com" },
+  { name = "Lakshay", email = "tradekart@gmail.com" }
+]
+dependencies = [
+  "growwapi",
+]
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=8.3.2",
+  "ruff>=0.12.1",
+  "build>=1.2.2",
+  "twine>=5.1.1",
+]
+aws = [
+  "boto3>=1.34.0",
+]
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["tradekartapi*"]
+
+[tool.setuptools.dynamic]
+version = { attr = "tradekartapi.version.__version__" }
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

tradekartapi-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tradekartapi-0.1.0/src/tradekartapi/__init__.py

@@ -0,0 +1,6 @@
+from .version import __version__
+
+__all__ = [
+    '__version__',
+    
+]

tradekartapi-0.1.0/src/tradekartapi/adapter/__init__.py

@@ -0,0 +1,5 @@
+from .groww_sdk_adapter import GrowwSDKAdapter
+
+__all__ = [
+    'GrowwSDKAdapter'
+]

tradekartapi-0.1.0/src/tradekartapi/adapter/groww_sdk_adapter.py

@@ -0,0 +1,24 @@
+from typing import Any
+
+from ..utils import validate_access_token
+
+class GrowwSDKAdapter:
+    """
+    Thin adapter over official GrowwAPI SDK object.
+    This keeps our services decoupled from direct SDK construction.
+    """
+
+    def __init__(self, sdk_client: Any) -> None:
+        self._sdk_client = sdk_client
+
+    @classmethod
+    def from_access_token(cls, access_token: str, groww_sdk_client: Any) -> 'GrowwSDKAdapter':
+        #validate access token
+        validate_access_token(access_token)
+        #initialize sdk client
+        sdk_client = groww_sdk_client(access_token)
+        return cls(sdk_client=sdk_client)
+
+    @property
+    def client(self) -> Any:
+        return self._sdk_client

tradekartapi-0.1.0/src/tradekartapi/client.py

@@ -0,0 +1,29 @@
+from typing import Any
+
+from .adapter import GrowwSDKAdapter
+from .services import OrderService
+
+
+class TradeKartClient:
+    """
+    Main facade for app developers.
+
+    Example:
+        from growwapi import GrowwAPI
+        from tradekartapi.client import TradeKartClient
+        client = TradeKartClient.from_access_token("token", GrowwAPI)
+    """
+
+    def __init__(self, adapter: GrowwSDKAdapter):
+        self._adapter = adapter
+        self.order_service = OrderService(adapter)
+
+    @classmethod
+    def from_access_token(cls, access_token: str, groww_sdk_client: Any) -> 'GrowwClient':
+        adapter = GrowwSDKAdapter.from_access_token(access_token, groww_sdk_client)
+        return cls(adapter=adapter)
+
+    @property
+    def raw_sdk(self) -> Any:
+        return self._adapter.client
+        

tradekartapi-0.1.0/src/tradekartapi/config/__init__.py

@@ -0,0 +1,6 @@
+from .configuration import DEFAULT_TIMEOUT_SECONDS, PACKAGE_NAME
+
+__all__ = [
+    'DEFAULT_TIMEOUT_SECONDS',
+    'PACKAGE_NAME',
+]

tradekartapi-0.1.0/src/tradekartapi/config/configuration.py

@@ -0,0 +1,4 @@
+# for future configuration like retry, timeout, env config
+
+DEFAULT_TIMEOUT_SECONDS = 15
+PACKAGE_NAME = "tradekart-groww-api"

tradekartapi-0.1.0/src/tradekartapi/core/__init__.py

@@ -0,0 +1,5 @@
+from .auth import AccessTokenAuth
+
+__all__ = [
+    "AccessTokenAuth",
+]

tradekartapi-0.1.0/src/tradekartapi/core/auth.py

@@ -0,0 +1,12 @@
+from ..exceptions import AuthenticationError
+
+
+class AccessTokenAuth:
+    """Authentication using access token."""
+
+    @staticmethod
+    def validate(access_token: str) -> str:
+        token = access_token.strip() if access_token else ""
+        if not token:
+            raise AuthenticationError("Access token is required")
+        return token

tradekartapi-0.1.0/src/tradekartapi/exceptions/__init__.py

@@ -0,0 +1,19 @@
+from .custom_exceptions import (
+    GrowwApiWrapperError,
+    AuthenticationError,
+    ValidationError,
+    ServiceError,
+    HttpError,
+    RateLimitError,
+    NotFoundError
+)
+
+__all__ = [
+    'GrowwApiWrapperError',
+    'AuthenticationError',
+    'ValidationError',
+    'ServiceError',
+    'HttpError',
+    'RateLimitError',
+    'NotFoundError'
+]

tradekartapi-0.1.0/src/tradekartapi/exceptions/custom_exceptions.py

@@ -0,0 +1,90 @@
+from typing import Any
+
+
+class GrowwApiWrapperError(Exception):
+    """Base exception for the Tradekart Groww wrapper.
+    All package-specific exceptions should inherit from this class so app code
+    can catch one common parent when needed.
+    """
+    def __init__(
+        self,
+        message: str,
+        *,
+        status_code : int | None = None,
+        details: dict[str, Any] | None = None,
+    ) -> None:
+        super().__init__(message)
+        self.message = message
+        self.status_code = status_code
+        self.details = details
+
+    def __str__(self) -> str:
+        parts = [self.message]
+
+        if self.status_code is not None:
+            parts.append(f'status_code={self.status_code}')
+
+        if self.details is not None:
+            parts.append(f'details={self.details}')
+
+        return '|'.join(parts)
+
+
+class AuthenticationError(GrowwApiWrapperError):
+    """Raised when access token is invalid or missing."""
+
+
+class ValidationError(GrowwApiWrapperError):
+    """Raised when input validation fails."""
+
+
+class ServiceError(GrowwApiWrapperError):
+    """Raised when an SDK service operation fails."""
+    
+    def __init__(
+        self,
+        message : str,
+        *,
+        status_code: int | None = None,
+        operation: str | None = None,
+        details : dict[str, Any] | None = None
+    ) -> None:
+        merged_details = dict(details or {})
+        if operation is not None:
+            merged_details['operation'] = operation
+
+        super().__init__(
+            message,
+            status_code=status_code,
+            details=merged_details
+        )
+
+
+class HttpError(GrowwApiWrapperError):
+    """Raised when an HTTP/API layer request fails."""
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        status_code: int | None = None,
+        details: dict[str, Any] | None = None,
+        response_body: Any | None = None,
+    ) -> None:
+        merged_details = dict(details or {})
+
+        if response_body is not None:
+            merged_details['response_body'] = response_body
+
+        super().__init__(
+            message=message,
+            status_code=status_code,
+            details=merged_details,
+        )
+
+class RateLimitError(HttpError):
+    """Raised when API rate limit is hit."""
+
+
+class NotFoundError(HttpError):
+    """Raised when requested resource is not found."""

tradekartapi-0.1.0/src/tradekartapi/services/__init__.py

@@ -0,0 +1,7 @@
+from .orders import OrderService
+# from .portfolio import PortfolioService
+
+__all__ = [
+    'OrderService',
+    # 'PortfolioService'
+]

tradekartapi-0.1.0/src/tradekartapi/services/orders.py

@@ -0,0 +1,75 @@
+from typing import Any
+
+from ..types import CancelOrderRequest, GetOrderList, ModifyOrderRequest, OrderDetail, OrderStatus, PlaceOrderRequest
+from ..exceptions import ServiceError
+
+
+class OrderService:
+    def __init__(self, sdk : Any) -> None:
+        self._sdk = sdk.client
+
+    def place_order(self, request: PlaceOrderRequest) -> dict[str, Any]:
+        try:
+            return self._sdk.place_order(**request.to_payload())
+        except Exception as exc:
+            raise ServiceError(
+                'Error in placing order',
+                status_code=500,
+                operation='PLACING_ORDER',
+                details={'reason': 'Error in placing method'},
+            ) from exc
+
+    def modify_order(self, request: ModifyOrderRequest) -> dict[str, Any]:
+        try:
+            return self._sdk.modify_order(**request.to_payload())
+        except Exception as exc:
+            raise ServiceError(
+                'Error in modifying order',
+                status_code=500,
+                operation='MODIFYING_ORDER',
+                details={'reason': 'Error in modify method'},
+            ) from exc
+
+    def cancel_order(self, request: CancelOrderRequest) -> dict[str, Any]:
+        try:
+            return self._sdk.cancel_order(**request.to_payload())
+        except Exception as exc:
+            raise ServiceError(
+                'Error in canceling order',
+                status_code=500,
+                operation='CANCELING_ORDER',
+                details={'reason': 'Error in cancel method'},
+            ) from exc
+
+    def get_order_status(self, request: OrderStatus) -> dict[str, Any]:
+        try:
+            return self._sdk.get_order_status(**request.to_payload())
+        except Exception as exc:
+            raise ServiceError(
+                'Error in getting order status',
+                status_code=500,
+                operation='GET_ORDER_STATUS',
+                details={'reason': 'Error in get order status method'},
+            ) from exc
+
+    def get_order_list(self, request: GetOrderList) -> dict[str, Any]:
+        try:
+            return self._sdk.get_order_list(**request.to_payload())
+        except Exception as exc:
+            raise ServiceError(
+                'Error in getting order list',
+                status_code=500,
+                operation='GET_ORDER_LIST',
+                details={'reason': 'Error in get order list method'},
+            ) from exc
+
+    def get_order_detail(self, request: OrderDetail) -> dict[str, Any]:
+        try:
+            return self._sdk.get_order_detail(**request.to_payload())
+        except Exception as exc:
+            raise ServiceError(
+                'Error in getting order detail',
+                status_code=500,
+                operation='GET_ORDER_DETAIL',
+                details={'reason': 'Error in get order detail method'},
+            ) from exc

tradekartapi-0.1.0/src/tradekartapi/services/portfolio.py

@@ -0,0 +1 @@
+#Todo Add Portfolio Services

tradekartapi-0.1.0/src/tradekartapi/types/__init__.py

@@ -0,0 +1,19 @@
+from .order_types import (
+    PlaceOrderRequest,
+    ModifyOrderRequest,
+    CancelOrderRequest,
+    OrderStatus,
+    OrderStatsByRefId,
+    GetOrderList,
+    OrderDetail,
+)
+
+__all__ = [
+    'PlaceOrderRequest',
+    'ModifyOrderRequest',
+    'CancelOrderRequest',
+    'OrderStatus',
+    'OrderStatsByRefId',
+    'GetOrderList',
+    'OrderDetail'
+]

tradekartapi-0.1.0/src/tradekartapi/types/annexures.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from enum import Enum
+
+class Validity(str, Enum):
+    DAY = 'DAY'
+
+class Exchange(str, Enum):
+    NSE = 'NSE'
+    BSE = 'BSE'
+    MCX = 'MCX'
+
+class Segment(str, Enum):
+    CASH = 'CASH'
+    FNO = 'FNO'
+    COMMODITY = 'COMMODITY'
+
+class Product(str, Enum):
+    CNC = 'CNC'
+    MIS = 'MIS'
+    NRML = 'NRML'
+
+class OrderType(str, Enum):
+    MARKET = 'MARKET'
+    LIMIT = 'LIMIT'
+    STOP_LOSS = 'SL'
+    STOP_LIMIT = 'SL_M'
+
+class TransactionType(str, Enum):
+    BUY = 'BUY'
+    SELL = 'SELL'

tradekartapi-0.1.0/src/tradekartapi/types/order_types.py

@@ -0,0 +1,160 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Any
+from ..utils.validators import require_non_empty, require_positive_int
+from .annexures import Exchange, Segment, Product, OrderType, TransactionType, Validity
+
+
+@dataclass(frozen=True, slots=True)
+class PlaceOrderRequest:
+    trading_symbol: str
+    quantity : int
+    validity : Validity
+    exchange: Exchange
+    segment : Segment
+    product : Product
+    order_type : OrderType
+    transaction_type : TransactionType
+    price: float | None = None
+    trigger_price: float | None = None
+    order_reference_id: str | None = None
+
+    def __post_init__(self) -> None:
+        require_non_empty(self.trading_symbol, 'trading_symbol')
+        require_positive_int(self.quantity, 'quantity')
+        #Todo Add Valodation for price and trigger_price
+
+    def to_payload(self) -> dict[str, Any]:
+        payload = {
+            'trading_symbol': self.trading_symbol,
+            'quantity': self.quantity,
+            'validity': self.validity.value,
+            'exchange': self.exchange.value,
+            'segment': self.segment.value,
+            'product': self.product.value,
+            'order_type': self.order_type.value,
+            'transaction_type': self.transaction_type.value,
+        }
+
+        if self.price is not None:
+            payload['price'] = self.price
+        if self.trigger_price is not None:
+            payload['trigger_price'] = self.trigger_price
+        if self.order_reference_id is not None:
+            payload['order_reference_id'] = self.order_reference_id
+        return payload
+    
+
+@dataclass(frozen=True, slots=True)
+class ModifyOrderRequest:
+    quantity : int
+    order_type : OrderType
+    segment : Segment
+    groww_order_id : str
+    price : float | None = None 
+    trigger_price: float | None = None
+
+    def __post_init__(self) -> None:
+        require_positive_int(self.quantity, 'quantity')
+        require_non_empty(self.groww_order_id, 'groww_order_id')
+        #Todo Add Valodation for price and trigger_price
+
+    def to_payload(self) -> dict[str, Any]:
+        payload = {
+            'quantity': self.quantity,
+            'order_type': self.order_type.value,
+            'segment': self.segment.value,
+            'groww_order_id': self.groww_order_id
+        }
+
+        if self.price is not None:
+            payload['price'] = self.price
+
+        if self.trigger_price is not None:
+            payload['trigger_price'] = self.trigger_price
+
+        return payload
+
+
+@dataclass(frozen=True, slots=True)
+class CancelOrderRequest:
+    segment : Segment
+    groww_order_id : str
+
+    def __post_init__(self) -> None:
+        require_non_empty(self.groww_order_id, 'groww_order_id')
+
+    def to_payload(self) -> dict[str, Any]:
+        return {
+            'segment': self.segment.value,
+            'groww_order_id': self.groww_order_id
+        }
+
+
+@dataclass(frozen=True, slots=True)
+class OrderStatus:
+    segment : Segment
+    groww_order_id : str
+
+    def __post_init__(self) -> None:
+        require_non_empty(self.groww_order_id, 'groww_order_id')
+
+    def to_payload(self) -> dict[str, Any]:
+        return {
+            'segment': self.segment.value,
+            'groww_order_id': self.groww_order_id
+        }
+
+
+@dataclass(frozen=True, slots=True)
+class OrderStatsByRefId:
+    order_reference_id : str
+    segment : Segment
+
+    def __post_init__(self) -> None:
+        require_non_empty(self.order_reference_id, 'order_reference_id')
+
+    def to_payload(self) -> dict[str, Any]:
+        return {
+            'order_reference_id': self.order_reference_id,
+            'segment': self.segment.value
+        }
+        
+
+@dataclass(frozen=True, slots=True)
+class GetOrderList:
+    segment : Segment | None = None
+    page : int | None = None 
+    page_size : int | None = None 
+
+    def __post_init__(self) -> None:
+        if self.page is not None:
+            require_positive_int(self.page, 'page')
+        if self.page_size is not None:
+            require_positive_int(self.page_size, 'page_size')
+
+    def to_payload(self) -> dict[str, Any]:
+        payload = {}
+        if self.segment is not None:
+            payload['segment'] = self.segment.value
+        if self.page is not None:
+            payload['page'] = self.page
+        if self.page_size is not None:
+            payload['page_size'] = self.page_size
+        return payload
+
+
+@dataclass(frozen=True, slots=True)
+class OrderDetail:
+    segment : Segment
+    groww_order_id : str
+
+    def __post_init__(self) -> None:
+        require_non_empty(self.groww_order_id, 'groww_order_id')
+
+    def to_payload(self) -> dict[str, Any]:
+        return {
+            'segment': self.segment.value,
+            'groww_order_id': self.groww_order_id
+        }

tradekartapi-0.1.0/src/tradekartapi/types/portfolio_types.py

@@ -0,0 +1 @@
+#Todo Add Portfolio Types

tradekartapi-0.1.0/src/tradekartapi/utils/__init__.py

@@ -0,0 +1,7 @@
+from .validators import require_non_empty, require_positive_int, validate_access_token
+
+__all__ = [
+    'require_non_empty',
+    'require_positive_int',
+    'validate_access_token'
+]

tradekartapi-0.1.0/src/tradekartapi/utils/validators.py

@@ -0,0 +1,13 @@
+from ..exceptions import ValidationError
+
+def require_non_empty(value: str, field_name: str) -> None:
+    if not value or not value.strip():
+        raise ValidationError(f"{field_name} is required and cannot be empty.")
+
+def require_positive_int(value: int, field_name: str) -> None:
+    if value <= 0:
+        raise ValidationError(f"{field_name} must be greater than 0.")
+
+def validate_access_token(access_token: str) -> None:
+    if not access_token or not access_token.strip():
+        raise ValidationError("Access token is required and cannot be empty.")

tradekartapi-0.1.0/src/tradekartapi/version.py

@@ -0,0 +1,4 @@
+"""Version information for tradekart-groww-api."""
+
+__version_info__ = (0, 1, 0)
+__version__ = ".".join(str(v) for v in __version_info__)

tradekartapi-0.1.0/src/tradekartapi.egg-info/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: tradekartapi
+Version: 0.1.0
+Summary: Tradekart wrapper SDK for Groww trading APIs
+Author-email: Vikalp <tradekart@gmail.com>, Siddhant <tradekart@gmail.com>, Lakshay <tradekart@gmail.com>
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: growwapi
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3.2; extra == "dev"
+Requires-Dist: ruff>=0.12.1; extra == "dev"
+Requires-Dist: build>=1.2.2; extra == "dev"
+Requires-Dist: twine>=5.1.1; extra == "dev"
+Provides-Extra: aws
+Requires-Dist: boto3>=1.34.0; extra == "aws"
+
+# README #
+
+This README would normally document whatever steps are necessary to get your application up and running.
+
+### What is this repository for? ###
+
+* Quick summary
+* Version
+* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo)
+
+### How do I get set up? ###
+
+* Summary of set up
+* Configuration
+* Dependencies
+* Database configuration
+* How to run tests
+* Deployment instructions
+
+### Contribution guidelines ###
+
+* Writing tests
+* Code review
+* Other guidelines
+
+### Who do I talk to? ###
+
+* Repo owner or admin
+* Other community or team contact

tradekartapi-0.1.0/src/tradekartapi.egg-info/SOURCES.txt

@@ -0,0 +1,32 @@
+README.md
+pyproject.toml
+src/tradekartapi/__init__.py
+src/tradekartapi/client.py
+src/tradekartapi/models.py
+src/tradekartapi/version.py
+src/tradekartapi.egg-info/PKG-INFO
+src/tradekartapi.egg-info/SOURCES.txt
+src/tradekartapi.egg-info/dependency_links.txt
+src/tradekartapi.egg-info/requires.txt
+src/tradekartapi.egg-info/top_level.txt
+src/tradekartapi/adapter/__init__.py
+src/tradekartapi/adapter/groww_sdk_adapter.py
+src/tradekartapi/config/__init__.py
+src/tradekartapi/config/configuration.py
+src/tradekartapi/core/__init__.py
+src/tradekartapi/core/auth.py
+src/tradekartapi/core/http_client.py
+src/tradekartapi/core/interfaces.py
+src/tradekartapi/exceptions/__init__.py
+src/tradekartapi/exceptions/custom_exceptions.py
+src/tradekartapi/services/__init__.py
+src/tradekartapi/services/historical.py
+src/tradekartapi/services/market_data.py
+src/tradekartapi/services/orders.py
+src/tradekartapi/services/portfolio.py
+src/tradekartapi/types/__init__.py
+src/tradekartapi/types/annexures.py
+src/tradekartapi/types/order_types.py
+src/tradekartapi/types/portfolio_types.py
+src/tradekartapi/utils/__init__.py
+src/tradekartapi/utils/validators.py

tradekartapi-0.1.0/src/tradekartapi.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

tradekartapi-0.1.0/src/tradekartapi.egg-info/requires.txt

@@ -0,0 +1,10 @@
+growwapi
+
+[aws]
+boto3>=1.34.0
+
+[dev]
+pytest>=8.3.2
+ruff>=0.12.1
+build>=1.2.2
+twine>=5.1.1

tradekartapi-0.1.0/src/tradekartapi.egg-info/top_level.txt

@@ -0,0 +1 @@
+tradekartapi