MagicFeedback


NameMagicFeedback JSON
Version 0.0.2 PyPI version JSON
download
home_pageNone
SummarySDK for MagicFeedback API
upload_time2024-09-08 12:38:14
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # MagicFeedback SDK

**A Python SDK for interacting with the MagicFeedback API**

**Installation**

Bash

```
pip install MagicFeeedback

```

Use code [with caution.](/faq#coding)

**Usage**

Python

```
from magicfeedback import MagicFeedbackClient

# Create a MagicFeedbackClient instance
client = MagicFeedbackClient('email', 'password')

# Create a new feedback item
feedback_data = {
    "name": "Test Feedback",
    "type": "DOCUMENT",
    # ... other required fields
}
response = client.create_feedback(feedback_data)

# Print the response
print(response)

```

**API Reference**

- **`create_feedback(feedback)`:** Creates a new feedback item.
- **`get_feedback(feedback_id)`:** Retrieves a specific feedback item.
- **`update_feedback(feedback_id, feedback)`:** Updates a specific feedback item.
- **`delete_feedback(feedback_id)`:** Deletes a specific feedback item.

**Additional Information**

- **Authentication:** The SDK requires an user / password for authentication. You can obtain from the MagicFeedback platform.
- **Error Handling:** The SDK handles common API errors and raises appropriate exceptions.
- **Customizations:** You can customize the SDK to fit your specific needs by extending the `MagicFeedbackClient` class or creating additional helper functions.

**License**

This project is licensed under the MIT License.

**Contact**

For any questions or support, please contact farias@magicfeedback.io.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "MagicFeedback",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Francisco Arias <farias@magicfedback.io>",
    "download_url": "https://files.pythonhosted.org/packages/28/de/7989fa4ceba16c8b4cddec36c605f0ae1c909fd94a23f23cb0992fcd4c8c/magicfeedback-0.0.2.tar.gz",
    "platform": null,
    "description": "# MagicFeedback SDK\n\n**A Python SDK for interacting with the MagicFeedback API**\n\n**Installation**\n\nBash\n\n```\npip install MagicFeeedback\n\n```\n\nUse code [with caution.](/faq#coding)\n\n**Usage**\n\nPython\n\n```\nfrom magicfeedback import MagicFeedbackClient\n\n# Create a MagicFeedbackClient instance\nclient = MagicFeedbackClient('email', 'password')\n\n# Create a new feedback item\nfeedback_data = {\n    \"name\": \"Test Feedback\",\n    \"type\": \"DOCUMENT\",\n    # ... other required fields\n}\nresponse = client.create_feedback(feedback_data)\n\n# Print the response\nprint(response)\n\n```\n\n**API Reference**\n\n- **`create_feedback(feedback)`:** Creates a new feedback item.\n- **`get_feedback(feedback_id)`:** Retrieves a specific feedback item.\n- **`update_feedback(feedback_id, feedback)`:** Updates a specific feedback item.\n- **`delete_feedback(feedback_id)`:** Deletes a specific feedback item.\n\n**Additional Information**\n\n- **Authentication:** The SDK requires an user / password for authentication. You can obtain from the MagicFeedback platform.\n- **Error Handling:** The SDK handles common API errors and raises appropriate exceptions.\n- **Customizations:** You can customize the SDK to fit your specific needs by extending the `MagicFeedbackClient` class or creating additional helper functions.\n\n**License**\n\nThis project is licensed under the MIT License.\n\n**Contact**\n\nFor any questions or support, please contact farias@magicfeedback.io.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "SDK for MagicFeedback API",
    "version": "0.0.2",
    "project_urls": {
        "Homepage": "https://github.com/MagicFeedback/magicfeedback_python_sdk",
        "Issues": "https://github.com/MagicFeedback/magicfeedback_python_sdk/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f9d26d99aaccad45415f466d51c9d11d89763deb5314ecfbb698a032b03db05e",
                "md5": "005e640be40170600914a369a149487b",
                "sha256": "7f8a8e80b2cc45ac0219e562f60c6d601ab7d61b836228bc4bc7b3f1cd6e2e6f"
            },
            "downloads": -1,
            "filename": "MagicFeedback-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "005e640be40170600914a369a149487b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 4412,
            "upload_time": "2024-09-08T12:38:13",
            "upload_time_iso_8601": "2024-09-08T12:38:13.968109Z",
            "url": "https://files.pythonhosted.org/packages/f9/d2/6d99aaccad45415f466d51c9d11d89763deb5314ecfbb698a032b03db05e/MagicFeedback-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "28de7989fa4ceba16c8b4cddec36c605f0ae1c909fd94a23f23cb0992fcd4c8c",
                "md5": "8f4ec63d5e9b4e3d3589f4e5e3e414f7",
                "sha256": "d9fb6f6c5487eb4de78d9c670e2141bb60e149fa79bbae4428e01c5671f2fdfc"
            },
            "downloads": -1,
            "filename": "magicfeedback-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "8f4ec63d5e9b4e3d3589f4e5e3e414f7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 4516,
            "upload_time": "2024-09-08T12:38:14",
            "upload_time_iso_8601": "2024-09-08T12:38:14.909207Z",
            "url": "https://files.pythonhosted.org/packages/28/de/7989fa4ceba16c8b4cddec36c605f0ae1c909fd94a23f23cb0992fcd4c8c/magicfeedback-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-08 12:38:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "MagicFeedback",
    "github_project": "magicfeedback_python_sdk",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "magicfeedback"
}
        
Elapsed time: 0.30621s