| Name | ctftime-api JSON |
| Version |
0.1.6
JSON |
| download |
| home_page | None |
| Summary | CTFTime API wrapper |
| upload_time | 2025-08-12 20:39:31 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | None |
| keywords |
api
ctftime
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 pip:
```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)
## License
This project is released under the [GPL 3.0 or later](LICENSE) license.
Raw data
{
"_id": null,
"home_page": null,
"name": "ctftime-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "api, ctftime, wrapper",
"author": null,
"author_email": "John Toniutti <john.toniutti@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/01/c4/c2ae7906e61f9b2ef0468919cb39b325c917f3795cab6e9e16ec7b087537/ctftime_api-0.1.6.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 pip:\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## License\n\nThis project is released under the [GPL 3.0 or later](LICENSE) license.\n",
"bugtrack_url": null,
"license": null,
"summary": "CTFTime API wrapper",
"version": "0.1.6",
"project_urls": {
"documentation": "https://jotonedev.github.io/ctftime_api/",
"repository": "https://github.com/jotonedev/ctftime_api"
},
"split_keywords": [
"api",
" ctftime",
" wrapper"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1885f50f728a1c27b73e9919cfd2e7b170cc39ca5c0b9cd759ebfe3d7c30f27c",
"md5": "3f7b1217575f2d0fb3fdb6376aa1bc82",
"sha256": "3f94bceea0201724644d763689b39cc859834a2fd4035858887dc4e05bdc7679"
},
"downloads": -1,
"filename": "ctftime_api-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3f7b1217575f2d0fb3fdb6376aa1bc82",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 19497,
"upload_time": "2025-08-12T20:39:29",
"upload_time_iso_8601": "2025-08-12T20:39:29.674372Z",
"url": "https://files.pythonhosted.org/packages/18/85/f50f728a1c27b73e9919cfd2e7b170cc39ca5c0b9cd759ebfe3d7c30f27c/ctftime_api-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "01c4c2ae7906e61f9b2ef0468919cb39b325c917f3795cab6e9e16ec7b087537",
"md5": "5dfa74ca466fd87fc8e5d8854e4456d1",
"sha256": "1815b5e947f20c3021d68ff1ed268a72e73ed77d6eb6ffebac2b4e0914393f87"
},
"downloads": -1,
"filename": "ctftime_api-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "5dfa74ca466fd87fc8e5d8854e4456d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 553457,
"upload_time": "2025-08-12T20:39:31",
"upload_time_iso_8601": "2025-08-12T20:39:31.136000Z",
"url": "https://files.pythonhosted.org/packages/01/c4/c2ae7906e61f9b2ef0468919cb39b325c917f3795cab6e9e16ec7b087537/ctftime_api-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-12 20:39:31",
"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"
}
