Metadata-Version: 2.4
Name: necta-fetcher
Version: 0.4.0
Summary: A Python client to fetch NECTA (National Examinations Council of Tanzania) results with names.
Home-page: https://boyoftime.github.io/necta-fetcher
Author: Someless
Author-email: adosomeless@gmail.com
License: MIT
Project-URL: Bug Tracker, https://boyoftime.github.io/necta-fetcher
Keywords: necta results tanzania education examination fetcher scraper api client
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: requests>=2.20.0
Requires-Dist: beautifulsoup4>=4.9.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Necta-Fetcher: Python Client for NECTA Student Results

**Version: 0.4.0** | **Developer: Someless Ado**

`necta-fetcher` is a Python client library designed by someless for developers seeking to programmatically access student examination results from the National Examinations Council of Tanzania (NECTA) online portal. This library streamlines the typically complex process of web interaction by managing authentication, session persistence, CSRF token handling, and direct API communication to retrieve detailed student performance data.

<br>

## Core Philosophy & Design

The primary goal of `necta-fetcher` is to provide a clean, intuitive, and robust interface for developers. By abstracting the underlying web scraping mechanics, you can focus on integrating NECTA results into your applications, data analysis workflows, or educational tools without getting bogged down in the intricacies of web automation.

<br>

## Important Considerations & Disclaimers

Before integrating `necta-fetcher` into your projects, please carefully review the following:

*   **Dynamic Web Environment:** This library interacts with an external web portal by simulating browser behavior. The structure, API endpoints, or security mechanisms of this portal can be modified by its administrators at any time and without prior notice. Such external changes may impact the functionality of `necta-fetcher`, potentially requiring updates to the library to restore compatibility.
*   **Adherence to Terms of Service:** As a user of this library, you are solely responsible for understanding and adhering to all Terms of Service, usage policies, and data access regulations stipulated by the official NECTA portal.
*   **Responsible Usage Protocol:** This library facilitates interaction with a live, operational web service. It is crucial to employ `necta-fetcher` responsibly to prevent imposing an undue or disruptive load on the NECTA portal's infrastructure. Implement rate limiting or considerate request scheduling in your applications, especially for batch operations.
*   **Authentication Mechanism (Version 0.4.0):** Please be aware that the initial version (0.4.0) of this package utilizes an internally pre-configured set of authentication credentials for accessing the NECTA portal. This approach was adopted for initial development and demonstration purposes. **For any production, enterprise, or sensitive data applications, it is imperative to use a version of this library that explicitly supports secure, user-provided credential input mechanisms.** Future iterations of `necta-fetcher` aim to address this with more flexible and secure authentication options.

<br>

## Key Features at a Glance

*   **Automated Portal Authentication:** Handles the multi-step login process to the NECTA portal seamlessly.
*   **Targeted Student Result Retrieval:** Fetches detailed examination results for individual students based on their unique full index number, examination year, and specific examination level.
*   **Intelligent Session & Token Management:** Manages HTTP sessions for cookie persistence and automatically handles the acquisition and usage of CSRF (Cross-Site Request Forgery) tokens required for secure interactions.
*   **Robust Error Handling:** Implements a hierarchy of custom exceptions for precise and informative error reporting, enabling developers to build resilient applications.
*   **Developer-Friendly Interface:** Offers a clean and Pythonic API centered around the `NectaClient` class.

<br>

## Installation Guide

Integrating `necta-fetcher` into your Python projects is managed via `pip`, the standard Python package installer.

### Standard Installation (from PyPI)

Once `necta-fetcher` is officially published on the Python Package Index (PyPI), this will be the recommended method for installation:

```bash
pip install necta-fetcher
