Skip to main content

Python client for the WikiTree API

Project description

WikiTree API Python Client

A modern Python wrapper for the WikiTree API.

This library provides authenticated and public access to WikiTree data, with clean method wrappers and consistent JSON responses.

Features

  • Simple WikiTreeSession class for all API interactions
  • Built-in login handling, cookie persistence, and error checking
  • Fully typed and documented methods

Installation

From GitHub (latest version):

pip install git+https://github.com/harrislineage/wikitree-api-python.git

Quick Start

from wikitree_api import WikiTreeSession

wt = WikiTreeSession()
wt.authenticate(email="your_email@example.com", password="your_password")

data = wt.getProfile(key="Clemens-1", fields="Id,Name,FirstName,BirthDate,DeathDate")
print(data)

API Coverage

Action Description
getProfile Retrieve a full person or space profile
getPerson Retrieve a minimal person profile
getPeople Retrieve multiple profiles
getAncestors Get recursive ancestors
getDescendants Get recursive descendants
getRelatives Parents, children, siblings, spouses
getConnections Find relationship path between two profiles
getWatchlist Get your trusted-list profiles
getCategories List categories linked to a profile
getBio Retrieve biography text only
getPhotos Retrieve profile photo metadata
getDNATestsByTestTaker DNA tests assigned to a profile
getConnectedDNATestsByProfile DNA tests connected to a profile
getConnectedProfilesByDNATest Profiles connected by DNA test
searchPerson Search by name, date, and filters

Requirements

  • Python ≥ 3.8
  • requests >= 2.28
  • Optional for examples:
    • matplotlib >= 3.7
    • wordcloud >= 1.9

Development

git clone https://github.com/harrislineage/wikitree-api-python.git
cd wikitree-api-python
pip install -e .

Project details


Download files

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

Source Distribution

wikitree_api-0.1.0b1.tar.gz (19.3 kB view details)

Uploaded Source

Built Distribution

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

wikitree_api-0.1.0b1-py3-none-any.whl (20.5 kB view details)

Uploaded Python 3

File details

Details for the file wikitree_api-0.1.0b1.tar.gz.

File metadata

  • Download URL: wikitree_api-0.1.0b1.tar.gz
  • Upload date:
  • Size: 19.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for wikitree_api-0.1.0b1.tar.gz
Algorithm Hash digest
SHA256 7c74fab54d20e10f1b6e724005da73ed9ceb2b34a83e19dd7908f8ee8f7c5cbc
MD5 a37307ee39db1b63183045360f3d56c6
BLAKE2b-256 04a463422696b291806eccd4c3b44862b6fc0edffb13b76b8f83dabd7968da01

See more details on using hashes here.

File details

Details for the file wikitree_api-0.1.0b1-py3-none-any.whl.

File metadata

  • Download URL: wikitree_api-0.1.0b1-py3-none-any.whl
  • Upload date:
  • Size: 20.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for wikitree_api-0.1.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 d0c411934cd3be2c032d246f88bc4b58f94460960071e8ff32a3286cf32918c3
MD5 7661d0feeb378ca0209de6a1633f0f38
BLAKE2b-256 0968b5a9cad3ec11c39b39a9ee459b3e875b3bb826b12e0c86c00064e2f19d3f

See more details on using hashes here.

Supported by

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