feat: rmv requirements-dev.txt

Author: jason.hsu

.github/workflows/ci.yml

@@ -47,13 +47,13 @@ jobs:
           print(f'   okx version: {okx.__version__}')
           "
 
-      - name: Install dev dependencies and verify test imports
+      - name: Verify test imports
         run: |
-          pip install -r requirements-dev.txt
+          pip install pytest
           python -c "
           import pytest
           import unittest
-          print('✅ Dev imports successful')
+          print('✅ Test imports successful')
           "
 
   # ============================================
@@ -105,15 +105,15 @@ jobs:
         uses: actions/cache@v4
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('requirements*.txt') }}
+          key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('requirements.txt') }}
           restore-keys: |
             ${{ runner.os }}-pip-${{ matrix.python-version }}-
             ${{ runner.os }}-pip-
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements-dev.txt
+          pip install -r requirements.txt
           pip install -e .
 
       - name: Run tests

README.md

@@ -20,20 +20,80 @@ Make sure you update often and check the [Changelog](https://www.okx.com/docs-v5
 ### Quick start
 #### Prerequisites
 
-`python version：>=3.9`
+`python version：>=3.7`
 
-`WebSocketAPI： websockets package advise version 6.0`
-
-#### Step 1: register an account on OKX and apply for an API key
+#### Step 1: Register an account on OKX and apply for an API key
 - Register for an account: https://www.okx.com/account/register
 - Apply for an API key: https://www.okx.com/account/users/myApi
 
-#### Step 2: install python-okx
+#### Step 2: Install python-okx
 
-```python
+```bash
 pip install python-okx
 ```
 
+### API Credentials
+
+#### Option 1: Hardcoded credentials
+
+```python
+from okx import Account
+
+account = Account.AccountAPI(
+    api_key="your-api-key-here",
+    api_secret_key="your-api-secret-here",
+    passphrase="your-passphrase-here",
+    flag="1",  # 0 = live trading, 1 = demo trading
+    debug=False
+)
+```
+
+#### Option 2: Using `.env` file (recommended)
+
+Create a `.env` file in your project root:
+
+```bash
+OKX_API_KEY=your-api-key-here
+OKX_API_SECRET=your-api-secret-here
+OKX_PASSPHRASE=your-passphrase-here
+OKX_FLAG=1
+```
+
+Then load it in your code:
+
+```python
+import os
+from dotenv import load_dotenv
+from okx import Account
+
+load_dotenv()
+
+account = Account.AccountAPI(
+    api_key=os.getenv('OKX_API_KEY'),
+    api_secret_key=os.getenv('OKX_API_SECRET'),
+    passphrase=os.getenv('OKX_PASSPHRASE'),
+    flag=os.getenv('OKX_FLAG', '1'),
+    debug=False
+)
+```
+
+### Development Setup
+
+For contributors or local development:
+
+```bash
+# Clone the repository
+git clone https://github.com/okxapi/python-okx.git
+cd python-okx
+
+# Install dependencies
+pip install -r requirements.txt
+pip install -e .
+
+# Run tests
+pytest test/unit/ -v
+```
+
 #### Step 3: Run examples
 
 - Fill in API credentials in the corresponding examples

requirements-dev.txt

@@ -1,7 +1,15 @@
-# Core dependencies for python-okx
+# Core dependencies
 httpx[http2]>=0.24.0
 requests>=2.25.0
 websockets>=10.0
 certifi>=2021.0.0
 loguru>=0.7.0
+python-dotenv>=1.0.0
 
+# Development & Testing
+pytest>=7.0.0
+pytest-asyncio>=0.21.0
+pytest-cov>=4.0.0
+ruff>=0.1.0
+build>=1.0.0
+twine>=4.0.0

requirements.txt

@@ -54,7 +54,4 @@ def parse_requirements(filename):  # type: (str) -> list
         "Operating System :: OS Independent",
     ],
     install_requires=parse_requirements("requirements.txt"),
-    extras_require={
-        "dev": parse_requirements("requirements-dev.txt"),
-    },
 )