wip

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change log
 
+## [1.0.0] - 2024-03-09
+
+### Added
+- Updated docs
+
+### Changed
+- n/a
+
 ## [0.7.2] - 2024-03-04
 
 ### Added

README.md

@@ -89,18 +89,20 @@ df = get_market_inf_more_data('2022-03-01','2022-03-02') # get historical market
 print(df.to_string())
 ```
 
-#### Get CSE last or current trading data
+#### Get DSE Market Depth data
 ```python
-from bdshare import get_cse_current_trade_data
+from bdshare import get_market_depth_data
 
-df = get_cse_current_trade_data() # get all instrument data
+df = get_market_depth_data('ACI') # get current buy and sell data
 print(df.to_string())
 ```
+
+#### Save data to csv file
 ```python
-from bdshare import get_cse_current_trade_data
+from bdshare import get_basic_hist_data, Store
 
-df = get_cse_current_trade_data('GP') # get specific instrument data
-print(df.to_string())
+df = get_basic_hist_data('2022-03-01','2022-03-02') # get all instrument data
+Store(df).save()
 ```
 
 ### <a name="functions"></a> [List of functions](#contents)
@@ -133,12 +135,14 @@ print(df.to_string())
 
 ### <a name="roadmap"></a> [TODO's and Road Map:](#contents)
  - [x] refine logic for parameters 
- - [x] examples;
+ - [x] Demo example;
  - [x] DSE daily data and historical data crawling
  - [x] DSE news,p/e crawling
- - [x] Add CSE support for last trading price
- - [x] Add DSE Index data support
  - [x] Add DSEX Index data support
+ - [x] Create tests
+ - [x] Store dat to csv
+ - [x] DSE market depth data
+ - [x] Add docker support in demo example
 
 
 ### Documentation

bdshare/_version.py

@@ -1,2 +1,2 @@
-version_info = (0, 7, 2)
+version_info = (1, 0, 0)
 __version__ = '.'.join(map(str, version_info))

bdshare/util/store.py

@@ -5,7 +5,13 @@
 import os
 
 class Store(object):
-
+    """
+        Store dataframe
+        :param data: dataframe,
+        :param name: str,
+        :param path: str,
+        :return: none
+    """
     def __init__(self, data=None, name=None, path=None):
         if isinstance(data, pd.DataFrame):
             self.data = data

bdshare/util/vars.py

@@ -16,7 +16,4 @@
 DSE_MARKET_DEPTH_URL = "ajax/load-instrument.php"
 DSE_MARKET_DEPTH_REFERER_URL="mkt_depth_3.php"
 
-DSEX_INDEX_VALUE = "dseX_share.php"
-
-CSE_URL = "https://www.cse.com.bd/"
-CSE_LSP_URL = "market/current_price"
+DSEX_INDEX_VALUE = "dseX_share.php"

setup.cfg

@@ -1,12 +1,12 @@
 [metadata]
 name = bdshare
-version = 0.7.2
+version = 1.0.0
 author= Raisul Islam
 author_email= [email protected]
-description = A utility for crawling historical and Real-time Quotes of dse
+description = A utility for crawling historical and Real-time Quotes of DSE(Dhaka Stock Exchange)
 long_description_content_type = text/markdown
 long_description = file: README.md, CHANGELOG.md
-keywords= Crawling, DSE, CSE, Financial Data
+keywords= Crawling, DSE, Financial Data
 license= MIT
 classifiers =
     Programming Language :: Python :: 3