{"id":26229617,"url":"https://github.com/sharpapi/sharpapi-python-client","last_synced_at":"2026-02-06T07:03:20.224Z","repository":{"id":257813388,"uuid":"868747259","full_name":"sharpapi/sharpapi-python-client","owner":"sharpapi","description":"SharpAPI Python Client SDK","archived":false,"fork":false,"pushed_at":"2024-10-07T09:45:15.000Z","size":22,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-06-27T04:40:34.974Z","etag":null,"topics":["ai","content-automation","e-commerce","e-commerce-automation","hospitality-automation","hrtech-automation","python","sdk","sharpapi","travel-automation"],"latest_commit_sha":null,"homepage":"https://sharpapi.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sharpapi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-10-07T05:40:28.000Z","updated_at":"2025-03-26T05:31:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"066cce5b-f3e4-4792-a19a-4eb13e767aed","html_url":"https://github.com/sharpapi/sharpapi-python-client","commit_stats":null,"previous_names":["sharpapi/sharpapi-python-client"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/sharpapi/sharpapi-python-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sharpapi%2Fsharpapi-python-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sharpapi%2Fsharpapi-python-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sharpapi%2Fsharpapi-python-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sharpapi%2Fsharpapi-python-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sharpapi","download_url":"https://codeload.github.com/sharpapi/sharpapi-python-client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sharpapi%2Fsharpapi-python-client/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266885739,"owners_count":24000973,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-24T02:00:09.469Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","content-automation","e-commerce","e-commerce-automation","hospitality-automation","hrtech-automation","python","sdk","sharpapi","travel-automation"],"created_at":"2025-03-12T22:17:05.894Z","updated_at":"2026-02-06T07:03:15.165Z","avatar_url":"https://github.com/sharpapi.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![SharpAPI GitHub cover](https://sharpapi.com/sharpapi-github-php-bg.jpg)\n\n# SharpAPI Python Client SDK\n\n🚀 **Automate Workflows with AI-Powered API**\n\n## Leverage AI API to Streamline Workflows in E-Commerce, Marketing, Content Management, HR Tech, Travel, and More.\n\n[![PyPI Version](https://img.shields.io/pypi/v/sharpapi-python-client.svg)](https://pypi.org/project/sharpapi-python-client/)\n[![License](https://img.shields.io/pypi/l/sharpapi-python-client.svg)](https://github.com/sharpapi/sharpapi-python-client/blob/main/LICENSE)\n[![PyPI Downloads](https://img.shields.io/pypi/dm/sharpapi-python-client.svg)](https://pypi.org/project/sharpapi-python-client/)\n[![Python Version](https://img.shields.io/pypi/pyversions/sharpapi-python-client.svg)](https://www.python.org/downloads/)\n\n#### Save time on repetitive content analysis and generation tasks that your app users perform daily.\n**SharpAPI Python Client SDK** enables developers to integrate advanced artificial intelligence capabilities into their Python applications. This SDK simplifies interaction with the SharpAPI services, providing a seamless way to leverage AI for various use cases.\n\n\nVisit the [SharpAPI.com Website »](https://sharpapi.com/) for more information.\n\n---\n\n## 📚 Table of Contents\n\n- [📦 Installation](#-installation)\n- [🔧 Configuration](#-configuration)\n- [💡 Features](#-features)\n- [💻 Usage](#-usage)\n- [🧪 Testing](#-testing)\n- [🤝 Contributing](#-contributing)\n- [📄 License](#-license)\n- [📞 Contact](#-contact)\n\n---\n\n## 📦 Installation\n\nYou can install the SharpAPI Python Client SDK via **PyPI** using `pip`:\n\n```bash\npip install sharpapi-python-client\n```\n\nAlternatively, if you prefer using **Poetry** for dependency management, you can add it to your project:\n\n```bash\npoetry add sharpapi-python-client\n```\n\n---\n\n## 🔧 Configuration\n\n### 1. **Obtain Your SharpAPI API Key**\n\nSign up at [SharpAPI.com](https://sharpapi.com/) to obtain your API key.\n\n### 2. **Set Up Environment Variables**\n\nCreate a `.env` file in your project's root directory to securely store your API key:\n\n```env\nSHARP_API_KEY=your_sharpapi_api_key_here\n```\n\nEnsure that `.env` is included in your `.gitignore` to prevent accidental exposure of your API key.\n\n### 3. **Loading Environment Variables**\n\nThe SDK uses `python-dotenv` to load environment variables. Ensure that your application initializes the environment variables before using the SDK:\n\n```python\nfrom dotenv import load_dotenv\n\nload_dotenv()  # Loads environment variables from .env file\n```\n\n---\n\n## 💡 Features\n\nThe **SharpAPI Python Client SDK** offers a comprehensive suite of AI-powered tools to enhance various aspects of your applications:\n\n### **E-Commerce**\n- **Generate Engaging Product Introductions**\n- **Create Personalized Thank-You Emails**\n- **Streamline Product Categorization**\n- **Perform Sentiment Analysis on Product Reviews**\n\n### **Content \u0026 Marketing Automation**\n- **Translate Text for a Global Audience**\n- **Paraphrase and Proofread Any Text**\n- **Detect Spam Content**\n- **Extract Contact Information**\n- **Summarize Content and Generate Keywords/Tags**\n- **Generate SEO Meta Tags**\n\n### **HR Tech**\n- **Generate Job Descriptions**\n- **Identify Related Job Positions and Skills**\n- **Parse and Extract Information from Resumes**\n\n### **Travel, Tourism \u0026 Hospitality**\n- **Analyze Sentiment in Travel Reviews**\n- **Categorize Tours, Activities, and Hospitality Products**\n\n---\n\n## 💻 Usage\n\n### 🛠 **Basic Example**\n\n```python\nfrom sharpapi import SharpApiService\n\n# Initialize the SharpApiService with your API key\nsharp_api = SharpApiService(api_key='YOUR_SHARP_API_KEY')\n\ntry:\n    # Example: Generate Product Categories\n    status_url = sharp_api.product_categories(\n        product_name='Lenovo Chromebook Laptop (2023), 14\" FHD Touchscreen Slim 3, 8-Core MediaTek Kompanio 520 CPU, 4GB RAM, 128GB Storage',\n        language='German',  # Optional\n        max_quantity=400,   # Optional\n        voice_tone='Neutral',  # Optional\n        context='Optional current e-store categories'  # Optional\n    )\n\n    # Fetch and print the results\n    result_sharp_api_job = sharp_api.fetch_results(status_url)\n    print(result_sharp_api_job.get_result_json())\nexcept Exception as e:\n    print(f\"An error occurred: {e}\")\n```\n\n### 🛠 **Advanced Example: Parsing a Resume**\n\n```python\nfrom sharpapi import SharpApiService\n\n# Initialize the SharpApiService with your API key\nsharp_api = SharpApiService(api_key='YOUR_SHARP_API_KEY')\n\ntry:\n    # Parse Resume\n    status_url = sharp_api.parse_resume(\n        file_path='path/to/sample_resume.pdf',\n        language='English'  # Optional\n    )\n\n    # Fetch and print the parsed resume data\n    parsed_resume = sharp_api.fetch_results(status_url)\n    print(parsed_resume.get_result_json())\nexcept Exception as e:\n    print(f\"An error occurred: {e}\")\n```\n\n---\n\n## 🧪 Testing\n\nThis project uses Python's built-in `unittest` framework for testing.\n\n### **Running Tests**\n\nEnsure that you are in the project's root directory and that all dependencies are installed via Poetry or `pip`.\n\n#### **Using Poetry:**\n\n1. **Activate Poetry Shell:**\n\n    ```bash\n    poetry shell\n    ```\n\n2. **Run Tests:**\n\n    ```bash\n    python -m unittest discover tests\n    ```\n\n#### **Using pip and Virtual Environment:**\n\n1. **Activate Your Virtual Environment:**\n\n    ```bash\n    source venv/bin/activate  # On Windows, use `venv\\Scripts\\activate`\n    ```\n\n2. **Run Tests:**\n\n    ```bash\n    python -m unittest discover tests\n    ```\n\n---\n\n### **Key Components:**\n\n- **`src/sharpapi/`**: Contains the main SDK code.\n  - **`dto/`**: Data Transfer Objects for handling request and response data.\n  - **`enums/`**: Enumerations for standardized values across the SDK.\n  - **`sharp_api_service.py`**: Core service class to interact with SharpAPI endpoints.\n- **`tests/`**: Contains unit tests for the SDK using Python's `unittest` framework.\n- **`pyproject.toml`**: Configuration file managed by Poetry for dependencies and packaging.\n- **`LICENSE`**: Licensing information.\n- **`README.md`**: Project documentation.\n- **`venv/`**: Virtual environment directory (should be excluded from version control).\n\n---\n\n## 🤝 Contributing\n\nContributions are welcome! Whether you're reporting a bug, suggesting an enhancement, or submitting a pull request, your input is valuable to us.\n\n### **How to Contribute:**\n\n1. **Fork the Repository**\n\n    Click the [Fork](https://github.com/sharpapi/sharpapi-python-client/fork) button at the top-right corner of the repository page.\n\n2. **Clone Your Fork**\n\n    ```bash\n    git clone https://github.com/yourusername/sharpapi-python-client.git\n    cd sharpapi-python-client\n    ```\n\n3. **Create a New Branch**\n\n    ```bash\n    git checkout -b feature/YourFeatureName\n    ```\n\n4. **Make Your Changes**\n\n    Implement your feature or fix. Ensure that your code adheres to the project's coding standards.\n\n5. **Run Tests**\n\n    Ensure all tests pass before committing your changes.\n\n    ```bash\n    poetry shell\n    python -m unittest discover tests\n    ```\n\n6. **Commit Your Changes**\n\n    ```bash\n    git commit -m \"Add feature XYZ\"\n    ```\n\n7. **Push to Your Fork**\n\n    ```bash\n    git push origin feature/YourFeatureName\n    ```\n\n8. **Create a Pull Request**\n\n    Navigate to the original repository and click on \"Compare \u0026 pull request.\" Provide a clear description of your changes.\n\n### **Coding Standards:**\n\n- Follow [PEP 8](https://pep8.org/) style guidelines.\n- Write clear and concise docstrings for all modules, classes, and methods.\n- Ensure that all new features are accompanied by corresponding unit tests.\n\n---\n\n## 📄 License\n\nThis project is licensed under the [MIT License](https://github.com/sharpapi/sharpapi-python-client/blob/main/LICENSE).\n\n---\n\n## 📞 Contact\n\nFor any questions, support, or inquiries, feel free to reach out:\n\n- **Email**: [contact@sharpapi.com](mailto:contact@sharpapi.com)\n- **Website**: [https://sharpapi.com](https://sharpapi.com/)\n- **GitHub**: [https://github.com/sharpapi/sharpapi-python-client](https://github.com/sharpapi/sharpapi-python-client)\n\n---\n\n## 📝 Changelog\n\nPlease see [CHANGELOG.md](https://github.com/sharpapi/sharpapi-python-client/blob/main/CHANGELOG.md) for more information on what has changed recently.\n\n---\n\n## 📚 Documentation\n\nFor detailed usage and API methods, please refer to the [SharpAPI Documentation](https://sharpapi.com/documentation).\n\n---\n\n## 🧰 Additional Resources\n\n- **Poetry Documentation**: [https://python-poetry.org/docs/](https://python-poetry.org/docs/)\n- **Python `unittest` Documentation**: [https://docs.python.org/3/library/unittest.html](https://docs.python.org/3/library/unittest.html)\n- **SharpAPI Documentation**: [https://sharpapi.com/documentation](https://sharpapi.com/documentation)\n\n---\n## Social Media\n\n🚀 For the latest news, tutorials, and case studies, don't forget to follow us on:\n- [SharpAPI X (formerly Twitter)](https://x.com/SharpAPI)\n- [SharpAPI YouTube](https://www.youtube.com/@SharpAPI)\n- [SharpAPI Vimeo](https://vimeo.com/SharpAPI)\n- [SharpAPI LinkedIn](https://www.linkedin.com/products/a2z-web-ltd-sharpapicom-automate-with-aipowered-api/)\n- [SharpAPI Facebook](https://www.facebook.com/profile.php?id=61554115896974)\n\n---\n\nHappy Coding! 🚀\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsharpapi%2Fsharpapi-python-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsharpapi%2Fsharpapi-python-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsharpapi%2Fsharpapi-python-client/lists"}