Metadata-Version: 2.1
Name: Fictometer
Version: 0.2.2
Summary: Classifies text as 'Fiction' or 'Non-Fiction'.
Author-email: Kushal Shah <atmabodha@gmail.com>
Project-URL: Homepage, https://bekushal.medium.com/fictometer-a-simple-and-explainable-algorithm-for-sentiment-analysis-31186d2a8c7e
Keywords: Fictometer,Fiction,Non-Fiction
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: nltk >=3.8.1

# Fictometer

## Description

Fictometer is an algorithm for analysing whether the given text is ```Fiction``` or ```Non-Fiction```.
It first calculates the number of ```adverbs```, ```adjectives``` and ```pronouns``` in the text.
It then calculates Ratio of Adjective to Pronoun ```RADJPRON``` and Ratio of Adverb to Adjective ```RADVADJ```, 
from which it predicts whether text is ```Fiction``` or ```Non-Fiction```.

Blog Link: 🔗[LINK](https://bekushal.medium.com/fictometer-a-simple-and-explainable-algorithm-for-sentiment-analysis-31186d2a8c7e)


## Installation

```bash
pip install Fictometer
```


## Usage
```bash
import Fictometer

text = "your_text"

pc = Fictometer.counts(text)
// returs the count of ```adjectives```, ```adverbs``` and ```pronouns```

result = Fictometer.predict(text)
// Uses counts(), then calculates RADJPRON and RADVADJ, and returns a tuple having 'result' and 'confidence'.

Fictometer.help()
// Shows how to use the package
```


## Contact

email - atmabodha@gmail.com
