<div align="center">
<h1>🔃 Awakatime</h1>
<p>An asynchronous API wrapper for Wakatime</p>
<a href="https://wakatime.com/badge/github/controlado/awakatime">
<img src="https://wakatime.com/badge/github/controlado/awakatime.svg" alt="wakatime">
</a>
<a href="https://discordapp.com/users/854886148455399436">
<img src="https://dcbadge.vercel.app/api/shield/854886148455399436?style=flat" alt="discord">
</a>
<br>
<a href="https://github.com/controlado/awakatime/issues/new">
<img src="https://img.shields.io/badge/Report%20a%20bug-gray" alt="report">
</a>
<a href="https://awakatime.readthedocs.io/en/latest/?badge=latest">
<img src="https://readthedocs.org/projects/awakatime/badge/?version=latest" alt="documentation">
</a>
<a href="README.md">
<img src="https://img.shields.io/badge/English-bright" alt="english">
</a>
<a href="README.br.md">
<img src="https://img.shields.io/badge/Português-bright" alt="português">
</a>
<br>
<a href="https://codecov.io/gh/controlado/awakatime">
<img src="https://codecov.io/gh/controlado/awakatime/branch/main/graph/badge.svg?token=86DTBWW41H">
</a>
<a href="https://pypi.org/project/awakatime/">
<img src="https://img.shields.io/pypi/v/awakatime?color=red" alt="pypi">
</a>
<img src="https://img.shields.io/github/license/controlado/awakatime?color=red" alt="license">
</div>
## Installation
```bash
pip install awakatime
```
## Usage
It's recommended to use a context manager to create an instance of the client.
```python
import asyncio
from awakatime import Awakatime
async def main():
async with Awakatime("your_api_key") as awakatime:
tasks = [awakatime.get_all_time(), awakatime.get_projects()]
all_time, projects = await asyncio.gather(*tasks)
print(all_time)
print(projects)
if __name__ == "__main__":
coro = main()
asyncio.run(coro)
```
## Development
git clone https://github.com/controlado/awakatime.git
cd awakatime
<details>
<summary>With Poetry</summary>
poetry install --with dev
</details>
<details>
<summary>Without Poetry</summary>
python -m venv .venv
source .venv/bin/activate
pip install -r requirements-dev.txt
</details>
Raw data
{
"_id": null,
"home_page": "https://github.com/controlado/awakatime",
"name": "awakatime",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "wakatime,api-wrapper,async",
"author": "Yan Gabriel",
"author_email": "yangabrielogy@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/5d/ae/5974ccf1ee5da53d59048452322945609d013e62327014815a9e9d080647/awakatime-1.1.10.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <h1>\ud83d\udd03 Awakatime</h1>\n <p>An asynchronous API wrapper for Wakatime</p>\n <a href=\"https://wakatime.com/badge/github/controlado/awakatime\">\n <img src=\"https://wakatime.com/badge/github/controlado/awakatime.svg\" alt=\"wakatime\">\n </a>\n <a href=\"https://discordapp.com/users/854886148455399436\">\n <img src=\"https://dcbadge.vercel.app/api/shield/854886148455399436?style=flat\" alt=\"discord\">\n </a>\n <br>\n <a href=\"https://github.com/controlado/awakatime/issues/new\">\n <img src=\"https://img.shields.io/badge/Report%20a%20bug-gray\" alt=\"report\">\n </a>\n <a href=\"https://awakatime.readthedocs.io/en/latest/?badge=latest\">\n <img src=\"https://readthedocs.org/projects/awakatime/badge/?version=latest\" alt=\"documentation\">\n </a>\n <a href=\"README.md\">\n <img src=\"https://img.shields.io/badge/English-bright\" alt=\"english\">\n </a>\n <a href=\"README.br.md\">\n <img src=\"https://img.shields.io/badge/Portugu\u00eas-bright\" alt=\"portugu\u00eas\">\n </a>\n <br>\n <a href=\"https://codecov.io/gh/controlado/awakatime\">\n <img src=\"https://codecov.io/gh/controlado/awakatime/branch/main/graph/badge.svg?token=86DTBWW41H\">\n </a>\n <a href=\"https://pypi.org/project/awakatime/\">\n <img src=\"https://img.shields.io/pypi/v/awakatime?color=red\" alt=\"pypi\">\n </a>\n <img src=\"https://img.shields.io/github/license/controlado/awakatime?color=red\" alt=\"license\">\n</div>\n\n## Installation\n\n```bash\npip install awakatime\n```\n\n## Usage\n\nIt's recommended to use a context manager to create an instance of the client.\n\n```python\nimport asyncio\n\nfrom awakatime import Awakatime\n\n\nasync def main():\n async with Awakatime(\"your_api_key\") as awakatime:\n tasks = [awakatime.get_all_time(), awakatime.get_projects()]\n all_time, projects = await asyncio.gather(*tasks)\n print(all_time)\n print(projects)\n\n\nif __name__ == \"__main__\":\n coro = main()\n asyncio.run(coro)\n```\n\n## Development\n\n git clone https://github.com/controlado/awakatime.git\n cd awakatime\n\n<details>\n <summary>With Poetry</summary>\n\n poetry install --with dev\n\n</details>\n\n<details>\n <summary>Without Poetry</summary>\n\n python -m venv .venv\n source .venv/bin/activate\n pip install -r requirements-dev.txt\n\n</details>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simple async wrapper for the Wakatime API",
"version": "1.1.10",
"project_urls": {
"Documentation": "https://awakatime.readthedocs.io/en/latest/",
"Homepage": "https://github.com/controlado/awakatime",
"Repository": "https://github.com/controlado/awakatime"
},
"split_keywords": [
"wakatime",
"api-wrapper",
"async"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "61b3426fb81d876960e16c471ccec9a37e7890261f889d33c928fd910c2652fc",
"md5": "43d7cbda93704f2bf78e0e9117e3cdbb",
"sha256": "409326de082194335052b70d04542c0f61eceafd1efafd7d82cedcff694be3eb"
},
"downloads": -1,
"filename": "awakatime-1.1.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "43d7cbda93704f2bf78e0e9117e3cdbb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 4633,
"upload_time": "2023-08-16T23:45:34",
"upload_time_iso_8601": "2023-08-16T23:45:34.905103Z",
"url": "https://files.pythonhosted.org/packages/61/b3/426fb81d876960e16c471ccec9a37e7890261f889d33c928fd910c2652fc/awakatime-1.1.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5dae5974ccf1ee5da53d59048452322945609d013e62327014815a9e9d080647",
"md5": "126966e6a6e880a474a26d114cb2041d",
"sha256": "27edbfc3e9f4f15458b35e182aa85c8a87933c2a1da0f82ad32b19e92f8b2792"
},
"downloads": -1,
"filename": "awakatime-1.1.10.tar.gz",
"has_sig": false,
"md5_digest": "126966e6a6e880a474a26d114cb2041d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 4366,
"upload_time": "2023-08-16T23:45:35",
"upload_time_iso_8601": "2023-08-16T23:45:35.992161Z",
"url": "https://files.pythonhosted.org/packages/5d/ae/5974ccf1ee5da53d59048452322945609d013e62327014815a9e9d080647/awakatime-1.1.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-16 23:45:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "controlado",
"github_project": "awakatime",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "awakatime"
}
JSON
