pir-client

Name	pir-client JSON
Version	1.2.1 JSON
	download
home_page	https://github.com/uktrade/invest-pir-api-client
Summary	API client for PIR
upload_time	2023-05-25 10:34:33
maintainer
docs_url	None
author	Department for International Trade
requires_python
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage

            # Invest PIR API Client
[![CircleCI](https://circleci.com/gh/uktrade/invest-pir-api-client.svg?style=svg)](https://circleci.com/gh/uktrade/invest-pir-api-client)
[![codecov](https://codecov.io/gh/uktrade/invest-pir-api-client/branch/master/graph/badge.svg)](https://codecov.io/gh/uktrade/invest-pir-api-client)
[![PyPI](https://img.shields.io/pypi/v/pir-client.svg)](https://pypi.org/project/pir-client/)


Client for the PIR service (yet to be deployed)

## Example 

    from pir_client.client import PIRAPIClient

    client = PIRAPIClient(
        base_url=settings.PIR_API_URL,
        api_key=settings.PIR_API_KEY
    )

    # Creates report and sends email
    client.create_report({
        'name': 'test',
        'sector': 'tech',
        'market': 'usa',
        'company': 'Acme',
        'email': 'foo@acme.com'
    })

## Install 

    pip install invest-pir-api-client



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/uktrade/invest-pir-api-client",
    "name": "pir-client",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Department for International Trade",
    "author_email": "",
    "download_url": "",
    "platform": null,
    "description": "# Invest PIR API Client\n[![CircleCI](https://circleci.com/gh/uktrade/invest-pir-api-client.svg?style=svg)](https://circleci.com/gh/uktrade/invest-pir-api-client)\n[![codecov](https://codecov.io/gh/uktrade/invest-pir-api-client/branch/master/graph/badge.svg)](https://codecov.io/gh/uktrade/invest-pir-api-client)\n[![PyPI](https://img.shields.io/pypi/v/pir-client.svg)](https://pypi.org/project/pir-client/)\n\n\nClient for the PIR service (yet to be deployed)\n\n## Example \n\n    from pir_client.client import PIRAPIClient\n\n    client = PIRAPIClient(\n        base_url=settings.PIR_API_URL,\n        api_key=settings.PIR_API_KEY\n    )\n\n    # Creates report and sends email\n    client.create_report({\n        'name': 'test',\n        'sector': 'tech',\n        'market': 'usa',\n        'company': 'Acme',\n        'email': 'foo@acme.com'\n    })\n\n## Install \n\n    pip install invest-pir-api-client\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "API client for PIR",
    "version": "1.2.1",
    "project_urls": {
        "Homepage": "https://github.com/uktrade/invest-pir-api-client"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d8a69ca70149cdfda5704d7e9c73b81001c6f51f07ec20579fa91913dc29f96c",
                "md5": "4734f6f5226e11650bfb8d384bc4f00b",
                "sha256": "11faa4ca71d2fd0ffabaa026079c25d68fb4db9ea8023860a74dbf71dfcd3fee"
            },
            "downloads": -1,
            "filename": "pir_client-1.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4734f6f5226e11650bfb8d384bc4f00b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 3265,
            "upload_time": "2023-05-25T10:34:33",
            "upload_time_iso_8601": "2023-05-25T10:34:33.739206Z",
            "url": "https://files.pythonhosted.org/packages/d8/a6/9ca70149cdfda5704d7e9c73b81001c6f51f07ec20579fa91913dc29f96c/pir_client-1.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-25 10:34:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "uktrade",
    "github_project": "invest-pir-api-client",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": false,
    "circle": true,
    "lcname": "pir-client"
}