Metadata-Version: 2.1
Name: just_design_phase
Version: 0.0.16
Summary: 
Author: Vivek Patel
Author-email: vivekkvhpatel@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: kiteconnect (>=5.0.1,<6.0.0)
Requires-Dist: pandas (>=2.2.1,<3.0.0)
Requires-Dist: pydantic (>=2.6.4,<3.0.0)
Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
Description-Content-Type: text/markdown

# just_design_phase

The `just_design_phase` package provides a seamless interface for interacting with the Kite Connect API for stock trading on the Zerodha platform.

## Installation

To install the `just_design_phase` package, run the following command:

```bash
pip install just_design_phase
```

## Configuration

Before using the `just_design_phase` package, you must configure your environment with necessary API keys and secrets. Follow these steps to set up your environment:

1. **Environment Variables**: Store your Kite Connect API key and secret in a `.env` file at the root of your project. This file should contain:

    ```
    KITE_API_KEY=your_api_key_here
    KITE_API_SECRET=your_api_secret_here
    ```

## Usage

Import the package using the alias `jdp` and utilize its functions for interacting with the Zerodha Kite Connect API.

### Example Imports

```python
import just_design_phase as jdp
```

### Placing Orders

-   **Place a Normal Order**:

    ```python
    order_id = jdp.place_normal_order(stock_name="RELIANCE", quantity=1, order_type="BUY")
    ```

-   **Place a Limit Order**:

    ```python
    order_id = jdp.place_limit_order(stock_name="TCS", quantity=2, price=3500, order_type="SELL")
    ```

### Modifying Orders

-   **Modify an Order**:

    ```python
    modified_order_id = jdp.modify_order(variety="regular", orderId="your_order_id_here", quantity=2, price=3550)
    ```

### Fetching Account Details

-   **Fetch Holdings**:

    ```python
    holdings = jdp.get_holdings()
    ```

-   **Fetch Positions**:

    ```python
    positions = jdp.get_positions()
    ```

### Additional Methods

Include more comprehensive functionalities for trading:

-   **Get Stock Price**:

    ```python
    stock_price = jdp.get_stock_price(name="RELIANCE")
    ```

-   **Get Stock Instrument Token**:

    ```python
    token = jdp.get_stock_instrument_token(stock_name="RELIANCE")
    ```

-   **Buy/Sell Intraday Normal Order**:

    ```python
    order_id = jdp.buy_intraday_normal_order(stock_name="INFY", quantity=10)
    ```

    ```python
    order_id = jdp.sell_intraday_normal_order(stock_name="INFY", quantity=5)
    ```

-   **Buy/Sell Intraday Limit Order**:

    ```python
    order_id = jdp.buy_intraday_limit_order(stock_name="INFY", quantity=10, price=1500)
    ```

    ```python
    order_id = jdp.sell_intraday_limit_order(stock_name="INFY", quantity=5, price=1500)
    ```

-   **Place Stop Loss Market Order**:

    ```python
    order_id = jdp.place_slm_order(stock_name="INFY", quantity=10, order_type="BUY", price=1500)
    ```

-   **Modify Order Properties**:

    ```python
    new_order_id = jdp.modify_order_quantity(variety="regular", order_id="order123", quantity=15)
    ```

    ```python
    new_order_id = jdp.modify_order_price(variety="regular", order_id="order123", price=1520)
    ```

-   **Cancel or Exit Orders**:

    ```python
    jdp.cancel_order(order_id="order123")
    ```

    ```python
    jdp.exit_orders(order_id="order123")
    ```

