- packaged for pip, updated folder structure.

- Updated README installation section and minor details. - Exit on error. BSE.py __exit__ - Updated import statements in examples folder. - Correction in examples/news.py for argv length check.
BennyThadikaran · Oct 9, 2023 · 75d5a71 · 75d5a71
1 parent a82deb1
commit 75d5a71
Show file tree

Hide file tree

Showing 11 changed files with 71 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -1,15 +1,22 @@
 # BseIndiaApi
+
 An unofficial python api for BSE India stock exchange.
 
-## Installation
 Python version: >= 3.6
 
-Download or clone the repo and install the dependencies: `pip install requests`
+## Install with PIP
+
+```
+pip install bse
+```
 
 ## Usage
 
 Using with statement
+
 ```python
+from bse import BSE
+
 with BSE() as bse:
     code = bse.getScripCode('tcs') # 532540 bse scrip code
 
@@ -19,8 +26,12 @@ with BSE() as bse:
 
     bse.quote(scrip_code) # Open, High, Low, LTP
 ```
+
 or
+
 ```python
+from bse import BSE
+
 bse = BSE()
 
 code = bse.getScripCode('tcs') # 532540 bse scrip code
@@ -31,6 +42,7 @@ bse.exit() # close the request session
 ```
 
 ## Sample Responses
+
 `src/samples` contain the sample responses from the various methods in JSON format.
 
 The files are named after the corresponding method in `src/BSE.py`. Use it to understand the API response structure.
@@ -42,49 +54,50 @@ Help on class BSE in module BSE:
 
 class BSE(builtins.object)
  |  Unofficial api for BSE India
- |  
+ |
  |  Methods defined here:
- |  
+ |
  |  __init__(self)
  |      Initialize self.  See help(type(self)) for accurate signature.
- |  
+ |
  |  advanceDecline(self)
  |      returns list of dictionary of advance decline values for each index
- |  
+ |
  |  allAnnouncements(self, fromDate, toDate, category='-1')
  |      Returns all news items by date
- |  
+ |
  |  allCorporateActions(self)
  |      returns list of dictionary of all corporate actions
- |  
+ |
  |  announcements(self, scripcode, fromDate, toDate)
  |      Return Corporate announcements by scripcode and date
- |  
+ |
  |  corporateActions(self, scripcode)
  |      Returns Corporate Actions by scripcode
  |
  |  exit(self)
- |  
+ |
  |  getScripCode(self, scripname)
  |      returns bse symbol code for stock symbol name
- |  
+ |
  |  getScripName(self, scripcode)
  |      returns stock symbol name for bse scrip code
- |  
+ |
  |  listSecurities(self, industry='', scripcode='', group='', segment='Equity', status='Active')
  |      List all securities with their meta info or filter by industry etc.
- |  
+ |
  |  near52WeekHighLow(self, scripcode='', indexcode='', group='')
  |      Returns stocks near 52 week highs and lows
- |  
+ |
  |  quote(self, scripcode)
  |      Get OHLC quotes for given scripcode
- |  
+ |
  |  scripMeta(self, scripcode='', segment='Equity', status='Active', group='', industry='')
  |      Return scrip meta info for all stocks or filtered by industry etc
 ```
 
 ## CONSTANTS
+
 ```python
 # Corporate Announcement categories
 CATEGORY_AGM = 'AGM/EGM'
@@ -134,15 +147,18 @@ INDUSTRY_UTILITIES = 'Utilities'
 ```
 
 ## Example Folder
+
 `src/examples` contains scripts that use the `BSE.py`. These are script i wrote some years back. All scripts incorporate color and fancy formatting to look good. 😄
 
+To use the scripts download or clone the repo.
+
 - **ann.py**: This is the only script i still use to date. It display all corporate announcements and corporate actions relating to your watchlist or portfolio.
-    - To get started, store your watchlist symbols in a text file each symbol on a new line.
-    - At first, execute `ann.py` passing the text file as an argument. `py ann.py watchlist.txt`. This will generate a `watchlist.json` file and print out all announcements and actions related to your watchlist.
-    - Next time, simply execute `py ann.py` to see announcements for the day.
+  - To get started, store your watchlist symbols in a text file each symbol on a new line.
+  - At first, execute `ann.py` passing the text file as an argument. `py ann.py watchlist.txt`. This will generate a `watchlist.json` file and print out all announcements and actions related to your watchlist.
+  - Next time, simply execute `py ann.py` to see announcements for the day.
 - **news.py**: `news.py` simply prints the last 10 announcements for a scrip.
-    - Execute it as `py news.py infy`.
-    - You can optionally limit the results by passing a number after the symbol.
-    - `py news.py infy 3`. This returns the last 3 announcements.
+  - Execute it as `py news.py infy`.
+  - You can optionally limit the results by passing a number after the symbol.
+  - `py news.py infy 3`. This returns the last 3 announcements.
 - **actions.py**: `py actions.py infy` to print the recent corporate actions. Nothing more.
-- **advances.py**: `py advances.py` to print the advance decline ratios for various bse Indexes. 
+- **advances.py**: `py advances.py` to print the advance decline ratios for various bse Indexes.
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,24 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "bse"
+version = "0.0.4"
+authors = [
+  { name="Benny Thadikaran" },
+]
+description = "Unofficial Python Api for BSE India stock exchange"
+readme = "README.md"
+requires-python = ">=3.6"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Operating System :: OS Independent",
+]
+keywords = ["bse", "bse-stock-data", "stock-market-api", "stock-news-api"]
+dependencies = ["requests==2.31.0"]
+
+[project.urls]
+"Homepage" = "https://github.com/BennyThadikaran/BseIndiaApi"
+"Bug Tracker" = "https://github.com/BennyThadikaran/BseIndiaApi/issues"
diff --git a/requirements.txt b/requirements.txt
diff --git a/src/__init__.py b/src/__init__.py
@@ -0,0 +1 @@
+from bse import BSE
diff --git a/src/BSE.py → src/bse/BSE.py b/src/BSE.py → src/bse/BSE.py
@@ -1,6 +1,6 @@
 from requests import Session
 from requests.exceptions import ReadTimeout
-from Throttle import Throttle
+from .Throttle import Throttle
 from re import search
 
 throttle_config = {
@@ -85,7 +85,7 @@ def __enter__(self):
     def __exit__(self, exc_type, exc_value, exc_traceback):
         self.session.close()
         if exc_type:
-            print(f'{exc_type}: {exc_value} | {exc_traceback}')
+            exit(f'{exc_type}: {exc_value} | {exc_traceback}')
         return True
 
     def exit(self):

diff --git a/src/Throttle.py → src/bse/Throttle.py b/src/Throttle.py → src/bse/Throttle.py
diff --git a/src/bse/__init__.py b/src/bse/__init__.py
@@ -0,0 +1 @@
+from .BSE import BSE
diff --git a/src/examples/actions.py b/src/examples/actions.py
@@ -1,4 +1,4 @@
-from BSE import BSE
+from bse import BSE
 from sys import argv
 from datetime import datetime
 

diff --git a/src/examples/advances.py b/src/examples/advances.py
@@ -1,4 +1,4 @@
-from BSE import BSE
+from bse import BSE
 from os import system
 from sys import platform
 

diff --git a/src/examples/ann.py b/src/examples/ann.py
@@ -1,4 +1,4 @@
-from BSE import BSE
+from bse import BSE
 from datetime import datetime
 from re import findall
 from os import system

diff --git a/src/examples/news.py b/src/examples/news.py
@@ -1,4 +1,4 @@
-from BSE import BSE
+from bse import BSE
 from datetime import datetime, timedelta
 from sys import argv
 
@@ -9,7 +9,7 @@
 sym = argv[1]
 toDate = datetime.today()
 daysBack = 10
-count = int(argv[2]) if len(argv) == 2 else None
+count = int(argv[2]) if len(argv) == 3 else None
 
 attach_url = 'https://www.bseindia.com/xml-data/corpfiling/AttachLive'