Metadata-Version: 2.1
Name: competex
Version: 0.5
Author-email: Sike Brothers <sikebros@gmail.com>
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown
License-File: LICENSE

# CompeteX Library
CompeteX is a Python library designed for analyzing competitors using data from social media platforms. It provides a set of tools and functionalities to gather, process, and analyze social media data to gain insights into competitors' activities, audience engagement, content performance, and more.

## Installation
You can install CompeteX using pip:
```bash
pip install competex
```

## Getting Started
To start using CompeteX, import it into your Python environment:
```python
import competeX as cx
```
## Features
- **Data Gathering**: CompeteX facilitates the collection of social media data from platforms such as Twitter, Facebook, Instagram, and LinkedIn.
- **Data Processing**: CompeteX offers tools for processing and cleaning social media data to prepare it for analysis.
-  **Competitor Analysis**: CompeteX provides algorithms and metrics for analyzing competitors' social media performance, audience demographics, sentiment analysis, and more.
-  **Visualization**: CompeteX includes functions for visualizing social media data and analysis results.

## Examples
Here's a simple example of using CompeteX to gather Twitter data and perform sentiment analysis:
```python
import competeX as cx

#Gather Twitter Data
twitter_data = cx.gather_twitter_data(username='competitor_handle', since='2024-01-01', until='2024-03-01')

#Gather Threads Data
threads_data = cx.gather_threads_data(username='competitor_handle', since='2024-01-01', until='2024-03-01')

#Perform sentiment analysis
sentiment_analysis = cx.sentiment_analysis(twitter_data, threads_data)

print(sentiment_analysis)
```

## Contributing
If you'd like to contribute to CompeteX, please refer to the [contributing guidelines](contributingguidelines).

## License
CompeteX is distributed under the MIT License. See the [license](license) file for more information.
