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
Metadata
Release files for companies-house-api-client 0.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| companies_house_api_client-0.0.4.tar.gz | 6.6 kB | Without provenance | Details for companies_house_api_client-0.0.4.tar.gz |
Release files / companies_house_api_client-0.0.4.tar.gz
| Download URL | companies_house_api_client-0.0.4.tar.gz |
|---|---|
| Size | 6.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
694528fdb4cb16464919bfcc0deb1c67b32c92a1ebf38954497723ea0eea65a8
|
|
BLAKE2b-256 checksum How to use checksums |
4e2b87c606f8d61464a6781d893a090973979ff6ed134bac7e81a7ef1fb7015a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Security for companies-house-api-client 0.0.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.