mospi-unitdata 0.1.0__tar.gz

mospi_unitdata-0.1.0/.gitignore

@@ -0,0 +1,30 @@
+# Python
+__pycache__/
+*.pyc
+*.pyo
+*.egg-info/
+*.egg
+.eggs/
+dist/
+build/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db

mospi_unitdata-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026, Ministry of Statistics and Programme Implementation, Government of India
+
+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.

mospi_unitdata-0.1.0/MospiUnitdata/MospiUnitdata.py

@@ -0,0 +1,112 @@
+import requests
+import os
+from typing import List, Dict, Any
+
+
+def listDatasets(pageNo=1) -> List[Dict[str, Any]]:
+  
+    try:
+  
+     response = requests.get("https://microdata.gov.in/NADA/index.php/api/listdatasets?page="+str(pageNo),headers=None)
+
+     data = response.json()
+
+     return data
+    
+    except Exception as e: 
+      print('Error while downloading the data:',e)
+       
+     
+    return None 
+
+
+def getDatasets(folderPath, apiKey):
+
+    page = 1
+    errorFlag = False
+
+    while True:
+
+        data = listDatasets(page)
+
+        if data is None:
+            print('Error occurred while downloading the data!')
+            errorFlag = True
+            break
+
+        rows = data["result"]["rows"]
+
+        indexed_data = [
+            {**item, "index": i}
+            for i, item in enumerate(rows, start=1)
+        ]
+
+        for item in indexed_data:
+            print(item["id"] + ":" + item["title"])
+
+        total = int(data["result"]["total"])
+        limit = int(data["result"]["limit"])
+
+        pages = total // limit + (1 if total % limit else 0)
+
+        user_input = input(
+            f"Total pages:{pages}, Page:{page} of {pages},\n"
+            "Enter Survey index number (put n to Navigate to Next Page): "
+        )
+
+       
+        if user_input.strip().lower() == 'n':
+            page = page + 1           
+        
+            if page > pages:
+                print("No more Pages left to browse the data.")
+                break
+            else:
+                continue
+
+        else:
+            if errorFlag == False:
+              idno = None
+              if user_input.isdigit():
+
+                for item in indexed_data:
+                  if item["id"] == user_input:
+                    idno = item["idno"]
+
+                if idno is not None:
+
+                    url = "https://microdata.gov.in/NADA/index.php/api/datasets/" + idno + "/fileslist"
+
+                    headers = {
+                        "Host": "microdata.gov.in",
+                        "X-API-KEY": apiKey
+                    }
+
+                    response = requests.get(url, headers=headers)
+
+                    data = response.json()
+
+                    folder = folderPath
+
+                    for item1 in data["files"]:
+
+                        url = "https://microdata.gov.in/NADA/index.php/api/fileslist/download/" + idno + "/" + item1["base64"]
+
+                        response = requests.get(url, headers=headers)
+
+                        filename = os.path.join(folder, item1["name"])
+
+                        with open(filename, "wb") as f:
+                            f.write(response.content)
+                            print(filename + ":Downloaded successfully!")
+                    break
+                else:
+                    print('No such index Exists to download the Data. Kindly check and try again!')
+                    break
+        
+              else:
+               print("Invalid Index no.")
+               break
+      
+            else:
+             print('Error occurred while downloading the data!')

mospi_unitdata-0.1.0/MospiUnitdata/__init__.py

@@ -0,0 +1,3 @@
+# MospiUnitdata/__init__.py
+from .MospiUnitdata import getDatasets
+__all__ = ["getDatasets"]

mospi_unitdata-0.1.0/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: mospi-unitdata
+Version: 0.1.0
+Summary: Python client for downloading data from the MoSPI Microdata Portal (https://microdata.gov.in)
+Project-URL: Homepage, https://microdata.gov.in
+Project-URL: Repository, https://github.com/nso-india/mospi-unitdata
+Project-URL: Issues, https://github.com/nso-india/mospi-unitdata/issues
+Author: DIID, Ministry of Statistics and Programme Implementation, Neeraj Prakash, Satvik Bajpai, Sarthak Srivastava
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,data,government,india,microdata,mospi,nso,nsoindia,statistics
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.9
+Requires-Dist: requests>=2.31.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2.2; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# MoSPI Unit Data Client
+
+[![PyPI version](https://badge.fury.io/py/mospi-unitdata.svg)](https://badge.fury.io/py/mospi-unitdata)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A Python client for downloading microdata from the [MoSPI Microdata Portal](https://microdata.gov.in). 
+This package provides a convenient interface to browse and download datasets from the Government of India's National Statistical Office (NSO).
+
+### About
+This package is used to download the data from the MoSPI Microdata Portal. Specifically, you can browse available datasets interactively and download them by calling the provided methods with your API key.
+
+## Installation
+
+You can install the package directly from PyPI:
+
+```bash
+pip install mospi-unitdata
+```
+
+## Getting an API Key
+
+To use this package, you need an API key from the MoSPI Microdata Portal:
+
+1.  Visit the [MoSPI Microdata Portal](https://microdata.gov.in).
+2.  **Create an account** or sign in if you already have one.
+3.  **Verify your email** address (check your inbox for a confirmation link).
+4.  **Login** to your account.
+5.  Navigate to your **Profile** section.
+6.  Click on **Generate API Key** (or view your existing key).
+
+## Usage
+
+To download datasets, use the `getDatasets` method. This method takes two mandatory parameters:
+1.  **First parameter (`folderPath`)**: The location/folder on your computer where you want to save the downloaded data.
+2.  **Second parameter (`apiKey`)**: Your API key generated from the [MicroData Portal Profile Section](https://microdata.gov.in/NADA/index.php/auth/profile).
+
+```python
+from MospiUnitdata import getDatasets
+
+# Provide the save location and your API Key
+getDatasets("path/to/save/data", "YOUR_API_KEY")
+```
+
+The function provides an interactive prompt to browse through the available datasets:
+
+```text
+277:Annual Survey of Industries 2019-20
+275:Annual Survey of Industries 2020-21
+256:Annual Survey of Industries 2023-24
+...
+Total pages:13,Page:1 of 13,
+Enter Survey index number(put n to Navigate to Next Page): 
+```
+
+Type the numeric index to download the associated dataset, or `n` to view the next page.
+
+## Requirements
+- Python 3.9+
+- `requests` >= 2.31.0
+
+
+## License
+
+This project is licensed under the MIT License.
+

mospi_unitdata-0.1.0/README.md

@@ -0,0 +1,65 @@
+# MoSPI Unit Data Client
+
+[![PyPI version](https://badge.fury.io/py/mospi-unitdata.svg)](https://badge.fury.io/py/mospi-unitdata)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A Python client for downloading microdata from the [MoSPI Microdata Portal](https://microdata.gov.in). 
+This package provides a convenient interface to browse and download datasets from the Government of India's National Statistical Office (NSO).
+
+### About
+This package is used to download the data from the MoSPI Microdata Portal. Specifically, you can browse available datasets interactively and download them by calling the provided methods with your API key.
+
+## Installation
+
+You can install the package directly from PyPI:
+
+```bash
+pip install mospi-unitdata
+```
+
+## Getting an API Key
+
+To use this package, you need an API key from the MoSPI Microdata Portal:
+
+1.  Visit the [MoSPI Microdata Portal](https://microdata.gov.in).
+2.  **Create an account** or sign in if you already have one.
+3.  **Verify your email** address (check your inbox for a confirmation link).
+4.  **Login** to your account.
+5.  Navigate to your **Profile** section.
+6.  Click on **Generate API Key** (or view your existing key).
+
+## Usage
+
+To download datasets, use the `getDatasets` method. This method takes two mandatory parameters:
+1.  **First parameter (`folderPath`)**: The location/folder on your computer where you want to save the downloaded data.
+2.  **Second parameter (`apiKey`)**: Your API key generated from the [MicroData Portal Profile Section](https://microdata.gov.in/NADA/index.php/auth/profile).
+
+```python
+from MospiUnitdata import getDatasets
+
+# Provide the save location and your API Key
+getDatasets("path/to/save/data", "YOUR_API_KEY")
+```
+
+The function provides an interactive prompt to browse through the available datasets:
+
+```text
+277:Annual Survey of Industries 2019-20
+275:Annual Survey of Industries 2020-21
+256:Annual Survey of Industries 2023-24
+...
+Total pages:13,Page:1 of 13,
+Enter Survey index number(put n to Navigate to Next Page): 
+```
+
+Type the numeric index to download the associated dataset, or `n` to view the next page.
+
+## Requirements
+- Python 3.9+
+- `requests` >= 2.31.0
+
+
+## License
+
+This project is licensed under the MIT License.
+

mospi_unitdata-0.1.0/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "mospi-unitdata"
+version = "0.1.0"
+description = "Python client for downloading data from the MoSPI Microdata Portal (https://microdata.gov.in)"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.9"
+authors = [
+    { name = "DIID, Ministry of Statistics and Programme Implementation" },
+    { name = "Neeraj Prakash" },
+    { name = "Satvik Bajpai" },
+    { name = "Sarthak Srivastava" },
+]
+keywords = ["microdata", "mospi", "nso", "nsoindia", "india", "statistics", "government", "data", "api"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering",
+]
+dependencies = [
+    "requests>=2.31.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "build>=1.2.2",
+    "pytest>=7.0",
+    "pytest-asyncio>=0.21",
+]
+
+[project.urls]
+Homepage = "https://microdata.gov.in"
+Repository = "https://github.com/nso-india/mospi-unitdata"
+Issues = "https://github.com/nso-india/mospi-unitdata/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["MospiUnitdata"]
+
+[tool.hatch.build.targets.sdist]
+include = ["MospiUnitdata/**"]