Metadata-Version: 2.4
Name: adipylib
Version: 0.1.5
Summary: A Python Study Toolkit for NLP and more.
Author-email: Aditya Rana <adityarana2610@gmail.com>
Project-URL: Homepage, https://github.com/adityarana2610/adipylib
Project-URL: Bug Tracker, https://github.com/adityarana2610/adipylib/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Text Processing
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: nltk
Requires-Dist: scikit-learn
Dynamic: license-file

# adipylib

[![PyPI version](https://badge.fury.io/py/adipylib.svg)](https://badge.fury.io/py/adipylib)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A simple Python Study Toolkit for students, featuring NLP tools for text summarization and keyword extraction.

## Features

* **Extractive Text Summarization:** Quickly shorten long articles or study notes into a few key sentences.
* **Keyword Extraction:** Pulls out the most important keywords from any block of text using TF-IDF.
* **Lightweight & simple:** Easy to install and use with no complex setup.

## Installation

You can install `adipylib` directly from PyPI:

```bash
pip install adipylib
```

## Usage

```python
import adipylib

my_text = """
Python is a high-level, interpreted programming language. 
Its design philosophy emphasizes code readability with the 
use of significant indentation. Python is dynamically-typed 
and garbage-collected. It supports multiple programming 
paradigms, including structured, object-oriented, 
and functional programming.
"""

# 1. Get Keywords
keywords = adipylib.extract_keywords(my_text)
print(f"Keywords: {keywords}")

# 2. Get a Summary
summary = adipylib.extractive_summary(my_text, num_sentences=2)
print(f"Summary: {summary}")
```

## Bugs Reporting and Contributions

Found a bug or have a feature request? Feel free to check the [issues page](https://github.com/adityarana2610/adipylib/issues). Any contributions are welcome!
