| Name | ctftime-api JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | None |
| Summary | CTFTime API wrapper |
| upload_time | 2025-02-16 13:18:07 |
| maintainer | None |
| docs_url | None |
| author | John Toniutti |
| requires_python | >=3.11 |
| license | None |
| keywords |
ctftime
api
wrapper
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ctftime_api
A simple Python wrapper for the CTFTime API that provides an asynchronous interface to retrieve CTF event and team information.
## Features
- **Asynchronous:** Utilize Python's async/await for non-blocking API requests.
- **Type Safe:** Fully type annotated using Pydantic models.
- **Modular:** Organized into client and models modules for easy maintenance and extension.
- **Tested:** Includes comprehensive unit tests in the [tests](tests/) directory.
## Installation
Install via Poetry:
```sh
git clone https://github.com/jotonedev/ctftime_api
cd ctftime_api
poetry install
```
Or via pip (recommended):
```sh
pip install ctftime_api
```
## Usage
Create a client to interact with the CTFTime API. For example, to get the top teams for the current year:
```python
import asyncio
from ctftime_api.client import CTFTimeClient
async def main():
client = CTFTimeClient()
top_teams = await client.get_top_teams_per_year()
for team in top_teams:
print(f"{team.name} (ID: {team.id}) - Points: {team.points}")
await client.close()
asyncio.run(main())
```
For more detailed examples, check the examples directory.
## Documentation
Full API documentation is available at [https://jotonedev.github.io/ctftime_api](https://jotonedev.github.io/ctftime_api).
## Contributing
This project is licensed under the GNU General Public License v3 or later (GPLv3+).
## Additional Resources
- [Project Documentation Website](https://jotonedev.github.io/ctftime_api)
- [GitHub Repository](https://github.com/jotonedev/ctftime_api)
Raw data
{
"_id": null,
"home_page": null,
"name": "ctftime-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "ctftime, api, wrapper",
"author": "John Toniutti",
"author_email": "john.toniutti@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/73/d9/0bab6e03730cf626c3f8467f87df165a6bcba3540ebe3ed8551d8906d78a/ctftime_api-0.1.3.tar.gz",
"platform": null,
"description": "# ctftime_api\n\n\n\n\n\nA simple Python wrapper for the CTFTime API that provides an asynchronous interface to retrieve CTF event and team information.\n\n## Features\n\n- **Asynchronous:** Utilize Python's async/await for non-blocking API requests.\n- **Type Safe:** Fully type annotated using Pydantic models.\n- **Modular:** Organized into client and models modules for easy maintenance and extension.\n- **Tested:** Includes comprehensive unit tests in the [tests](tests/) directory.\n\n## Installation\n\nInstall via Poetry:\n\n```sh\ngit clone https://github.com/jotonedev/ctftime_api\ncd ctftime_api\npoetry install\n```\n\nOr via pip (recommended):\n\n```sh\npip install ctftime_api\n```\n\n## Usage\n\nCreate a client to interact with the CTFTime API. For example, to get the top teams for the current year:\n\n```python\nimport asyncio\nfrom ctftime_api.client import CTFTimeClient\n\nasync def main():\n client = CTFTimeClient()\n top_teams = await client.get_top_teams_per_year()\n for team in top_teams:\n print(f\"{team.name} (ID: {team.id}) - Points: {team.points}\")\n await client.close()\n\nasyncio.run(main())\n```\n\nFor more detailed examples, check the examples directory.\n\n## Documentation\n\nFull API documentation is available at [https://jotonedev.github.io/ctftime_api](https://jotonedev.github.io/ctftime_api).\n\n## Contributing\n\nThis project is licensed under the GNU General Public License v3 or later (GPLv3+).\n\n## Additional Resources\n\n- [Project Documentation Website](https://jotonedev.github.io/ctftime_api)\n- [GitHub Repository](https://github.com/jotonedev/ctftime_api)\n\n",
"bugtrack_url": null,
"license": null,
"summary": "CTFTime API wrapper",
"version": "0.1.3",
"project_urls": {
"Documentation": "https://jotonedev.github.io/ctftime_api/",
"Repository": "https://github.com/jotonedev/ctftime_api"
},
"split_keywords": [
"ctftime",
" api",
" wrapper"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8ed60114aebf5b5c099bc19753d295da4cee67e0491024db9316eb89cee83fec",
"md5": "ac0d7e00d6c5ed4960b53521a4cb6efa",
"sha256": "b7ae37cefcb8b2e784c2fdfbabb4f91a20f0dd581f32e405b15a71ab1ba21048"
},
"downloads": -1,
"filename": "ctftime_api-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ac0d7e00d6c5ed4960b53521a4cb6efa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 19307,
"upload_time": "2025-02-16T13:18:02",
"upload_time_iso_8601": "2025-02-16T13:18:02.392416Z",
"url": "https://files.pythonhosted.org/packages/8e/d6/0114aebf5b5c099bc19753d295da4cee67e0491024db9316eb89cee83fec/ctftime_api-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "73d90bab6e03730cf626c3f8467f87df165a6bcba3540ebe3ed8551d8906d78a",
"md5": "ad33438f2c84771a04b0c5f8d4fa70b2",
"sha256": "17f944cc5a1820ed746a53a98b47466308ff202094593cb884f3c118fac05caa"
},
"downloads": -1,
"filename": "ctftime_api-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "ad33438f2c84771a04b0c5f8d4fa70b2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 17376,
"upload_time": "2025-02-16T13:18:07",
"upload_time_iso_8601": "2025-02-16T13:18:07.532713Z",
"url": "https://files.pythonhosted.org/packages/73/d9/0bab6e03730cf626c3f8467f87df165a6bcba3540ebe3ed8551d8906d78a/ctftime_api-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-16 13:18:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jotonedev",
"github_project": "ctftime_api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ctftime-api"
}
