Skip to main content

A Python wrapper for the Breathe HR API

Project description

python-breathe

A Python wrapper for the Breathe HR API.

Installation

pip install python-breathe

Usage

>>> from breathe.client import Client
>>> c = Client(api_key="123456", mode="sandbox")
>>> c.employees.all()
[{'length_of_service_in_months': 0, 'age': None, 'full_or_part_time': None, 'notice_period': None, 'photo_url': '', 'working_pattern': {'id': 2842, 'name': 'standard working week', 'total_hours': '37.5', 'default': True}, 'holiday_allowance': {'name': 'standard holiday allowance', 'id': 2913}, 'line_manager': None, 'holiday_approver': None, 'department': None, 'division': None, 'location': None, 'gender': None, 'statutory_holiday_country': None, 'receives_statutory_holidays': False, 'salary': None, 'status': 'Current employee', 'job_start_date': None, 'job_title': None, 'hr': True, 'custom_fields': None, 'id': 1795, 'account_id': 798, 'first_name': 'Joe', 'middle_name': None, 'last_name': 'Bloggs', 'email': 'jbloggs@acme.com', 'join_date': None, 'dob': None, 'known_as': None, 'marital_status': None, 'nationality': None, 'ethnicity': None, 'national_insurance_no': None, 'driving_license': None, 'ddi': None, 'work_ext': None, 'work_mobile': None, 'personal_mobile': None, 'home_telephone': None, 'personal_email': None, 'address1': None, 'address2': None, 'address3': None, 'city': None, 'county': None, 'postcode': None, 'country': None, 'linked_in': None, 'facebook': None, 'skype': None, 'twitter': None, 'bank_name': None, 'bank_branch': None, 'sort_code': None, 'account_number': None, 'building_society': None, 'ref_number': None, 'leaving_date': None, 'employee_ref': None, 'contract_provider': None, 'probation_date': None, 'remuneration_currency': {'id': 2, 'currency_code': 'GBP', 'currency_symbol': '£', 'description': 'British Pound', 'created_at': None, 'updated_at': None, 'deleted_at': None}, 'created_at': '2018-03-22T11:12:02+00:00', 'updated_at': '2018-03-22T11:12:02+00:00'},]
>>> c.employees.get(1795)
{'length_of_service_in_months': 0, 'age': None, 'full_or_part_time': None, 'notice_period': None, 'photo_url': '', 'working_pattern': {'id': 2842, 'name': 'standard working week', 'total_hours': '37.5', 'default': True}, 'holiday_allowance': {'name': 'standard holiday allowance', 'id': 2913}, 'line_manager': None, 'holiday_approver': None, 'department': None, 'division': None, 'location': None, 'gender': None, 'statutory_holiday_country': None, 'receives_statutory_holidays': False, 'salary': None, 'status': 'Current employee', 'job_start_date': None, 'job_title': None, 'hr': True, 'custom_fields': None, 'id': 1795, 'account_id': 798, 'first_name': 'Joe', 'middle_name': None, 'last_name': 'Bloggs', 'email': 'jbloggs@acme.com', 'join_date': None, 'dob': None, 'known_as': None, 'marital_status': None, 'nationality': None, 'ethnicity': None, 'national_insurance_no': None, 'driving_license': None, 'ddi': None, 'work_ext': None, 'work_mobile': None, 'personal_mobile': None, 'home_telephone': None, 'personal_email': None, 'address1': None, 'address2': None, 'address3': None, 'city': None, 'county': None, 'postcode': None, 'country': None, 'linked_in': None, 'facebook': None, 'skype': None, 'twitter': None, 'bank_name': None, 'bank_branch': None, 'sort_code': None, 'account_number': None, 'building_society': None, 'ref_number': None, 'leaving_date': None, 'employee_ref': None, 'contract_provider': None, 'probation_date': None, 'remuneration_currency': {'id': 2, 'currency_code': 'GBP', 'currency_symbol': '£', 'description': 'British Pound', 'created_at': None, 'updated_at': None, 'deleted_at': None}, 'created_at': '2018-03-22T11:12:02+00:00', 'updated_at': '2018-03-22T11:12:02+00:00'}
>>> c.employees.count()
1
>>> c.employees.create({"first_name": "Pete", "last_name":"Smith", "email": "psmith@acme.com", "join_date": "01/01/2000"})

Supported Objects and Methods

  • Employees
    • get()
    • create()
    • all()

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

python_breathe-0.0.2.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

python_breathe-0.0.2-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file python_breathe-0.0.2.tar.gz.

File metadata

  • Download URL: python_breathe-0.0.2.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0

File hashes

Hashes for python_breathe-0.0.2.tar.gz
Algorithm Hash digest
SHA256 72c229f929169c41b67dca9aaf9d0940b05935d731a6e390855478912f89bee0
MD5 6bfd1a5793c01673674db92ab2129523
BLAKE2b-256 c23829048958f58af1541a18205a1bb5b49c9a4dc26141aa63b3dc34c253860b

See more details on using hashes here.

File details

Details for the file python_breathe-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: python_breathe-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0

File hashes

Hashes for python_breathe-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 aabecc53196cb5d512fe72da9fe66f168fc5aa1ea85309bcf2ede8a51ef0a471
MD5 fc15fa0ef7dd6b51ef0e5793a5c3cf1d
BLAKE2b-256 15d91cc5ae17973614245cf7b455ef22b704a7caca62de571bbd4d5713806e6b

See more details on using hashes here.

Supported by

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