# SMAT
A Python API wrapper for the [Social Media Analysis Toolkit](https://www.smat-app.com/timeline)
# Installation:
- Clone this repo with ``git clone https://github.com/nwithan8/SMAT-API.git`` or install from PyPi with ``pip install smat``
- Import into your project with ``from smat import API``
# Usage:
This library currently supports the three main methods of [SMAT's API](https://api.smat-app.com/docs#):
- ``get_content``: Get a list of posts from a specific outlet
- ``get_activity``: Aggregate based on a particular field on a specific outlet
- ``get_time_series``: Get a time series for a specific outlet
- ``term`` is a required parameter for each field.
- ``site``is a required parameter for each field. You can use the predefined enums in ``smat.Site`` or provide your own string.
- NOTE: IF you provide an invalid site, you will receive an empty JSON body back from the API.
- All other parameters are optional or have preset defaults.
Docs coming soon. PRs welcome.
Raw data
{
"_id": null,
"home_page": "https://github.com/nwithan8/SMAT-API",
"name": "smat",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6, <4",
"maintainer_email": "",
"keywords": "SMAT,analysis,social media,tool,online,API",
"author": "Nate Harris",
"author_email": "n8gr8gbln@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/31/e5/adfac079944609ab151aa469febc08523b9e6c16749c370124ae8ea8fa5f/smat-0.2.0.tar.gz",
"platform": null,
"description": "# SMAT\nA Python API wrapper for the [Social Media Analysis Toolkit](https://www.smat-app.com/timeline)\n\n# Installation:\n- Clone this repo with ``git clone https://github.com/nwithan8/SMAT-API.git`` or install from PyPi with ``pip install smat``\n- Import into your project with ``from smat import API``\n\n# Usage:\nThis library currently supports the three main methods of [SMAT's API](https://api.smat-app.com/docs#):\n\n- ``get_content``: Get a list of posts from a specific outlet\n- ``get_activity``: Aggregate based on a particular field on a specific outlet\n- ``get_time_series``: Get a time series for a specific outlet\n\n- ``term`` is a required parameter for each field. \n- ``site``is a required parameter for each field. You can use the predefined enums in ``smat.Site`` or provide your own string.\n - NOTE: IF you provide an invalid site, you will receive an empty JSON body back from the API.\n- All other parameters are optional or have preset defaults.\n\nDocs coming soon. PRs welcome.\n",
"bugtrack_url": null,
"license": "GNU General Public License v3 (GPLv3)",
"summary": "A Python client for SMAT's API",
"version": "0.2.0",
"split_keywords": [
"smat",
"analysis",
"social media",
"tool",
"online",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "d6735d2879590e9859c476cdf17ca661",
"sha256": "a02ac122f836c14d2da726ea4242f07c1c1bd42ed3e0fdeb25de422e26fc400f"
},
"downloads": -1,
"filename": "smat-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6735d2879590e9859c476cdf17ca661",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6, <4",
"size": 16603,
"upload_time": "2022-12-20T05:56:09",
"upload_time_iso_8601": "2022-12-20T05:56:09.311435Z",
"url": "https://files.pythonhosted.org/packages/8c/89/13b8a755b77b3de57400b48fb24dc1c6deb0982fec46b33d36ea5df0e035/smat-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "c6faacf8403b9bfeb4c32ee056458201",
"sha256": "1d4e5eb88f717769e8e978f870890154ae2d2c20e38a8d85df94d95282c0787a"
},
"downloads": -1,
"filename": "smat-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "c6faacf8403b9bfeb4c32ee056458201",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6, <4",
"size": 16486,
"upload_time": "2022-12-20T05:56:11",
"upload_time_iso_8601": "2022-12-20T05:56:11.336615Z",
"url": "https://files.pythonhosted.org/packages/31/e5/adfac079944609ab151aa469febc08523b9e6c16749c370124ae8ea8fa5f/smat-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-20 05:56:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "nwithan8",
"github_project": "SMAT-API",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "objectrest",
"specs": []
}
],
"lcname": "smat"
}
JSON
