Skip to main content

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zindi-0.0.4.tar.gz (177.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zindi-0.0.4-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

Details for the file zindi-0.0.4.tar.gz.

File metadata

  • Download URL: zindi-0.0.4.tar.gz
  • Upload date:
  • Size: 177.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for zindi-0.0.4.tar.gz
Algorithm Hash digest
SHA256 48dbd80320eb1071f0682bf926ef6c400f542bdf61606cd115024561f9fc631a
MD5 19da8958bc12c1edf8fd97b0185dabc3
BLAKE2b-256 9177e41ff45a8c8cf5208ff7b895e2f1e1b8b813a18108037e0084b74d4dce8f

See more details on using hashes here.

Provenance

The following attestation bundles were made for zindi-0.0.4.tar.gz:

Publisher: python-publish.yml on KameniAlexNea/zindi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file zindi-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: zindi-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 15.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for zindi-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 da001c654a94844caa52ffa365218b772221ac0c1b3356932ae692959cd0fe45
MD5 53e91b788e051356590006c7204136e3
BLAKE2b-256 60a8e2ed15426e35701da109c36eac674b2569730d822a0dc750121f9cb9c087

See more details on using hashes here.

Provenance

The following attestation bundles were made for zindi-0.0.4-py3-none-any.whl:

Publisher: python-publish.yml on KameniAlexNea/zindi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.0.4 This release

2 files

0.0.3

2 files

0.0.2

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page