zindi-package

Description

A user-friendly Python client for interacting with the Zindi platform.

Installation

pip install -U zindi

Quick start

from zindi.user import Zindian

# interactive mode (prints formatted tables/messages)
user = Zindian(username="your_username")

# or tool/MCP-friendly mode (returns typed models)
# user = Zindian(username="your_username", return_models=True, to_print=False)

Usage

You can also check the Colab notebook.

# 1) Select challenge
selection = user.select_a_challenge(challenge_id="digicow-farmer-training-adoption-challenge")

# 2) Inspect challenge/rank
current = user.which_challenge
rank = user.my_rank

# 3) Leaderboard and submission board
leaderboard = user.leaderboard(per_page=50)
board = user.submission_board(per_page=50)

# 4) Download dataset and submit file
files = user.download_dataset(destination="./dataset")
submission = user.submit(
	filepaths=["./dataset/SampleSubmission.csv"],
	comments=["initial submission"],
)

# 5) Team actions
team = user.create_team(team_name="New Team")

Typed model outputs (recommended for integrations)

user = Zindian(username="your_username", return_models=True, to_print=False)

selection = user.select_a_challenge(query="DigiCow")
print(selection)             # ChallengeSelectionResult(...)

leaderboard = user.leaderboard(per_page=10)
print(leaderboard)           # LeaderboardResult(rank=..., total_rows=...)

submissions = user.submission_board(per_page=20)
print(submissions)           # SubmissionBoardResult(total_rows=...)

payload = leaderboard.to_dict()   # JSON-serializable dictionary

Contributors

Emmanuel KOUPOH	Cédric MANOUAN	Muhamed TUO	Elie Alex Kameni Ngangue
eaedk	dric2018	NazarioR9	KameniAlexNea
Emmanuel on linkedin	Cedric on linkedin	Muhamed on linkedin	Alex on linkedin
@eaedk😂	@Zeus😆	@Nazario😁	@alexneakameni🤗

Don’t forget to visit Zindi Platform