<a href='https://pypi.org/project/freshpy/'>
<img src="https://github.com/jeffshurtliff/freshpy/blob/main/docs/_static/freshpy-logo.png" width="100" />
</a>
# FreshPy
A Python toolset for utilizing the Freshservice API
<table>
<tr>
<td>Latest Stable Release</td>
<td>
<a href='https://pypi.org/project/freshpy/'>
<img alt="PyPI" src="https://img.shields.io/pypi/v/freshpy">
</a>
</td>
</tr>
<tr>
<td>Latest Dev/Beta/RC Release</td>
<td>
<a href='https://pypi.org/project/freshpy/#history'>
<img alt="PyPI" src="https://img.shields.io/badge/pypi-1.1.0b1-blue">
</a>
</td>
</tr>
<tr>
<td>Build Status</td>
<td>
N/A
<!--
<a href="https://github.com/jeffshurtliff/freshpy/blob/master/.github/workflows/pythonpackage.yml">
<img alt="GitHub Workflow Status"
src="https://img.shields.io/github/workflow/status/jeffshurtliff/freshpy/Python package">
</a>
-->
</td>
</tr>
<tr>
<td>Supported Versions</td>
<td>
<a href='https://pypi.org/project/freshpy/'>
<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/freshpy">
</a>
</td>
</tr>
<!--
<tr>
<td>Code Coverage</td>
<td>
<a href="https://codecov.io/gh/jeffshurtliff/freshpy">
<img src="https://codecov.io/gh/jeffshurtliff/freshpy/branch/master/graph/badge.svg" />
</a>
</td>
</tr>
<tr>
<td>Code Quality (LGTM)</td>
<td>
<a href="https://lgtm.com/projects/g/jeffshurtliff/freshpy">
<img alt="LGTM Grade" src="https://img.shields.io/lgtm/grade/python/github/jeffshurtliff/freshpy">
</a>
</td>
</tr>
<tr>
<td>CodeFactor Grade</td>
<td>
<a href="https://lgtm.com/projects/g/jeffshurtliff/freshpy">
<img alt="CodeFactor Grade" src="https://img.shields.io/codefactor/grade/github/jeffshurtliff/freshpy">
</a>
</td>
</tr>
-->
<tr>
<td>Documentation</td>
<td>
<a href='https://freshpy.readthedocs.io/en/latest/?badge=latest'>
<img src='https://readthedocs.org/projects/freshpy/badge/?version=latest' alt='Documentation Status' /><br />
</a>
</td>
</tr>
<!--
<tr>
<td>Security Audits</td>
<td>
<a href="https://github.com/marketplace/actions/python-security-check-using-bandit">
<img alt="Bandit" src="https://img.shields.io/badge/security-bandit-yellow.svg">
</a><br />
<a href="https://github.com/marketplace/actions/pycharm-python-security-scanner">
<img alt="PyCharm Security Scanner" src="https://img.shields.io/badge/security-pycharm%20security%20scanner-green">
</a>
</td>
</tr>
-->
<tr>
<td>License</td>
<td>
<a href="https://github.com/jeffshurtliff/freshpy/blob/master/LICENSE">
<img alt="License (GitHub)" src="https://img.shields.io/github/license/jeffshurtliff/freshpy">
</a>
</td>
</tr>
<tr>
<td style="vertical-align: top;">Issues</td>
<td>
<a href="https://github.com/jeffshurtliff/freshpy/issues">
<img style="margin-bottom:5px;" alt="GitHub open issues" src="https://img.shields.io/github/issues-raw/jeffshurtliff/freshpy"><br />
</a>
<a href="https://github.com/jeffshurtliff/freshpy/issues">
<img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed-raw/jeffshurtliff/freshpy">
</a>
</td>
</tr>
<tr>
<td style="vertical-align: top;">Pull Requests</td>
<td>
<a href="https://github.com/jeffshurtliff/freshpy/pulls">
<img style="margin-bottom:5px;" alt="GitHub pull open requests" src="https://img.shields.io/github/issues-pr-raw/jeffshurtliff/freshpy"><br />
</a>
<a href="https://github.com/jeffshurtliff/freshpy/pulls">
<img alt="GitHub closed pull requests" src="https://img.shields.io/github/issues-pr-closed-raw/jeffshurtliff/freshpy">
</a>
</td>
</tr>
</table>
## Installation
The package can be installed via pip using the syntax below.
```sh
pip install freshpy --upgrade
```
You may also clone the repository and install from source using below.
```sh
git clone git://github.com/jeffshurtliff/freshpy.git
cd freshpy/
python setup.py install
```
## Usage
This section provides basic usage instructions for the package.
### Importing the package
Rather than importing the base package, it is recommended that you import the primary `FreshPy` class using the syntax
below.
```python
from freshpy import FreshPy
```
### Initializing a FreshPy object instance
The primary `FreshPy` object serves many purposes, the most important being to establish a connection to the
Freshservice environment with which you intend to interact. As such, when initializing an instance of the `FreshPy`
object, you will need to pass it the Freshservice URL (e.g. `example.freshservice.com`) and the API key it will use
to authenticate so that the connection can be established.
#### Passing the information directly into the object
The domain and API key can be passed directly into the `FreshPy` object when initializing it, as
demonstrated in the example below.
```python
fresh = FreshPy(domain='example.freshservice.com', api_key='abc123DEF456')
```
### Interacting with the Freshservice API
Once the `FreshPy` object instance has been initialized, it can be leveraged to interact with a Freshservice
environment in many ways, which is fully documented in the official
[documentation](https://api.freshservice.com/). The example below demonstrates how information for a specific incident
ticket can be retrieved in JSON format.
```python
ticket_data = fresh.tickets.get_ticket(1299)
```
## License
[MIT License](https://github.com/jeffshurtliff/freshpy/blob/master/LICENSE)
## Changelog
Refer to the [changelog](https://freshpy.readthedocs.io/en/latest/changelog.html) for version change information.
## Reporting Issues
Issues can be reported within the [GitHub repository](https://github.com/jeffshurtliff/freshpy/issues).
## Additional Resources
Additional resources for leveraging the Freshservice API can be found in the official
[Freshservice API Reference Documentation](https://api.freshservice.com/).
## Donations
If you would like to donate to this project then you can do so using
[this PayPal link](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=XDZ8M6UV6EFK6&item_name=FreshPy¤cy_code=USD).
## Disclaimer
This package is considered unofficial and is in no way endorsed or supported by
[Freshservice](https://www.freshservice.com).
Raw data
{
"_id": null,
"home_page": "https://github.com/jeffshurtliff/freshpy",
"name": "freshpy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Jeff Shurtliff",
"author_email": "jeff.shurtliff@rsa.com",
"download_url": "https://files.pythonhosted.org/packages/85/d4/53cb26de2a6835e372c62504de87b527c6e8fbccc41c27cc8286894f36de/freshpy-1.1.1.tar.gz",
"platform": null,
"description": "<a href='https://pypi.org/project/freshpy/'>\n <img src=\"https://github.com/jeffshurtliff/freshpy/blob/main/docs/_static/freshpy-logo.png\" width=\"100\" />\n</a>\n\n# FreshPy\nA Python toolset for utilizing the Freshservice API\n\n<table>\n <tr>\n <td>Latest Stable Release</td>\n <td>\n <a href='https://pypi.org/project/freshpy/'>\n <img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/freshpy\">\n </a>\n </td>\n </tr>\n <tr>\n <td>Latest Dev/Beta/RC Release</td>\n <td>\n <a href='https://pypi.org/project/freshpy/#history'>\n <img alt=\"PyPI\" src=\"https://img.shields.io/badge/pypi-1.1.0b1-blue\">\n </a>\n </td>\n </tr>\n <tr>\n <td>Build Status</td>\n <td>\n N/A\n <!--\n <a href=\"https://github.com/jeffshurtliff/freshpy/blob/master/.github/workflows/pythonpackage.yml\">\n <img alt=\"GitHub Workflow Status\" \n src=\"https://img.shields.io/github/workflow/status/jeffshurtliff/freshpy/Python package\">\n </a>\n -->\n </td>\n </tr>\n <tr>\n <td>Supported Versions</td>\n <td>\n <a href='https://pypi.org/project/freshpy/'>\n <img alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/freshpy\">\n </a>\n </td>\n </tr>\n <!--\n <tr>\n <td>Code Coverage</td>\n <td>\n <a href=\"https://codecov.io/gh/jeffshurtliff/freshpy\">\n <img src=\"https://codecov.io/gh/jeffshurtliff/freshpy/branch/master/graph/badge.svg\" />\n </a>\n </td>\n </tr>\n <tr>\n <td>Code Quality (LGTM)</td>\n <td>\n <a href=\"https://lgtm.com/projects/g/jeffshurtliff/freshpy\">\n <img alt=\"LGTM Grade\" src=\"https://img.shields.io/lgtm/grade/python/github/jeffshurtliff/freshpy\">\n </a>\n </td>\n </tr>\n <tr>\n <td>CodeFactor Grade</td>\n <td>\n <a href=\"https://lgtm.com/projects/g/jeffshurtliff/freshpy\">\n <img alt=\"CodeFactor Grade\" src=\"https://img.shields.io/codefactor/grade/github/jeffshurtliff/freshpy\">\n </a>\n </td>\n </tr>\n -->\n <tr>\n <td>Documentation</td>\n <td>\n <a href='https://freshpy.readthedocs.io/en/latest/?badge=latest'>\n <img src='https://readthedocs.org/projects/freshpy/badge/?version=latest' alt='Documentation Status' /><br />\n </a>\n </td>\n </tr>\n <!--\n <tr>\n <td>Security Audits</td>\n <td>\n <a href=\"https://github.com/marketplace/actions/python-security-check-using-bandit\">\n <img alt=\"Bandit\" src=\"https://img.shields.io/badge/security-bandit-yellow.svg\">\n </a><br />\n <a href=\"https://github.com/marketplace/actions/pycharm-python-security-scanner\">\n <img alt=\"PyCharm Security Scanner\" src=\"https://img.shields.io/badge/security-pycharm%20security%20scanner-green\">\n </a>\n </td>\n </tr>\n -->\n <tr>\n <td>License</td>\n <td>\n <a href=\"https://github.com/jeffshurtliff/freshpy/blob/master/LICENSE\">\n <img alt=\"License (GitHub)\" src=\"https://img.shields.io/github/license/jeffshurtliff/freshpy\">\n </a>\n </td>\n </tr>\n <tr>\n <td style=\"vertical-align: top;\">Issues</td>\n <td>\n <a href=\"https://github.com/jeffshurtliff/freshpy/issues\">\n <img style=\"margin-bottom:5px;\" alt=\"GitHub open issues\" src=\"https://img.shields.io/github/issues-raw/jeffshurtliff/freshpy\"><br />\n </a>\n <a href=\"https://github.com/jeffshurtliff/freshpy/issues\">\n <img alt=\"GitHub closed issues\" src=\"https://img.shields.io/github/issues-closed-raw/jeffshurtliff/freshpy\">\n </a>\n </td>\n </tr>\n <tr>\n <td style=\"vertical-align: top;\">Pull Requests</td>\n <td>\n <a href=\"https://github.com/jeffshurtliff/freshpy/pulls\">\n <img style=\"margin-bottom:5px;\" alt=\"GitHub pull open requests\" src=\"https://img.shields.io/github/issues-pr-raw/jeffshurtliff/freshpy\"><br />\n </a>\n <a href=\"https://github.com/jeffshurtliff/freshpy/pulls\">\n <img alt=\"GitHub closed pull requests\" src=\"https://img.shields.io/github/issues-pr-closed-raw/jeffshurtliff/freshpy\">\n </a>\n </td>\n </tr>\n</table>\n\n## Installation\nThe package can be installed via pip using the syntax below.\n\n```sh\npip install freshpy --upgrade\n```\n\nYou may also clone the repository and install from source using below.\n\n```sh\ngit clone git://github.com/jeffshurtliff/freshpy.git\ncd freshpy/\npython setup.py install\n```\n\n## Usage\nThis section provides basic usage instructions for the package.\n\n### Importing the package\nRather than importing the base package, it is recommended that you import the primary `FreshPy` class using the syntax\nbelow.\n\n```python\nfrom freshpy import FreshPy\n```\n\n### Initializing a FreshPy object instance\nThe primary `FreshPy` object serves many purposes, the most important being to establish a connection to the \nFreshservice environment with which you intend to interact. As such, when initializing an instance of the `FreshPy` \nobject, you will need to pass it the Freshservice URL (e.g. `example.freshservice.com`) and the API key it will use \nto authenticate so that the connection can be established.\n\n#### Passing the information directly into the object\nThe domain and API key can be passed directly into the `FreshPy` object when initializing it, as\ndemonstrated in the example below.\n\n```python\nfresh = FreshPy(domain='example.freshservice.com', api_key='abc123DEF456')\n```\n\n### Interacting with the Freshservice API\nOnce the `FreshPy` object instance has been initialized, it can be leveraged to interact with a Freshservice\nenvironment in many ways, which is fully documented in the official\n[documentation](https://api.freshservice.com/). The example below demonstrates how information for a specific incident \nticket can be retrieved in JSON format.\n\n```python\nticket_data = fresh.tickets.get_ticket(1299)\n```\n\n## License\n[MIT License](https://github.com/jeffshurtliff/freshpy/blob/master/LICENSE)\n\n## Changelog\nRefer to the [changelog](https://freshpy.readthedocs.io/en/latest/changelog.html) for version change information.\n\n## Reporting Issues\nIssues can be reported within the [GitHub repository](https://github.com/jeffshurtliff/freshpy/issues).\n\n## Additional Resources\nAdditional resources for leveraging the Freshservice API can be found in the official\n[Freshservice API Reference Documentation](https://api.freshservice.com/).\n\n## Donations\nIf you would like to donate to this project then you can do so using \n[this PayPal link](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=XDZ8M6UV6EFK6&item_name=FreshPy¤cy_code=USD).\n\n## Disclaimer\nThis package is considered unofficial and is in no way endorsed or supported by \n[Freshservice](https://www.freshservice.com).\n\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A Python toolset for utilizing the Freshservice API",
"version": "1.1.1",
"project_urls": {
"Change Log": "https://freshpy.readthedocs.io/en/latest/changelog.html",
"Homepage": "https://github.com/jeffshurtliff/freshpy",
"Issue Tracker": "https://github.com/jeffshurtliff/freshpy/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "85d453cb26de2a6835e372c62504de87b527c6e8fbccc41c27cc8286894f36de",
"md5": "11f8c8ba27979979d739f572ce9b51c4",
"sha256": "42f2a8b32e1b6489b533db68f40825b4b3fbfabbf2c8a7500b8cb54530a185a2"
},
"downloads": -1,
"filename": "freshpy-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "11f8c8ba27979979d739f572ce9b51c4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 17471,
"upload_time": "2023-05-08T22:00:46",
"upload_time_iso_8601": "2023-05-08T22:00:46.357686Z",
"url": "https://files.pythonhosted.org/packages/85/d4/53cb26de2a6835e372c62504de87b527c6e8fbccc41c27cc8286894f36de/freshpy-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-08 22:00:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jeffshurtliff",
"github_project": "freshpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "freshpy"
}
JSON
