BharatFinTrack 0.0.1__py3-none-any.whl

BharatFinTrack/__init__.py

@@ -0,0 +1,9 @@
+from .nse_track import NSETrack
+
+
+__all__ = [
+    'NSETrack'
+]
+
+
+__version__ = '0.0.1'

BharatFinTrack/nse_track.py

@@ -0,0 +1,186 @@
+class NSETrack:
+    
+    '''
+    Represents characteristics of NSE finance products.
+    '''
+    
+    
+    @property
+    def indices_category(self):
+        
+        '''
+        Returns a list categories for NSE indices.
+        '''
+        
+        output = [
+            'broad', 
+            'sectoral', 
+            'thematic', 
+            'strategy'
+        ]
+        
+        return output
+    
+    
+    def get_indices_by_category(self, category):
+        
+        '''
+        Returns NSE indices for a specified category.
+
+        Parameters
+        ----------
+        category : str
+            The classification type of NSE indices.
+
+        Returns
+        -------
+        list
+            A list containing the names of indices for the specified category.
+        '''
+        
+        indices = {}
+        
+        # broad index
+        indices['broad'] = [
+            'NIFTY 500',
+            'NIFTY 50'
+        ]
+        
+        # sectoral index
+        indices['sectoral'] = [
+            'NIFTY IT',
+            'NIFTY BANK'
+        ]
+        
+        # thematic index
+        indices['thematic'] = [
+            'NIFTY EV & NEW AGE AUTOMOTIVE',
+            'NIFTY INDIA DEFENCE'
+        ]
+        
+        # strategy index
+        indices['strategy'] = [
+            'NIFTY ALPHA 50',
+            'NIFTY MIDCAP150 MOMENTUM 50'
+        ]
+        
+        if category in self.indices_category:
+            pass
+        else:
+            raise Exception(f'Invadid category: {category}')
+        
+        return indices[category]
+    
+    
+    @property
+    def downloadable_indices(self):
+        
+        '''
+        Returns a list of all indices names.
+        '''
+        
+        output = [
+            index for category in self.indices_category for index in self.get_indices_by_category(category)
+        ]
+        
+        return output
+    
+
+    def is_valid_index(self, index):
+        
+        '''
+        Checks whether a specified NSE index name is valid.
+
+        Parameters
+        ----------
+        index : str
+            The name of the NSE index.
+
+        Returns
+        -------
+        bool
+            True if the index name is valid, False.
+        '''
+        
+        return index in self.downloadable_indices
+    
+    
+    @property
+    def indices_base_date(self):
+        
+        '''
+        Returns a dictionary where keys are indices 
+        and values are their corresponding base dates.
+        '''
+        
+        default_date = '01-Apr-2005'
+        
+        start_date = {}
+        
+        start_date['01-Jan-1995'] = ['NIFTY 500']
+        start_date['03-Nov-1995'] = ['NIFTY 50']
+        start_date['01-Jan-1996'] = ['NIFTY IT']
+        start_date['01-Jan-2000'] = ['NIFTY BANK']
+        start_date['31-Dec-2003'] = ['NIFTY ALPHA']
+        start_date['02-Apr-2018'] = [
+            'NIFTY EV & NEW AGE AUTOMOTIVE'
+            'NIFTY INDIA DEFENCE'
+        ]
+
+        date_dict = {v: key for key, value in start_date.items() for v in value}
+        
+        output = dict(
+            map(lambda x: (x, date_dict.get(x, default_date)), self.downloadable_indices)
+        )
+        
+        return output
+    
+    
+    def get_index_base_date(self, index):
+        
+        '''
+        Returns the base date for a specified NSE index.
+
+        Parameters
+        ----------
+        index : str
+            The name of the NSE index.
+
+        Returns
+        -------
+        str
+            The base date of the index in 'DD-MMM-YYYY' format.
+        '''
+        
+        if self.is_valid_index(index):
+            pass
+        else:
+            raise Exception(f'Invalid index: {index}')
+        
+        return self.indices_base_date[index]
+    
+    
+    def get_index_base_value(self, index):
+        
+        '''
+        Returns the base value for a specified NSE index.
+
+        Parameters
+        ----------
+        index : str
+            The name of the NSE index.
+
+        Returns
+        -------
+        float
+            The base value of the index.
+        '''
+        
+        if self.is_valid_index(index):
+            pass
+        else:
+            raise Exception(f'Invalid index: {index}')
+            
+        base_value = {'NIFTY IT': 100.0}
+        
+        return base_value.get(index, 1000.0)

BharatFinTrack-0.0.1.dist-info/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Debasish Pal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

BharatFinTrack-0.0.1.dist-info/METADATA

@@ -0,0 +1,83 @@
+Metadata-Version: 2.1
+Name: BharatFinTrack
+Version: 0.0.1
+Summary: Downloading and analyzing financial data, including indices, stocks, and mutual funds, from India, that is, Bharat.
+Author-email: Debasish Pal <bestdebasish@gmail.com>
+Project-URL: Homepage, https://github.com/debpal/BharatFinTrack
+Project-URL: Documentation, https://bharatfintrack.readthedocs.io/en/latest/
+Keywords: nse index,nse total return index,data download,data analysis
+Classifier: Development Status :: 1 - Planning
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Education
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+
+# BharatFinTrack
+
+## Analysis Toolkit
+
+| Feature | Badge|
+| --- | --- |
+| Documemt | [![Documentation Status](https://readthedocs.org/projects/bharatfintrack/badge/?version=latest)](https://bharatfintrack.readthedocs.io/en/latest/?badge=latest) |
+
+
+## What is BharatFinTrack?
+BharatFinTrack is a Python package designed to simplify the process of downloading and analyzing financial data from India, that is Bharat. The current features of the package include:
+
+- **NSE Indices**
+  - Access to characteristics of indices.
+  - Download of historical daily Total Return Index (TRI) values.
+
+
+## Easy Installation
+
+To install, use pip:
+
+```bash
+pip install BharatFinTrack
+```
+
+## Quickstart
+A brief example of how to start:
+
+```python
+>>> import BharatFinTrack
+>>> nse_track = BharatFinTrack.NSETrack()
+>>> nse_track.indices_category
+['broad', 'sectoral', 'thematic', 'strategy']
+
+# get the list of downloadable indices
+>>> nse_track.downloadable_indices
+['NIFTY 500',
+ 'NIFTY 50',
+ 'NIFTY IT',
+ 'NIFTY BANK',
+ ...]
+
+# get the dictionary of indices base date
+>>> nse_track.indices_base_date
+{'NIFTY 500': '01-Jan-1995',
+ 'NIFTY 50': '03-Nov-1995',
+ 'NIFTY IT': '01-Jan-1996',
+ 'NIFTY BANK': '01-Jan-2000',
+ ...}
+```
+
+
+## Documentation
+For detailed information, see the [documentation](https://bharatfintrack.readthedocs.io/en/latest/).
+
+
+## Development status
+
+The project is in the conceptualization and planning phases.
+
+
+## License
+
+The package is released under the MIT License.

BharatFinTrack-0.0.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+BharatFinTrack/__init__.py,sha256=ztHT709JQ48koDCF_Wa0s4MqvwLLmPRk1IzbIlMbZ7w,94
+BharatFinTrack/nse_track.py,sha256=C8apYEbqQXlCHDT2_SBH0RMHP_mIEkQERvIZWejUn7g,4454
+BharatFinTrack-0.0.1.dist-info/LICENSE.txt,sha256=KHtq3IB8A7uqL5aoINWYplXVYU-YpAlUo9Ugt8_roFU,1090
+BharatFinTrack-0.0.1.dist-info/METADATA,sha256=c0bX7zNNX5GAiez9WCi0nRbqAqP_8NeaQnaRb79KjJA,2455
+BharatFinTrack-0.0.1.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
+BharatFinTrack-0.0.1.dist-info/top_level.txt,sha256=y5g9pTqy4I9foo3PDKM5fQod6TI2PxD4evTU-VS1T-0,15
+BharatFinTrack-0.0.1.dist-info/RECORD,,

BharatFinTrack-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (74.1.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

BharatFinTrack-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+BharatFinTrack