icpc-api 0.1.0__tar.gz

icpc_api-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nikita Sychev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

icpc_api-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+graft tests
+include uv.lock

icpc_api-0.1.0/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: icpc-api
+Version: 0.1.0
+Summary: Unofficial Python client and CLI for the icpc.global API
+Author-email: Nikita Sychev <root@nsychev.ru>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/nsychev/icpc-api
+Project-URL: Repository, https://github.com/nsychev/icpc-api
+Project-URL: Issues, https://github.com/nsychev/icpc-api/issues
+Project-URL: Documentation, https://github.com/nsychev/icpc-api/tree/master/docs
+Keywords: icpc,api,client,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: THIRD-PARTY-LICENSES.md
+Requires-Dist: httpx>=0.28
+Requires-Dist: pydantic>=2.9
+Provides-Extra: cli
+Requires-Dist: typer>=0.15; extra == "cli"
+Requires-Dist: rich>=13; extra == "cli"
+Dynamic: license-file
+
+# icpc-api
+
+An unofficial Python client and CLI for [icpc.global](https://icpc.global) API.
+Supports authentication and customizable search over contest data.
+
+**Note:** This project is aimed for regional contest organizers. If you want to
+compete, please [use Regional Finder](https://icpc.global/regionals/finder) to
+find nearest regional competition to you and its schedule.
+
+## Install
+
+Use Python 3.12+ and [uv](https://github.com/astral-sh/uv).
+
+```bash
+# add library to your project
+uv add icpc-api
+
+# run your script that uses `import icpc`
+uv run --with icpc-api script.py
+
+# install CLI into PATH
+uv tool install 'icpc-api[cli]'
+```
+
+If you don't have `uv`, feel free to use `pip` or any other convenient Python package manager.
+
+## Quick start
+
+CLI:
+
+```bash
+icpc auth login
+icpc whoami
+icpc contest teams 1234 --status ACCEPTED
+icpc search teams 1234 --proj id,name,status --sort name:asc -o csv > teams.csv
+```
+
+Python synchronous API:
+
+```python
+from icpc import Icpc
+from icpc.search import contest_teams
+from icpc.models import TeamStatus
+
+with Icpc.from_store() as icpc:
+    # Use DSL to build the request
+    teams = contest_teams(1234)
+    f = teams.fields
+    q = teams.query(
+        proj=[f.id.name, f.name.name, f.inst_short_name.name],
+        filters=[f.status.eq(TeamStatus.ACCEPTED)],
+        sort=[f.name.asc()],
+    )
+    # `icpc.all` executes search request
+    for row in icpc.all(teams, q):
+        print(row.id, row.name, row.inst_short_name)
+```
+
+Python asynchronous API:
+
+```python
+import asyncio
+from icpc import AsyncIcpc, Include
+
+
+async def main() -> None:
+    async with AsyncIcpc.from_store() as icpc:
+        view = await icpc.load_contest(1234, Include.DEFAULT)
+        for team in view.teams:
+            print(team.name, len(team.contestants), team.institution.inst_name)
+
+
+asyncio.run(main())
+```
+
+`load_contest` is the unified search: it fetches the team, team-member, institution
+and contest tables concurrently, then joins them — teams indexed by id, rosters
+bucketed by team, institutions attached by `instId`, participants by `personId`, and
+the JSON-in-a-string `teamMembers` and `extraField` columns parsed into real objects.
+
+## Authentication
+
+```python
+Icpc.from_password("me@example.com", "…")  # SRP login
+Icpc.from_store()  # use `icpc auth login` to authenticate
+Icpc.from_token("eyJ…")  # a borrowed id token from localStorage
+Icpc.anonymous()  # /contest/public/* only
+```
+
+When using store, token and credentials are written to `~/.config/icpc/credentials.json`.
+You can also use `ICPC_USERNAME` and `ICPC_PASSWORD` or `ICPC_ID_TOKEN` environment
+variables. ID Token is valid only for one hour.
+
+## Documentation
+
+Read detailed guides on how to use:
+
+- [Python API](docs/api.md) — guide, with worked examples
+- [CLI](docs/cli.md) — every command, with worked examples
+- [API reference](docs/reference.md) — every endpoint this client wraps
+
+## Development
+
+```bash
+uv sync --extra cli
+uv run pytest
+uv run ruff check . && uv run ruff format --check .
+uv run ty check icpc tests
+```

icpc_api-0.1.0/README.md

@@ -0,0 +1,109 @@
+# icpc-api
+
+An unofficial Python client and CLI for [icpc.global](https://icpc.global) API.
+Supports authentication and customizable search over contest data.
+
+**Note:** This project is aimed for regional contest organizers. If you want to
+compete, please [use Regional Finder](https://icpc.global/regionals/finder) to
+find nearest regional competition to you and its schedule.
+
+## Install
+
+Use Python 3.12+ and [uv](https://github.com/astral-sh/uv).
+
+```bash
+# add library to your project
+uv add icpc-api
+
+# run your script that uses `import icpc`
+uv run --with icpc-api script.py
+
+# install CLI into PATH
+uv tool install 'icpc-api[cli]'
+```
+
+If you don't have `uv`, feel free to use `pip` or any other convenient Python package manager.
+
+## Quick start
+
+CLI:
+
+```bash
+icpc auth login
+icpc whoami
+icpc contest teams 1234 --status ACCEPTED
+icpc search teams 1234 --proj id,name,status --sort name:asc -o csv > teams.csv
+```
+
+Python synchronous API:
+
+```python
+from icpc import Icpc
+from icpc.search import contest_teams
+from icpc.models import TeamStatus
+
+with Icpc.from_store() as icpc:
+    # Use DSL to build the request
+    teams = contest_teams(1234)
+    f = teams.fields
+    q = teams.query(
+        proj=[f.id.name, f.name.name, f.inst_short_name.name],
+        filters=[f.status.eq(TeamStatus.ACCEPTED)],
+        sort=[f.name.asc()],
+    )
+    # `icpc.all` executes search request
+    for row in icpc.all(teams, q):
+        print(row.id, row.name, row.inst_short_name)
+```
+
+Python asynchronous API:
+
+```python
+import asyncio
+from icpc import AsyncIcpc, Include
+
+
+async def main() -> None:
+    async with AsyncIcpc.from_store() as icpc:
+        view = await icpc.load_contest(1234, Include.DEFAULT)
+        for team in view.teams:
+            print(team.name, len(team.contestants), team.institution.inst_name)
+
+
+asyncio.run(main())
+```
+
+`load_contest` is the unified search: it fetches the team, team-member, institution
+and contest tables concurrently, then joins them — teams indexed by id, rosters
+bucketed by team, institutions attached by `instId`, participants by `personId`, and
+the JSON-in-a-string `teamMembers` and `extraField` columns parsed into real objects.
+
+## Authentication
+
+```python
+Icpc.from_password("me@example.com", "…")  # SRP login
+Icpc.from_store()  # use `icpc auth login` to authenticate
+Icpc.from_token("eyJ…")  # a borrowed id token from localStorage
+Icpc.anonymous()  # /contest/public/* only
+```
+
+When using store, token and credentials are written to `~/.config/icpc/credentials.json`.
+You can also use `ICPC_USERNAME` and `ICPC_PASSWORD` or `ICPC_ID_TOKEN` environment
+variables. ID Token is valid only for one hour.
+
+## Documentation
+
+Read detailed guides on how to use:
+
+- [Python API](docs/api.md) — guide, with worked examples
+- [CLI](docs/cli.md) — every command, with worked examples
+- [API reference](docs/reference.md) — every endpoint this client wraps
+
+## Development
+
+```bash
+uv sync --extra cli
+uv run pytest
+uv run ruff check . && uv run ruff format --check .
+uv run ty check icpc tests
+```

icpc_api-0.1.0/THIRD-PARTY-LICENSES.md

@@ -0,0 +1,220 @@
+# Third-Party Licenses
+
+## `icpc/auth/srp.py`
+
+### warrant
+
+https://github.com/capless/warrant
+
+Copyright (c) Capless.io, Apache License, Version 2.0
+
+### amplify-js
+
+https://github.com/aws-amplify/amplify-js
+
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved, Apache License, Version 2.0
+
+```
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+```

icpc_api-0.1.0/icpc/__init__.py

@@ -0,0 +1,32 @@
+"""Unofficial client for the icpc.global API.
+
+Read a whole contest in one call::
+
+    from icpc import Icpc
+
+    with Icpc.from_store() as icpc:
+        teams = icpc.load_contest(1234)
+        print(len(teams.teams), "teams")
+"""
+
+from icpc.config import Settings
+from icpc.errors import ApiError, AuthError, IcpcError, SearchError
+from icpc.facade.client import AsyncIcpc, Icpc, Include
+from icpc.facade.domain import ContestView, Member, Team
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "ApiError",
+    "AsyncIcpc",
+    "AuthError",
+    "ContestView",
+    "Icpc",
+    "IcpcError",
+    "Include",
+    "Member",
+    "SearchError",
+    "Settings",
+    "Team",
+    "__version__",
+]

icpc_api-0.1.0/icpc/api/__init__.py

@@ -0,0 +1,18 @@
+"""Low-level endpoints.
+
+Each function is pure: it builds an :class:`~icpc.transport.operation.Operation`
+and performs no I/O. Send one with ``client.send(...)``::
+
+    from icpc import Icpc
+    from icpc.api import team
+
+    with Icpc.from_store() as icpc:
+        roster = icpc.send(team.members(1234567))
+
+Not all endpoints are wrapped here. Please fill an issue for missing ones or use
+`icpc raw`.
+"""
+
+from icpc.api import common, contest, person, public, staff, team
+
+__all__ = ["common", "contest", "person", "public", "staff", "team"]

icpc_api-0.1.0/icpc/api/common.py

@@ -0,0 +1,97 @@
+"""``/common``, ``/icpcprofile`` and the ``/aspectfaces`` schema registry."""
+
+from __future__ import annotations
+
+from icpc.models.base import Row
+from icpc.models.entities import Globals, InstitutionSuggestion
+from icpc.transport.operation import Operation, Request, list_op, model_op, scalar_op
+
+__all__ = [
+    "AspectFacesField",
+    "AspectFacesSchema",
+    "globals_",
+    "institution_suggest",
+    "schema",
+    "wf_year",
+]
+
+
+def globals_() -> Operation[Globals]:
+    """Site-wide settings: the current World Finals and regionals years."""
+    return model_op(Request("GET", "/common/globals/all"), Globals)
+
+
+def wf_year() -> Operation[int]:
+    """The current World Finals year."""
+    return scalar_op(Request("GET", "/common/globals/WFYear"), int)
+
+
+def suggested_institution(institution_id: int) -> Operation[dict[str, object]]:
+    """A suggested-institution record."""
+    return model_op(
+        Request("GET", f"/common/suggestedinstitution/{institution_id}"), dict[str, object]
+    )
+
+
+class AspectFacesField(Row):
+    """One field of a server-side form definition."""
+
+    name: str | None = None
+    tag: str | None = None
+    label: str | None = None
+    label_key: str | None = None
+    placeholder: str | None = None
+    order: int | None = None
+    #: Allowed values, when the field is a choice — the closest thing to an enum
+    #: definition this API publishes.
+    options: list[object] | None = None
+    constraints: object | None = None
+    tooltip: str | None = None
+
+
+class AspectFacesSchema(Row):
+    """``GET /aspectfaces/<java.class.Name>`` — a form definition."""
+
+    name: str | None = None
+    fields: list[AspectFacesField] | None = None
+    obj: object | None = None
+
+
+def schema(java_class: str, *associations: str) -> Operation[AspectFacesSchema]:
+    """Fetch a server-side form definition.
+
+    This is the only schema the API exposes. It is the authoritative source for
+    enum option lists and required-field constraints, and therefore the right place
+    to look before constructing a write payload::
+
+        schema("global.icpc.base.model.team.businessobjects.Team", "teamInfo")
+    """
+    path = f"/aspectfaces/{java_class}"
+    if associations:
+        path += "->" + ",".join(associations)
+    return model_op(Request("GET", path), AspectFacesSchema)
+
+
+def countries() -> Operation[list[dict[str, object]]]:
+    """The country list used by the registration forms."""
+    return list_op(Request("GET", "/common/country/all"), dict[str, object])
+
+
+def institution_suggest(
+    name: str, *, page: int = 1, size: int = 10
+) -> Operation[list[InstitutionSuggestion]]:
+    """Look an institution up by name, as the UI's picker does.
+
+    The ``id`` it returns is the ``institutionUnitId`` that
+    :func:`icpc.api.team.register` expects. Take care: it is a different number
+    from both the ``instId`` and the ``instUnitId`` columns of the institution
+    search grid, which are ids in other tables entirely.
+    """
+    return list_op(
+        Request(
+            "GET",
+            "/common/institutionunit/suggest",
+            params={"name": name, "page": page, "size": size},
+        ),
+        InstitutionSuggestion,
+    )