Merge pull request #13 from mratanusarkar/feat/publish-to-pypi

feat(pypi): prep publish to pypi and release + improve docs

Author: mratanusarkar

.github/workflows/docs.yml

@@ -0,0 +1,43 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  id-token: write
+
+concurrency:
+  group: pages-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  documentation:
+    name: update documentation on github pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+          cache: 'pip'
+
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-${{ runner.os }}-${{ hashFiles('**/pyproject.toml') }}
+          path: .cache
+
+      - name: install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install .[docs]
+      - name: build and deploy documentation
+        run: mkdocs gh-deploy --force
+
+      - name: deployment summary
+        run: echo "✅ Documentation deployed successfully!" >> $GITHUB_STEP_SUMMARY

README.md

@@ -2,9 +2,16 @@
 
 # Tickersnap
 
-[![Python](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
-[![License](https://img.shields.io/badge/license-Apache%202.0-green.svg)](LICENSE)
-[![Tests](https://github.com/mratanusarkar/tickersnap/actions/workflows/tests.yml/badge.svg)](https://github.com/mratanusarkar/tickersnap/actions)
+[![Documentation](https://img.shields.io/badge/docs-mkdocs-4baaaa.svg?logo=materialformkdocs&logoColor=white)](https://mratanusarkar.github.io/tickersnap)
+[![PyPI version](https://img.shields.io/pypi/v/tickersnap.svg?color=blue&logo=pypi&logoColor=white)](https://pypi.org/project/tickersnap/)
+[![Python versions](https://img.shields.io/pypi/pyversions/tickersnap.svg?color=blue&logo=python&logoColor=white)](https://pypi.org/project/tickersnap/)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-orange.svg?logo=apache&logoColor=white)](https://github.com/mratanusarkar/tickersnap/blob/main/LICENSE)
+<br>
+[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/mratanusarkar/tickersnap/docs.yml?logo=githubactions&logoColor=white&label=build)](https://github.com/mratanusarkar/tickersnap/actions)
+[![Tests](https://img.shields.io/github/actions/workflow/status/mratanusarkar/tickersnap/tests.yml?logo=cachet&logoColor=white&label=tests)](https://github.com/mratanusarkar/tickersnap/actions)
+[![Visitors](https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Fmratanusarkar%2Ftickersnap&label=view&labelColor=%235e5e5e&countColor=%237C8AA0&style=flat&labelStyle=lower)](https://visitorbadge.io/status?path=https%3A%2F%2Fgithub.com%2Fmratanusarkar%2Ftickersnap)
+[![PyPI Total Downloads](https://static.pepy.tech/badge/tickersnap)](https://pepy.tech/projects/tickersnap)
+[![PyPI Monthly Downloads](https://img.shields.io/pypi/dm/tickersnap?style=flat&color=%231F86BF)](https://pypistats.org/packages/tickersnap)
 
 **Python Library for Indian Stock Market Analysis** 📈
 
@@ -22,13 +29,13 @@ Tickersnap provides streamlined access to comprehensive Indian stock market data
 > - This library heavily relies on the (unofficial) public APIs from Tickertape IN.
 > - I am not affiliated with Tickertape.in in any way.
 > - Tickertape had been my go to for stock analysis tool for like forever!
-> - and I am greatful to then and a big fan of the work they do!
+> - and I am greatful to them for the work they do!
 
 > [!WARNING]
 > - All data are for **informational purposes only** and should not be considered as financial advice.
 > - Always consult qualified financial advisors before making investment decisions.
 > - I am not an expert in finance.
-> - I am not responsible for how one uses this library, or the consequences, or financial outcomes of using it.
+> - I am not responsible for how one uses this library, the consequences, or financial outcomes of using it.
 
 ## ✨ Key Features
 
@@ -75,7 +82,7 @@ all_stocks = assets.get_all_stocks()
 print(f"Total stocks available: {len(all_stocks)}")
 ```
 
-**👉 [Complete Quick Start Guide](https://mratanusarkar.github.io/tickersnap//quickstart.md)** - Learn with real examples!
+**👉 [Complete Quick Start Guide](https://mratanusarkar.github.io/tickersnap/quickstart.md)** - Learn with real examples!
 
 ## 📦 Core Modules
 
@@ -94,6 +101,7 @@ print(f"Total stocks available: {len(all_stocks)}")
 - **🎯 Market Alerts** - Get notified of sentiment extremes
 - **🔍 Research Tools** - Comprehensive market analysis
 - **🤖 Trading Bots** - Automated analysis and signals
+- **🧠 LLM Agents** - Build agents to get live financial data
 
 **👉 see documentation, every module is filled with usage examples!**
 

docs/index.md

@@ -1,23 +1,75 @@
-# Tickersnap
-
-[![Python](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
-[![License](https://img.shields.io/badge/license-Apache%202.0-green.svg)](https://github.com/mratanusarkar/tickersnap/blob/main/LICENSE)
-
-**Python Library for Indian Stock Market Analysis** 📈
-
-Tickersnap provides streamlined access to comprehensive Indian stock market data from [www.tickertape.in](https://www.tickertape.in), enabling powerful financial analysis, automated screening, and market sentiment tracking.
+<h1 align="center"><strong>Tickersnap</strong></h1>
+
+<p align="center">
+
+<a href="https://mratanusarkar.github.io/tickersnap">
+  <img
+  src="https://img.shields.io/badge/docs-mkdocs-4baaaa.svg?logo=materialformkdocs&logoColor=white"
+  alt="Documentation">
+</a>
+<a href="https://pypi.org/project/tickersnap/">
+  <img
+  src="https://img.shields.io/pypi/v/tickersnap.svg?color=blue&logo=pypi&logoColor=white"
+  alt="PyPI version">
+</a>
+<a href="https://pypi.org/project/tickersnap/">
+  <img src="https://img.shields.io/pypi/pyversions/tickersnap.svg?color=blue&logo=python&logoColor=white"
+  alt="Python versions">
+</a>
+<a href="https://github.com/mratanusarkar/tickersnap/blob/main/LICENSE">
+  <img src="https://img.shields.io/badge/License-Apache%202.0-orange.svg?logo=apache&logoColor=white"
+  alt="License: Apache 2.0">
+</a>
+
+<br>
+
+<a href="https://github.com/mratanusarkar/tickersnap/actions">
+  <img
+  src="https://img.shields.io/github/actions/workflow/status/mratanusarkar/tickersnap/docs.yml?logo=githubactions&logoColor=white&label=build"
+  alt="GitHub Actions Workflow Status">
+</a>
+<a href="https://github.com/mratanusarkar/tickersnap/actions">
+  <img src="https://img.shields.io/github/actions/workflow/status/mratanusarkar/tickersnap/tests.yml?logo=cachet&logoColor=white&label=tests"
+  alt="Tests">
+</a>
+<a href="https://visitorbadge.io/status?path=https%3A%2F%2Fgithub.com%2Fmratanusarkar%2Ftickersnap">
+  <img src="https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Fmratanusarkar%2Ftickersnap&label=view&labelColor=%235e5e5e&countColor=%237C8AA0&style=flat&labelStyle=lower"
+  alt="Visitors">
+</a>
+
+<a href="https://pepy.tech/projects/tickersnap">
+  <img src="https://static.pepy.tech/badge/tickersnap"
+  alt="PyPI Total Downloads">
+</a>
+
+<a href="https://pypistats.org/packages/tickersnap">
+  <img src="https://img.shields.io/pypi/dm/tickersnap?style=flat&color=%231F86BF"
+  alt="PyPI Monthly Downloads">
+</a>
+
+</p>
+
+<p align="center">
+
+<b>Python Library for Indian Stock Market Analysis</b> 📈
+
+<br><br>
+
+<i style="color: #888888">Streamlined access to comprehensive Indian stock market data from <a href="https://www.tickertape.in">Tickertape IN</a>, enabling powerful financial analysis, automated screening, and market sentiment tracking.</i>
+
+</p>
 
 !!! important "Important Notice"
     - This library heavily relies on the (unofficial) public APIs from Tickertape IN.
     - I am not affiliated with Tickertape.in in any way.
     - Tickertape had been my go to for stock analysis tool for like forever!
-    - and I am greatful to then and a big fan of the work they do!
+    - and I am greatful to them for the work they do!
 
 !!! warning "Disclaimer"
     - All data are for **informational purposes only** and should not be considered as financial advice.
     - Always consult qualified financial advisors before making investment decisions.
     - I am not an expert in finance.
-    - I am not responsible for how one uses this library, or the consequences, or financial outcomes of using it.
+    - I am not responsible for how one uses this library, the consequences, or financial outcomes of using it.
 
 ## ✨ Key Features
 
@@ -64,7 +116,7 @@ all_stocks = assets.get_all_stocks()
 print(f"Total stocks available: {len(all_stocks)}")
 ```
 
-**👉 [Complete Quick Start Guide](quickstart.md)** - Learn with real examples!
+**👉 [Complete Quick Start Guide](./quickstart.md)** - Learn with real examples!
 
 ## 📦 Core Modules
 
@@ -74,7 +126,7 @@ print(f"Total stocks available: {len(all_stocks)}")
 | **📊 Stock Scorecard** | 6-category stock analysis | Investment screening, due diligence |
 | **📈 Market Mood Index** | Sentiment tracking (0-100 scale) | Market timing, contrarian investing |
 
-**👉 See detailed documentation:** | [MMI](tickersnap/mmi/index.md) | [Assets](tickersnap/lists/index.md) | [Stocks](tickersnap/stock/index.md) |
+**👉 See detailed documentation:** | [MMI](./tickersnap/mmi/index.md) | [Assets](./tickersnap/lists/index.md) | [Stocks](./tickersnap/stock/index.md) |
 
 ## 💡 What You Can Build
 
@@ -83,18 +135,19 @@ print(f"Total stocks available: {len(all_stocks)}")
 - **🎯 Market Alerts** - Get notified of sentiment extremes
 - **🔍 Research Tools** - Comprehensive market analysis
 - **🤖 Trading Bots** - Automated analysis and signals
+- **🧠 LLM Agents** - Build agents to get live financial data
 
 **👉 Every module is filled with usage examples throughout the documentation!**
 
-## 📚 Documentation Structure
+## 📚 Quick Links
 
-- **[Quick Start Guide](quickstart.md)** - Get started in minutes
-- **[Installation Guide](setup/installation.md)** - Detailed setup instructions
-- **[Development Guide](setup/development.md)** - Contributing and development setup
+- **[Quick Start Guide](./quickstart.md)** - Get started in minutes
+- **[Installation Guide](./setup/installation.md)** - Detailed setup instructions
+- **[Development Guide](./setup/development.md)** - Contributing and development setup
 - **Module Documentation:**
-    - **[Market Mood Index (MMI)](tickersnap/mmi/index.md)** - Market sentiment tracking
-    - **[Assets Lists](tickersnap/lists/index.md)** - Stock and ETF data access
-    - **[Stock Scorecard](tickersnap/stock/index.md)** - Comprehensive stock analysis
+    - **[Market Mood Index (MMI)](./tickersnap/mmi/index.md)** - Market sentiment tracking
+    - **[Assets Lists](./tickersnap/lists/index.md)** - Stock and ETF data access
+    - **[Stock Scorecard](./tickersnap/stock/index.md)** - Comprehensive stock analysis
 
 ## 📄 License
 

mkdocs.yml

@@ -1,7 +1,22 @@
-# mkdocs.yml
 site_name: Tickersnap
 site_url: https://mratanusarkar.github.io/tickersnap
+site_author: Atanu Sarkar
+site_description: Streamlined access to Indian stock market data for financial analysis, automated screening, and sentiment tracking.
+repo_name: tickersnap
 repo_url: https://github.com/mratanusarkar/tickersnap
+edit_uri: https://github.com/mratanusarkar/tickersnap/tree/main/docs
+copyright: Copyright © 2025 Atanu Sarkar
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/mratanusarkar
+    - icon: fontawesome/brands/linkedin
+      link: https://www.linkedin.com/in/mratanusarkar
+    - icon: fontawesome/brands/x-twitter
+      link: https://twitter.com/mratanusarkar
+    - icon: fontawesome/solid/envelope
+      link: mailto:mratanusarkar@gmail.com
 
 theme:
   name: material
@@ -36,7 +51,7 @@ plugins:
             # show the root heading (module/class name)
             show_root_heading: true
             # show the source code
-            show_source: true
+            show_source: false
             # docstring style to parse
             docstring_style: google
             # order of members (by source order)
@@ -99,4 +114,4 @@ nav:
       - Introduction: 'tickersnap/stock/index.md'
       - Scorecard: 'tickersnap/stock/scorecard.md'
       - Tickertape API: 'tickersnap/stock/api.md'
-      - Models: 'tickersnap/stock/models.md'
+      - Models: 'tickersnap/stock/models.md'

pyproject.toml

@@ -1,9 +1,37 @@
+[build-system]
+requires = ["setuptools>=80.9.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
 [project]
 name = "tickersnap"
 version = "0.0.3"
 description = "Tickersnap is a tool for getting snapshots of stock data from www.tickertape.in"
 readme = "README.md"
 requires-python = ">=3.10"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [
+    {name = "Atanu Sarkar", email = "mratanusarkar@gmail.com"}
+]
+maintainers = [
+    {name = "Atanu Sarkar", email = "mratanusarkar@gmail.com"}
+]
+keywords = ["finance", "stock", "market", "data", "financial", "analysis", "automation", "sentiment", "screening", "tickertape"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: End Users/Desktop",
+    "Intended Audience :: Financial and Insurance Industry",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Office/Business :: Financial",
+    "Topic :: Office/Business :: Financial :: Investment",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
 dependencies = [
     "pydantic>=2.0.0",
     "httpx>=0.25.0",
@@ -30,8 +58,19 @@ docs = [
     "jupyter>=1.1.1",
 ]
 
-[tool.setuptools]
-py-modules = ["tickersnap"]
+[project.urls]
+Homepage = "https://github.com/mratanusarkar/tickersnap"
+Documentation = "https://mratanusarkar.github.io/tickersnap"
+Repository = "https://github.com/mratanusarkar/tickersnap"
+"Bug Tracker" = "https://github.com/mratanusarkar/tickersnap/issues"
+Changelog = "https://github.com/mratanusarkar/tickersnap/releases"
+
+[tool.setuptools.packages.find]
+include = ["tickersnap*"]
+exclude = ["tests*", "docs*", "site*", "data*", "input*", "output*", "artifacts*", "*.egg-info*"]
+
+[tool.setuptools.package-data]
+tickersnap = ["py.typed"]
 
 [tool.pytest.ini_options]
 pythonpath = "."

tickersnap/__init__.py

@@ -0,0 +1,21 @@
+"""
+Tickersnap - Stock data snapshots from Tickertape IN
+
+A Python library for accessing Indian stock market data including:
+
+- Market Mood Index (MMI) data
+- List of all stocks and ETFs
+- Stock scorecard analysis data
+"""
+
+__version__ = "0.0.3"
+
+# import submodules for easy access without unpacking classes
+from . import lists, mmi, stock
+
+__all__ = [
+    "__version__",
+    "mmi",
+    "lists",
+    "stock",
+]