first commit

makowskid · makowskid · commit fcfe4845a63f · 2024-10-07T14:55:04.000+07:00
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,11 @@
+uMIT License
+
+Copyright (c) 2024 SharpAPI
+
+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.
+
diff --git a/README.md b/README.md
@@ -0,0 +1,81 @@
+# SharpAPI Python Client SDK
+
+🚀 Automate workflows with AI-powered API
+
+## Leverage AI API to streamline workflows in E-Commerce, Marketing, Content Management, HR Tech, Travel, and more.
+
+[![Version](https://img.shields.io/pypi/v/sharpapi-python-client.svg)](https://pypi.org/project/sharpapi-python-client/)
+[![License](https://img.shields.io/pypi/l/sharpapi-python-client.svg)](https://github.com/yourusername/sharpapi-python-client/blob/main/LICENSE)
+
+#### Save time on repetitive content analysis and generation tasks that your app users perform daily.
+
+See more at [SharpAPI.com Website »](https://sharpapi.com/)
+
+## Requirements
+
+- Python >= 3.6
+
+
+## Installation
+
+```bash
+pip install sharpapi-python-client
+
+
+## What can it do for you?
+
+- **E-commerce**
+  - Generate engaging product introductions.
+  - Create personalized thank-you emails.
+  - Streamline product categorization.
+  - Perform sentiment analysis on product reviews.
+
+- **Content & Marketing Automation**
+  - Translate text for a global audience.
+  - Paraphrase and proofread any text.
+  - Detect spam content.
+  - Extract contact information.
+  - Summarize content and generate keywords/tags.
+  - Generate SEO meta tags.
+
+- **HR Tech**
+  - Generate job descriptions.
+  - Identify related job positions and skills.
+  - Parse and extract information from resumes.
+
+- **Travel, Tourism & Hospitality**
+  - Analyze sentiment in travel reviews.
+  - Categorize tours, activities, and hospitality products.
+
+## Usage
+
+### Simple Example
+
+```python
+from sharpapi.sharp_api_service import SharpApiService
+
+sharp_api = SharpApiService('YOUR_SHARP_API_KEY')
+
+try:
+    status_url = sharp_api.product_categories(
+        'Lenovo Chromebook Laptop (2023), 14" FHD Touchscreen Slim 3, 8-Core MediaTek Kompanio 520 CPU, 4GB RAM, 128GB Storage',
+        language='German',  # optional
+        max_quantity=400,  # optional
+        voice_tone='Neutral',  # optional
+        context='Optional current e-store categories'  # optional
+    )
+
+    result_sharp_api_job = sharp_api.fetch_results(status_url)
+    print(result_sharp_api_job.get_result_json())
+except Exception as e:
+    print(e)
+```
+
+## Documentation
+For detailed usage and API methods, please refer to the [SharpAPI Documentation](https://sharpapi.com/documentation).
+
+## Changelog
+Please see CHANGELOG for more information on what has changed recently.
+
+## License
+The MIT License (MIT). Please see License File for more information.
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1 @@
+requests>=2.25.1
diff --git a/setup.py b/setup.py
@@ -0,0 +1,19 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='sharpapi-python-client',
+    version='1.2.0',
+    description='SharpAPI.com Python SDK Client - AI-Powered Workflow Automation API.',
+    author='Dawid Makowski',
+    author_email='contact@sharpapi.com',
+    url='https://github.com/sharpapi/sharpapi-python-client',
+    packages=find_packages(),
+    install_requires=[
+        'requests>=2.25.1',
+    ],
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: MIT License',
+    ],
+)
+
diff --git a/sharpapi/__init__.py b/sharpapi/__init__.py
@@ -0,0 +1,13 @@
+# sharpapi/__init__.py
+
+"""
+SharpAPI Python SDK Package Initialization
+"""
+
+# Import the main service class for easy access
+from .sharp_api_service import SharpApiService
+
+# Import subpackages
+from . import dto
+from . import enums
+
diff --git a/sharpapi/dto/__init__.py b/sharpapi/dto/__init__.py
@@ -0,0 +1,10 @@
+# sharpapi/dto/__init__.py
+
+"""
+Data Transfer Objects (DTO) Package Initialization
+"""
+
+# Import DTO classes for easy access
+from .job_description_parameters import JobDescriptionParameters
+from .sharp_api_job import SharpApiJob
+from .sharp_api_subscription_info import SharpApiSubscriptionInfo
diff --git a/sharpapi/dto/job_description_parameters.py b/sharpapi/dto/job_description_parameters.py
@@ -0,0 +1,48 @@
+class JobDescriptionParameters:
+    def __init__(
+        self,
+        name,
+        company_name=None,
+        minimum_work_experience=None,
+        minimum_education=None,
+        employment_type=None,
+        required_skills=None,
+        optional_skills=None,
+        country=None,
+        remote=None,
+        visa_sponsored=None,
+        voice_tone=None,
+        context=None,
+        language=None,
+    ):
+        self.name = name
+        self.company_name = company_name
+        self.minimum_work_experience = minimum_work_experience
+        self.minimum_education = minimum_education
+        self.employment_type = employment_type
+        self.required_skills = required_skills
+        self.optional_skills = optional_skills
+        self.country = country
+        self.remote = remote
+        self.visa_sponsored = visa_sponsored
+        self.voice_tone = voice_tone
+        self.context = context
+        self.language = language
+
+    def to_dict(self):
+        return {
+            'name': self.name,
+            'company_name': self.company_name,
+            'minimum_work_experience': self.minimum_work_experience,
+            'minimum_education': self.minimum_education,
+            'employment_type': self.employment_type,
+            'required_skills': self.required_skills,
+            'optional_skills': self.optional_skills,
+            'country': self.country,
+            'remote': self.remote,
+            'visa_sponsored': self.visa_sponsored,
+            'voice_tone': self.voice_tone,
+            'context': self.context,
+            'language': self.language,
+        }
+
diff --git a/sharpapi/dto/sharp_api_job.py b/sharpapi/dto/sharp_api_job.py
@@ -0,0 +1,27 @@
+from ..enums.sharp_api_job_status_enum import SharpApiJobStatusEnum
+from ..enums.sharp_api_job_type_enum import SharpApiJobTypeEnum
+import json
+
+
+class SharpApiJob:
+    def __init__(self, id, type, status, result):
+        self.id = id
+        self.type = type
+        self.status = status
+        self.result = result
+
+    def get_id(self):
+        return self.id
+
+    def get_type(self):
+        return self.type
+
+    def get_status(self):
+        return self.status
+
+    def get_result_json(self):
+        return json.dumps(self.result, indent=2) if self.result else None
+
+    def get_result_object(self):
+        return self.result
+
diff --git a/sharpapi/dto/sharp_api_subscription_info.py b/sharpapi/dto/sharp_api_subscription_info.py
@@ -0,0 +1,15 @@
+from datetime import datetime
+
+
+class SharpApiSubscriptionInfo:
+    def __init__(self, data):
+        self.timestamp = datetime.fromisoformat(data['timestamp'])
+        self.on_trial = data['on_trial']
+        self.trial_ends = datetime.fromisoformat(data['trial_ends'])
+        self.subscribed = data['subscribed']
+        self.current_subscription_start = datetime.fromisoformat(data['current_subscription_start'])
+        self.current_subscription_end = datetime.fromisoformat(data['current_subscription_end'])
+        self.subscription_words_quota = data['subscription_words_quota']
+        self.subscription_words_used = data['subscription_words_used']
+        self.subscription_words_used_percentage = data['subscription_words_used_percentage']
+
diff --git a/sharpapi/enums/__init__.py b/sharpapi/enums/__init__.py
@@ -0,0 +1,10 @@
+# sharpapi/enums/__init__.py
+
+"""
+Enumerations Package Initialization
+"""
+from .sharp_api_job_status_enum import SharpApiJobStatusEnum
+from .sharp_api_job_type_enum import SharpApiJobTypeEnum
+from .sharp_api_languages import SharpApiLanguages
+from .sharp_api_voice_tone import SharpApiVoiceTone
+
diff --git a/sharpapi/enums/sharp_api_job_status_enum.py b/sharpapi/enums/sharp_api_job_status_enum.py
@@ -0,0 +1,9 @@
+from enum import Enum
+
+
+class SharpApiJobStatusEnum(Enum):
+    NEW = 'new'
+    PENDING = 'pending'
+    FAILED = 'failed'
+    SUCCESS = 'success'
+
diff --git a/sharpapi/enums/sharp_api_job_type_enum.py b/sharpapi/enums/sharp_api_job_type_enum.py
@@ -0,0 +1,82 @@
+class SharpApiJobTypeEnum:
+    ECOMMERCE_REVIEW_SENTIMENT = {
+        'value': 'ecommerce_review_sentiment',
+        'url': '/ecommerce/review_sentiment',
+    }
+    ECOMMERCE_PRODUCT_CATEGORIES = {
+        'value': 'ecommerce_product_categories',
+        'url': '/ecommerce/product_categories',
+    }
+    ECOMMERCE_PRODUCT_INTRO = {
+        'value': 'ecommerce_product_intro',
+        'url': '/ecommerce/product_intro',
+    }
+    ECOMMERCE_THANK_YOU_EMAIL = {
+        'value': 'ecommerce_thank_you_email',
+        'url': '/ecommerce/thank_you_email',
+    }
+    HR_PARSE_RESUME = {
+        'value': 'hr_parse_resume',
+        'url': '/hr/parse_resume',
+    }
+    HR_JOB_DESCRIPTION = {
+        'value': 'hr_job_description',
+        'url': '/hr/job_description',
+    }
+    HR_RELATED_SKILLS = {
+        'value': 'hr_related_skills',
+        'url': '/hr/related_skills',
+    }
+    HR_RELATED_JOB_POSITIONS = {
+        'value': 'hr_related_job_positions',
+        'url': '/hr/related_job_positions',
+    }
+    TTH_REVIEW_SENTIMENT = {
+        'value': 'tth_review_sentiment',
+        'url': '/tth/review_sentiment',
+    }
+    TTH_TA_PRODUCT_CATEGORIES = {
+        'value': 'tth_ta_product_categories',
+        'url': '/tth/ta_product_categories',
+    }
+    TTH_HOSPITALITY_PRODUCT_CATEGORIES = {
+        'value': 'tth_hospitality_product_categories',
+        'url': '/tth/hospitality_product_categories',
+    }
+    CONTENT_DETECT_PHONES = {
+        'value': 'content_detect_phones',
+        'url': '/content/detect_phones',
+    }
+    CONTENT_DETECT_EMAILS = {
+        'value': 'content_detect_emails',
+        'url': '/content/detect_emails',
+    }
+    CONTENT_DETECT_SPAM = {
+        'value': 'content_detect_spam',
+        'url': '/content/detect_spam',
+    }
+    CONTENT_SUMMARIZE = {
+        'value': 'content_summarize',
+        'url': '/content/summarize',
+    }
+    CONTENT_KEYWORDS = {
+        'value': 'content_keywords',
+        'url': '/content/keywords',
+    }
+    CONTENT_TRANSLATE = {
+        'value': 'content_translate',
+        'url': '/content/translate',
+    }
+    CONTENT_PARAPHRASE = {
+        'value': 'content_paraphrase',
+        'url': '/content/paraphrase',
+    }
+    CONTENT_PROOFREAD = {
+        'value': 'content_proofread',
+        'url': '/content/proofread',
+    }
+    SEO_GENERATE_TAGS = {
+        'value': 'seo_generate_tags',
+        'url': '/seo/generate_tags',
+    }
+
diff --git a/sharpapi/enums/sharp_api_languages.py b/sharpapi/enums/sharp_api_languages.py
diff --git a/sharpapi/enums/sharp_api_voice_tone.py b/sharpapi/enums/sharp_api_voice_tone.py
diff --git a/sharpapi/sharp_api_service.py b/sharpapi/sharp_api_service.py
diff --git a/tests/test_sharp_api_service.py b/tests/test_sharp_api_service.py
