Simple python wrapper for Companies House API
Project description
COMPANIES HOUSE API Client
This is a Python client for the COMPANIES HOUSE API
Installation
You can install the package into your project via pip:
pip install companies_house_api_client
USAGE
To use the COMPANIES HOUSE API client, you first need to set up environment variables for the required credentials:
export COMPANIES_HOUSE_APIKEY=your-api-key
export COMPANIES_HOUSE_HOST=https://api.company-information.service.gov.uk
EXAMPLE
By setting the test parameter to true, you can play arround with api:
from companies_house_api_client import CompaniesHouse
# Create a Companies House API client instance
ch = CompaniesHouse()
# Call an API method
companies = ch.get_company_profile("12312312")
TESTS
Make sure pytest is installed on your environment
python3 -m pytest
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
File details
Details for the file companies_house_api_client-0.0.4.tar.gz
.
File metadata
- Download URL: companies_house_api_client-0.0.4.tar.gz
- Upload date:
- Size: 6.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 694528fdb4cb16464919bfcc0deb1c67b32c92a1ebf38954497723ea0eea65a8 |
|
MD5 | 929156045639c15025a8fad414cadebc |
|
BLAKE2b-256 | 4e2b87c606f8d61464a6781d893a090973979ff6ed134bac7e81a7ef1fb7015a |