- Version 2.0.0

- Updated README
- Added class init documentation

README.md

@@ -7,7 +7,7 @@ Python version: >= 3.10
 ## Install with PIP
 
 ```
-pip install bse
+pip install -U bse
 ```
 
 ## Documentation
@@ -23,14 +23,12 @@ Using with statement
 ```python
 from bse import BSE
 
-with BSE() as bse:
-    scripCode = bse.getScripCode('tcs') # 532540 bse scrip code
+with BSE(download_folder='./') as bse:
+    scripCode = bse.getScripCode('tcs')  # 532540 bse scrip code
 
-    bse.getScripName('532540') # TCS
+    data = bse.actions(scripcode=scripCode)
 
-    data = bse.corporateActions(scripCode)
-
-    oclc = bse.quote(scripCode) # Open, High, Low, LTP
+    ohlc = bse.quote(scripCode)  # Open, High, Low, LTP
 ```
 
 or
@@ -39,13 +37,13 @@ or
 from bse import BSE
 from bse.constants import INDEX
 
-bse = BSE()
+bse = BSE(download_folder='./')
 
-code = bse.getScripCode('tcs') # 532540 bse scrip code
+code = bse.getScripCode('tcs')  # 532540 bse scrip code
 
 gainers = bse.gainers(by='index', name=INDEX.BSE500)
 
-bse.exit() # close the request session
+bse.exit()  # close the request session
 ```
 
 ## Sample Responses

docs/source/conf.py

@@ -16,7 +16,7 @@
 project = 'bse'
 copyright = '2023, Benny Thadikaran'
 author = 'Benny Thadikaran'
-release = '1.0.0'
+release = '2.0.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/source/usage.rst

@@ -31,6 +31,8 @@ Example
 API
 ___
 
+.. autoclass:: bse.BSE
+
 General Methods
 ---------------
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bse"
-version = "1.0.0"
+version = "2.0.0"
 authors = [
   { name="Benny Thadikaran" },
 ]