wiba 0.1.0__tar.gz

wiba-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Arman Akbarian
+
+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. 

wiba-0.1.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include LICENSE
+include README.md
+include wiba/py.typed 

wiba-0.1.0/PKG-INFO

@@ -0,0 +1,157 @@
+Metadata-Version: 2.2
+Name: wiba
+Version: 0.1.0
+Summary: WIBA: What Is Being Argued? A Comprehensive Approach to Argument Mining
+Home-page: https://github.com/Armaniii/WIBA
+Author: Arman Irani
+Author-email: airan002@ucr.edu
+Project-URL: Bug Tracker, https://github.com/Armaniii/WIBA/issues
+Project-URL: Documentation, https://wiba.dev
+Project-URL: Source Code, https://github.com/Armaniii/WIBA
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Text Processing :: Linguistic
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.0
+Requires-Dist: pandas>=1.2.0
+Requires-Dist: numpy>=1.19.0
+Requires-Dist: tqdm>=4.50.0
+Requires-Dist: structlog>=21.1.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# WIBA: What Is Being Argued?
+
+WIBA is a comprehensive argument mining toolkit that helps you detect, analyze, and understand arguments in text. It provides a simple yet powerful interface to identify argumentative content, extract topics, analyze stance, and discover arguments in longer texts.
+
+## Installation
+
+```bash
+pip install wiba
+```
+
+## Quick Start
+
+```python
+from wiba import WIBA
+
+# Initialize with your API token
+analyzer = WIBA(api_token="your_api_token_here")
+
+# Example text
+text = "Climate change is real because global temperatures are rising."
+
+# Detect if it's an argument
+result = analyzer.detect(text)
+print(f"Argument detected: {result.argument_prediction}")
+print(f"Confidence: {result.confidence_score}")
+```
+
+## Features
+
+- **Argument Detection**: Identify whether a text contains an argument
+- **Topic Extraction**: Extract the main topic being argued about
+- **Stance Analysis**: Determine the stance towards a specific topic
+- **Argument Discovery**: Find argumentative segments in longer texts
+- **Batch Processing**: Efficiently process multiple texts
+- **DataFrame Support**: Native pandas DataFrame integration
+
+## Documentation
+
+For detailed documentation and examples, visit [wiba.dev](https://wiba.dev).
+
+## Getting Started
+
+1. Create an account at [wiba.dev](https://wiba.dev) to get your API token
+2. Install the package: `pip install wiba`
+3. Initialize the client with your token
+4. Start analyzing arguments!
+
+## Example Usage
+
+### Detect Arguments
+
+```python
+# Single text
+result = analyzer.detect("Climate change is real because temperatures are rising.")
+print(result.argument_prediction)  # "Argument" or "NoArgument"
+print(result.confidence_score)     # Confidence score between 0 and 1
+
+# Multiple texts
+texts = [
+    "Climate change is real because temperatures are rising.",
+    "This is just a simple statement without any argument."
+]
+results = analyzer.detect(texts)
+for r in results:
+    print(f"Text: {r.text}")
+    print(f"Prediction: {r.argument_prediction}")
+```
+
+### Extract Topics
+
+```python
+result = analyzer.extract("Climate change is a serious issue because it affects our environment.")
+print(result.topics)  # List of extracted topics
+```
+
+### Analyze Stance
+
+```python
+text = "We must take action on climate change because the evidence is overwhelming."
+topic = "climate change"
+result = analyzer.stance(text, topic)
+print(f"Stance: {result.stance}")  # "Favor", "Against", or "NoArgument"
+```
+
+### Discover Arguments
+
+```python
+text = """Climate change is a serious issue. Global temperatures are rising at an 
+unprecedented rate. This is causing extreme weather events. However, some argue 
+that natural climate cycles are responsible."""
+
+results_df = analyzer.discover_arguments(
+    text,
+    window_size=2,  # Number of sentences per window
+    step_size=1     # Number of sentences to move window
+)
+print(results_df[['text_segment', 'argument_prediction', 'argument_confidence']])
+```
+
+## Citation
+
+If you use WIBA in your research, please cite:
+
+```bibtex
+@misc{irani2024wibaarguedcomprehensiveapproach,
+      title={WIBA: What Is Being Argued? A Comprehensive Approach to Argument Mining}, 
+      author={Arman Irani and Ju Yeon Park and Kevin Esterling and Michalis Faloutsos},
+      year={2024},
+      eprint={2405.00828},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL},
+      url={https://arxiv.org/abs/2405.00828}, 
+}
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. 

wiba-0.1.0/README.md

@@ -0,0 +1,118 @@
+# WIBA: What Is Being Argued?
+
+WIBA is a comprehensive argument mining toolkit that helps you detect, analyze, and understand arguments in text. It provides a simple yet powerful interface to identify argumentative content, extract topics, analyze stance, and discover arguments in longer texts.
+
+## Installation
+
+```bash
+pip install wiba
+```
+
+## Quick Start
+
+```python
+from wiba import WIBA
+
+# Initialize with your API token
+analyzer = WIBA(api_token="your_api_token_here")
+
+# Example text
+text = "Climate change is real because global temperatures are rising."
+
+# Detect if it's an argument
+result = analyzer.detect(text)
+print(f"Argument detected: {result.argument_prediction}")
+print(f"Confidence: {result.confidence_score}")
+```
+
+## Features
+
+- **Argument Detection**: Identify whether a text contains an argument
+- **Topic Extraction**: Extract the main topic being argued about
+- **Stance Analysis**: Determine the stance towards a specific topic
+- **Argument Discovery**: Find argumentative segments in longer texts
+- **Batch Processing**: Efficiently process multiple texts
+- **DataFrame Support**: Native pandas DataFrame integration
+
+## Documentation
+
+For detailed documentation and examples, visit [wiba.dev](https://wiba.dev).
+
+## Getting Started
+
+1. Create an account at [wiba.dev](https://wiba.dev) to get your API token
+2. Install the package: `pip install wiba`
+3. Initialize the client with your token
+4. Start analyzing arguments!
+
+## Example Usage
+
+### Detect Arguments
+
+```python
+# Single text
+result = analyzer.detect("Climate change is real because temperatures are rising.")
+print(result.argument_prediction)  # "Argument" or "NoArgument"
+print(result.confidence_score)     # Confidence score between 0 and 1
+
+# Multiple texts
+texts = [
+    "Climate change is real because temperatures are rising.",
+    "This is just a simple statement without any argument."
+]
+results = analyzer.detect(texts)
+for r in results:
+    print(f"Text: {r.text}")
+    print(f"Prediction: {r.argument_prediction}")
+```
+
+### Extract Topics
+
+```python
+result = analyzer.extract("Climate change is a serious issue because it affects our environment.")
+print(result.topics)  # List of extracted topics
+```
+
+### Analyze Stance
+
+```python
+text = "We must take action on climate change because the evidence is overwhelming."
+topic = "climate change"
+result = analyzer.stance(text, topic)
+print(f"Stance: {result.stance}")  # "Favor", "Against", or "NoArgument"
+```
+
+### Discover Arguments
+
+```python
+text = """Climate change is a serious issue. Global temperatures are rising at an 
+unprecedented rate. This is causing extreme weather events. However, some argue 
+that natural climate cycles are responsible."""
+
+results_df = analyzer.discover_arguments(
+    text,
+    window_size=2,  # Number of sentences per window
+    step_size=1     # Number of sentences to move window
+)
+print(results_df[['text_segment', 'argument_prediction', 'argument_confidence']])
+```
+
+## Citation
+
+If you use WIBA in your research, please cite:
+
+```bibtex
+@misc{irani2024wibaarguedcomprehensiveapproach,
+      title={WIBA: What Is Being Argued? A Comprehensive Approach to Argument Mining}, 
+      author={Arman Irani and Ju Yeon Park and Kevin Esterling and Michalis Faloutsos},
+      year={2024},
+      eprint={2405.00828},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL},
+      url={https://arxiv.org/abs/2405.00828}, 
+}
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. 

wiba-0.1.0/pyproject.toml

@@ -0,0 +1,6 @@
+[build-system]
+requires = ["setuptools>=45", "wheel", "setuptools_scm>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+write_to = "wiba/_version.py" 

wiba-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

wiba-0.1.0/setup.py

@@ -0,0 +1,41 @@
+from setuptools import setup, find_packages
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setup(
+    name="wiba",
+    version="0.1.0",
+    author="Arman Irani",
+    author_email="airan002@ucr.edu",
+    description="WIBA: What Is Being Argued? A Comprehensive Approach to Argument Mining",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/Armaniii/WIBA",
+    packages=find_packages(),
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Intended Audience :: Science/Research",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Topic :: Scientific/Engineering :: Artificial Intelligence",
+        "Topic :: Text Processing :: Linguistic",
+    ],
+    python_requires=">=3.8",
+    install_requires=[
+        "requests>=2.25.0",
+        "pandas>=1.2.0",
+        "numpy>=1.19.0",
+        "tqdm>=4.50.0",
+        "structlog>=21.1.0",
+    ],
+    project_urls={
+        "Bug Tracker": "https://github.com/Armaniii/WIBA/issues",
+        "Documentation": "https://wiba.dev",
+        "Source Code": "https://github.com/Armaniii/WIBA",
+    },
+)