API

Structure

The following API documentation does not include all modules of autodoc_pydantic. Instead, it focuses only on modules that are relevant for documentation purposes:

judobase
|
|- __init__.py
|- base.py
|- judobase.py
|- schemas.py

For everything else, please refer to the source code directly.

Modules

base.py

This module is located at judobase/base.py.

Base classes for API interaction with session management.

class judobase.base.CompetitionAPI

Bases: _Base

Handles competition-related API requests.

async get_competition_list(years: str = '', months: str = '') → list[Competition]: Fetches list of competitions.

async get_competition_info(competition_id: str) → Competition: Fetches details of a specific competition.

class judobase.base.ContestAPI

Bases: _Base

Handles contest-related API requests.

async find_contests(competition_id: str = '', weight_id: str = '', person_id: str = '', include: str = 'info', contest_code: str = '') → list[Contest]

Fetches list of contests.

include can contain a comma-separated list of: info, events.

class judobase.base.JudokaAPI

Bases: _Base

Handles judoka-related API requests.

async get_judoka_info(competitor_id: str) → Judoka: Fetches judoka information.

class judobase.base.CountryAPI

Bases: _Base

Handles country-related API requests.

async get_country_info(country_id: str) → Country: Fetches country information.

async get_country_list() → list[CountryShort]: Fetches all countries short information.

judobase_api.py

This module is located at judobase/judobase_api.py.

class judobase.judobase_api.JudoBase

Bases: CompetitionAPI, ContestAPI, JudokaAPI, CountryAPI

Class for extended interacting with the JudoBase API.

Provides methods to retrieve information about competitions, contests, judokas, and countries.

async all_competition() → list[Competition]: Retrieves data for all competitions.

async competitions_in_range(start_date: datetime, end_date: datetime) → list[Competition]: Retrieves data for competitions within a specified date range.

async competition_by_id(competition_id: int | str) → Competition: Retrieves data for a specific competition by its ID.

async all_contests() → list[Contest]: Retrieves data for all contests using concurrent API calls.

async contests_by_competition_id(competition_id: int | str, weight: WeightEnum = '', *, include_events: bool = False) → list[Contest]

Retrieves data for all contests using concurrent API calls.

Optionally filters by weight category and includes data about contests events like throw, osaekomi or shido.

async judoka_by_id(judoka_id: int | str) → Judoka: Retrieves data for a specific judoka by their ID.

async country_by_id(country_id: int | str) → Country: Retrieves data for a specific country by its ID.

async all_countries() → list[CountryShort]: Retrieves short data for all the countries.