Skip to main content

Client library for the Affinda API

Project description

Python Client Library for Affinda Resume Parser API

affinda logo

pypi ver pypi pyver pypi dlm license

codestyle

Open in Visual Studio Code

This is a python client for the Affinda document parsing API which wraps all available endpoints and handles authentication and signing. You may also want to refer to the full API documentation for additional information.

Installation

pip install affinda

Quickstart

If you don't have an API token, obtain one from affinda.com.

from affinda import AffindaAPI, TokenCredential

credential = TokenCredential(token="YOUR_API_TOKEN")
client = AffindaAPI(credential=credential)

with open("PATH_TO_FILE", "rb") as f:
    resume = client.create_resume(file=f)

Samples

Samples for all operations using the client can be found here.

API reference

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

[0.1.11] - 2021-10-05

Changed

  • Pinning azure-core dependency due to incompatible changes in 1.19

[0.1.10] - 2021-09-30

Added

  • Adding LinkedIn to ResumeData

Changed

  • Reformatted code with black
  • Minor changes
  • Very minor formatting changes

[0.1.9] - 2021-09-08

Added

  • Profession in ResumeData model
  • Unified Error models

[0.1.8] - 2021-09-06

Fixed

  • wait=true in API spec

[0.1.7] - 2021-09-05

Fixed

  • Code samples naming conversion

[0.1.6] - 2021-09-05

Changed

[0.1.5] - 2021-08-25

Added

  • Added flake, editorconfig, tox.ini etc files to match best practices for existing Draftable/Affinda projects (thanks
  • @ralish!)

[0.1.4] - 2021-08-18

Fixed

  • Update README.md to fix install instructions

[0.1.3] - 2021-08-18

Fixed

  • Update README.md to hard link to github hosted logo to fix display on PyPi

[0.1.2] - 2021-08-18

  • Initial release

The MIT License (MIT)

Copyright (c) Affinda

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.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

affinda-0.1.11.tar.gz (63.2 kB view details)

Uploaded Source

Built Distribution

affinda-0.1.11-py3-none-any.whl (31.2 kB view details)

Uploaded Python 3

File details

Details for the file affinda-0.1.11.tar.gz.

File metadata

  • Download URL: affinda-0.1.11.tar.gz
  • Upload date:
  • Size: 63.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.5

File hashes

Hashes for affinda-0.1.11.tar.gz
Algorithm Hash digest
SHA256 72405880e3e696b7b7f8544a0b745e19c37bddb7ecb56dc80276cba66f7bf005
MD5 a9a362b11a445c3fca2cf2bad53fa29c
BLAKE2b-256 e7826b8d1a8f95f2b72e3cf19592e0b4c109941fb78d0fded766e967a30166a4

See more details on using hashes here.

File details

Details for the file affinda-0.1.11-py3-none-any.whl.

File metadata

  • Download URL: affinda-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 31.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.5

File hashes

Hashes for affinda-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 bd212222d575aaaf4990708ab8ce845c1c2537e7cf6c36dd0b88559e022c1e18
MD5 d1a4120d0e24e5698a0526322dafdb81
BLAKE2b-256 cbd4eea4f862482d33a368b263ad25a6329058598072cde59ac77695f4806011

See more details on using hashes here.

Supported by

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