minor updates

debpal · Sep 18, 2024 · 21204e1 · 21204e1
1 parent d7ef3bc
commit 21204e1
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
 # BharatFinTrack
 
 ## 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:
+BharatFinTrack is a Python package whose concept originated on September 1, 2024. It is designed to simplify the process of downloading and analyzing financial data from India, that is Bharat. The features of the package include:
 
-- **NSE Indices**
-  - Access to characteristics of indices.
+* [Nifty Indices](https://www.niftyindices.com/) website
 
+    - Provides access to the characteristics of NSE indices.
 
 ## Easy Installation
 
@@ -42,16 +42,15 @@ A brief example of how to start:
 ```
 
 ## Documentation
-For detailed information, see the [documentation](https://bharatfintrack.readthedocs.io/en/latest/).
-
-## Toolkit
+For detailed information, see the [documentation](http://bharatfintrack.readthedocs.io/).
 
 
+## Toolkit
 
 | <big>Status</big> | <big>Description</big> |
 | --- | --- |
-| **PyPI**| ![PyPI - Version](https://img.shields.io/pypi/v/BharatFinTrack) ![PyPI - Status](https://img.shields.io/pypi/status/BharatFinTrack) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/BharatFinTrack) ![PyPI - Wheel](https://img.shields.io/pypi/wheel/BharatFinTrack)|
-| **GitHub** | ![GitHub last commit](https://img.shields.io/github/last-commit/debpal/BharatFinTrack) [![flake8](https://github.com/debpal/BharatFinTrack/actions/workflows/linting.yml/badge.svg?branch=master)](https://github.com/debpal/BharatFinTrack/actions/workflows/linting.yml)	[![mypy](https://github.com/debpal/BharatFinTrack/actions/workflows/typing.yml/badge.svg?branch=master)](https://github.com/debpal/BharatFinTrack/actions/workflows/typing.yml) [![pytest](https://github.com/debpal/BharatFinTrack/actions/workflows/testing.yml/badge.svg?branch=master)](https://github.com/debpal/BharatFinTrack/actions/workflows/testing.yml) ![GitHub repo size](https://img.shields.io/github/repo-size/debpal/BharatFinTrack) |
+| **PyPI**| ![PyPI - Version](https://img.shields.io/pypi/v/BharatFinTrack) ![PyPI - Status](https://img.shields.io/pypi/status/BharatFinTrack) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/BharatFinTrack) ![PyPI - Wheel](https://img.shields.io/pypi/wheel/BharatFinTrack) ![PyPI - Downloads](https://img.shields.io/pypi/dm/BharatFinTrack)|
+| **GitHub** | ![GitHub last commit](https://img.shields.io/github/last-commit/debpal/BharatFinTrack) [![flake8](https://github.com/debpal/BharatFinTrack/actions/workflows/linting.yml/badge.svg)](https://github.com/debpal/BharatFinTrack/actions/workflows/linting.yml)	[![mypy](https://github.com/debpal/BharatFinTrack/actions/workflows/typing.yml/badge.svg)](https://github.com/debpal/BharatFinTrack/actions/workflows/typing.yml) [![pytest](https://github.com/debpal/BharatFinTrack/actions/workflows/testing.yml/badge.svg)](https://github.com/debpal/BharatFinTrack/actions/workflows/testing.yml) ![GitHub repo size](https://img.shields.io/github/repo-size/debpal/BharatFinTrack) |
 | **Codecov** | [![codecov](https://codecov.io/github/debpal/BharatFinTrack/graph/badge.svg?token=6DIYX8MUTM)](https://codecov.io/github/debpal/BharatFinTrack) |
 | **Read**_the_**Docs** | [![Documentation Status](https://readthedocs.org/projects/bharatfintrack/badge/?version=latest)](https://bharatfintrack.readthedocs.io/en/latest/?badge=latest) |
 | **License** | ![PyPI - License](https://img.shields.io/pypi/l/BharatFinTrack) |
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -14,8 +14,10 @@ Version 0.0.3
     * Type checking with `mypy` to verify annotations throughout the codebase.
     * Testing with `pytest` to run tests and ensure code reliability.
     * Test Coverage with **Codecov** to monitor and report test coverage.
+
+* **Compatibity:** Verified compatibility with Python 3.10, 3.11, and 3.12.
 
-* **Documentation:** New badges added to the `README.md` to display statuses of linting, type-checking, testing, and coverage.
+* **Documentation:** Added new badges to `README.md` to display statuses of linting, type-checking, testing, and coverage.
 
 
 Version 0.0.2
@@ -33,10 +35,8 @@ Version 0.0.1
 
 * **Release date:** 08-Sep-2024.
 
-* **Features:** Access to characteristics of NSE Indices via the :class:`BharatFinTrack.NSETrack` class.
+* **Features:** Functionality for accessing the characteristics of NSE Indices via the :class:`BharatFinTrack.NSETrack` class.
 
 * **Development status:** Planning.
 
-* **Roadmap:** Ongoing addition of new features.
-
-* **Birth of** :mod:`BharatFinTrack`: 01-Sep-2024.
+* **Roadmap:** Ongoing addition of new features.
diff --git a/docs/conf.py b/docs/conf.py
@@ -12,8 +12,6 @@
 project = 'BharatFinTrack'
 copyright = '2024, Debasish Pal'
 author = 'Debasish Pal'
-
-# The full version, including alpha/beta/rc tags
 release = __version__
 
 # -- General configuration ---------------------------------------------------

diff --git a/pyproject.toml b/pyproject.toml
@@ -24,16 +24,16 @@ classifiers = [
 ]
 dynamic = ["version"]
 keywords = [
-	"nse index",
-	"total return index(TRI)",
-	"data download",
-	"data analysis"
+	"Nse index",
+	"Total return index(TRI)",
+	"Data download",
+	"Data analysis"
 ]
 
 
 [project.urls]
 "Homepage" = "https://github.com/debpal/BharatFinTrack"
-"Documentation" = "https://bharatfintrack.readthedocs.io/en/latest/"
+"Documentation" = "http://bharatfintrack.readthedocs.io/"
 
 
 [tool.setuptools.dynamic]