%global _empty_manifest_terminate_build 0 Name: python-Jepy Version: 1.0.0 Release: 1 Summary: A simple Python wrapper to access the Johns Eastern Company API. License: GNU General Public License v3 (GPLv3) URL: https://github.com/JECO/jepy Source0: https://mirrors.aliyun.com/pypi/web/packages/bf/c4/72f6f5c41efd1fc755e9d4194d19cf4176006416a34ded3429df6bb1928f/Jepy-1.0.0.tar.gz BuildArch: noarch Requires: python3-quick-rest Requires: python3-dicttoxml %description # Jepy A simple Python wrapper to access the Johns Eastern Company API. ## Installation To get Jepy on your machine, ensure you're running Python 3.7 or higher and use `pip install jepy`. (Note that it will almost definitely work on Python 3.4+ and will likely work on any version of Python 3 or higher but has not been tested below 3.7). ## Getting Started Jepy is designed to handle the JWT authentication required by the API for you easily. Import Jepy and set up the client. ```python from jepy import Jepy creds = {'user_id': '0123456789', 'password': '0123456789876543210'} client = Jepy(**creds) ``` Then use the client you've set up to make calls. ```python client.claims(claim_num = '012345') ``` ### Usage Jepy supports all endpoints of the API. See the [wiki](https://github.com/JECO/jepy/wiki) for detailed information. For information on the API itself, see the [API wiki](https://github.com/JECO/jeapi-docs/wiki). ### Interpreting Results ***Changed as of version 1.0.0*** All responses return a `JepyServerResponse` object which inherits from the `quick_rest.ServerResponse` object. This object has methods that allow you to easily manipulate data. You can use `JepyServerResponse.decode()` to get the response content directly. The API answers calls by dumping results into a JSON file with one of three keys. Jepy handles these as follows: * Results - Returns a dictionary keyed as 'results', value will be a list of dictionaries. * Message - Like results, this returns a dictionary keyed as 'message', the value is a message from the server that is not an error. Most often this means no results were found. * Error - May raise an exception in certain cases. Usually indicates authentication failed, the request syntax is bad, or the server is down. ## Troubleshooting If you're continuously getting errors, check the status of the server to ensure it is up. __Simply checking server status does not require authentication__ (and is the only command that does not). Run `print(Jepy())` with no arguments. You'll either get `JEAPI is up.` or an exception. (Note that if you do try to check status with credentials a la `print(Jepy(**creds))` you will get the object). If the server is up, your credentials may be invalid and you should contact the [Johns Eastern Helpdesk](https://je.zendesk.com/hc/en-us/requests/new) for assistance. You can also [click here](https://je-api.com/) to see if the server is up, too. ## Operating System This package is operating system agnostic. It has been tested on Windows 10 and Ubuntu 19.10. ## Dependencies ***Changed as of version 1.0.0*** Jepy no longer makes calls with [`requests`](https://pypi.org/project/requests/) directly, it relies on [`quick_rest`](https://github.com/LamerLink/quick_rest) which in turn uses `requests` but does some error handling and provides results in an easily manipulated way. To allow conversion of JSON results to XML via `JepyServerResponse.to_xml`, [`dicttoxml`](https://github.com/quandyfactory/dicttoxml) is required. All dependencies are installed automatically during setup. ## Bug Reports/Feature Requests To report a bug, please use the "New issue" button on the project's [Issues page](https://github.com/JECO/jepy/issues). You may also contact the help desk below to report bugs. Please submit a ticket at the [Johns Eastern Helpdesk](https://je.zendesk.com/hc/en-us/requests/new) for all feature requests. Note that features that require changes to the API itself may not require any update in the wrapper (such as a change to a query). In this case, the branch will not be public and will exist under the API's repository. ## License This project is licensed under the GNU General Public License v3.0. Please see the [LICENSE.md](LICENSE.md) file for details. %package -n python3-Jepy Summary: A simple Python wrapper to access the Johns Eastern Company API. Provides: python-Jepy BuildRequires: python3-devel BuildRequires: python3-setuptools BuildRequires: python3-pip %description -n python3-Jepy # Jepy A simple Python wrapper to access the Johns Eastern Company API. ## Installation To get Jepy on your machine, ensure you're running Python 3.7 or higher and use `pip install jepy`. (Note that it will almost definitely work on Python 3.4+ and will likely work on any version of Python 3 or higher but has not been tested below 3.7). ## Getting Started Jepy is designed to handle the JWT authentication required by the API for you easily. Import Jepy and set up the client. ```python from jepy import Jepy creds = {'user_id': '0123456789', 'password': '0123456789876543210'} client = Jepy(**creds) ``` Then use the client you've set up to make calls. ```python client.claims(claim_num = '012345') ``` ### Usage Jepy supports all endpoints of the API. See the [wiki](https://github.com/JECO/jepy/wiki) for detailed information. For information on the API itself, see the [API wiki](https://github.com/JECO/jeapi-docs/wiki). ### Interpreting Results ***Changed as of version 1.0.0*** All responses return a `JepyServerResponse` object which inherits from the `quick_rest.ServerResponse` object. This object has methods that allow you to easily manipulate data. You can use `JepyServerResponse.decode()` to get the response content directly. The API answers calls by dumping results into a JSON file with one of three keys. Jepy handles these as follows: * Results - Returns a dictionary keyed as 'results', value will be a list of dictionaries. * Message - Like results, this returns a dictionary keyed as 'message', the value is a message from the server that is not an error. Most often this means no results were found. * Error - May raise an exception in certain cases. Usually indicates authentication failed, the request syntax is bad, or the server is down. ## Troubleshooting If you're continuously getting errors, check the status of the server to ensure it is up. __Simply checking server status does not require authentication__ (and is the only command that does not). Run `print(Jepy())` with no arguments. You'll either get `JEAPI is up.` or an exception. (Note that if you do try to check status with credentials a la `print(Jepy(**creds))` you will get the object). If the server is up, your credentials may be invalid and you should contact the [Johns Eastern Helpdesk](https://je.zendesk.com/hc/en-us/requests/new) for assistance. You can also [click here](https://je-api.com/) to see if the server is up, too. ## Operating System This package is operating system agnostic. It has been tested on Windows 10 and Ubuntu 19.10. ## Dependencies ***Changed as of version 1.0.0*** Jepy no longer makes calls with [`requests`](https://pypi.org/project/requests/) directly, it relies on [`quick_rest`](https://github.com/LamerLink/quick_rest) which in turn uses `requests` but does some error handling and provides results in an easily manipulated way. To allow conversion of JSON results to XML via `JepyServerResponse.to_xml`, [`dicttoxml`](https://github.com/quandyfactory/dicttoxml) is required. All dependencies are installed automatically during setup. ## Bug Reports/Feature Requests To report a bug, please use the "New issue" button on the project's [Issues page](https://github.com/JECO/jepy/issues). You may also contact the help desk below to report bugs. Please submit a ticket at the [Johns Eastern Helpdesk](https://je.zendesk.com/hc/en-us/requests/new) for all feature requests. Note that features that require changes to the API itself may not require any update in the wrapper (such as a change to a query). In this case, the branch will not be public and will exist under the API's repository. ## License This project is licensed under the GNU General Public License v3.0. Please see the [LICENSE.md](LICENSE.md) file for details. %package help Summary: Development documents and examples for Jepy Provides: python3-Jepy-doc %description help # Jepy A simple Python wrapper to access the Johns Eastern Company API. ## Installation To get Jepy on your machine, ensure you're running Python 3.7 or higher and use `pip install jepy`. (Note that it will almost definitely work on Python 3.4+ and will likely work on any version of Python 3 or higher but has not been tested below 3.7). ## Getting Started Jepy is designed to handle the JWT authentication required by the API for you easily. Import Jepy and set up the client. ```python from jepy import Jepy creds = {'user_id': '0123456789', 'password': '0123456789876543210'} client = Jepy(**creds) ``` Then use the client you've set up to make calls. ```python client.claims(claim_num = '012345') ``` ### Usage Jepy supports all endpoints of the API. See the [wiki](https://github.com/JECO/jepy/wiki) for detailed information. For information on the API itself, see the [API wiki](https://github.com/JECO/jeapi-docs/wiki). ### Interpreting Results ***Changed as of version 1.0.0*** All responses return a `JepyServerResponse` object which inherits from the `quick_rest.ServerResponse` object. This object has methods that allow you to easily manipulate data. You can use `JepyServerResponse.decode()` to get the response content directly. The API answers calls by dumping results into a JSON file with one of three keys. Jepy handles these as follows: * Results - Returns a dictionary keyed as 'results', value will be a list of dictionaries. * Message - Like results, this returns a dictionary keyed as 'message', the value is a message from the server that is not an error. Most often this means no results were found. * Error - May raise an exception in certain cases. Usually indicates authentication failed, the request syntax is bad, or the server is down. ## Troubleshooting If you're continuously getting errors, check the status of the server to ensure it is up. __Simply checking server status does not require authentication__ (and is the only command that does not). Run `print(Jepy())` with no arguments. You'll either get `JEAPI is up.` or an exception. (Note that if you do try to check status with credentials a la `print(Jepy(**creds))` you will get the object). If the server is up, your credentials may be invalid and you should contact the [Johns Eastern Helpdesk](https://je.zendesk.com/hc/en-us/requests/new) for assistance. You can also [click here](https://je-api.com/) to see if the server is up, too. ## Operating System This package is operating system agnostic. It has been tested on Windows 10 and Ubuntu 19.10. ## Dependencies ***Changed as of version 1.0.0*** Jepy no longer makes calls with [`requests`](https://pypi.org/project/requests/) directly, it relies on [`quick_rest`](https://github.com/LamerLink/quick_rest) which in turn uses `requests` but does some error handling and provides results in an easily manipulated way. To allow conversion of JSON results to XML via `JepyServerResponse.to_xml`, [`dicttoxml`](https://github.com/quandyfactory/dicttoxml) is required. All dependencies are installed automatically during setup. ## Bug Reports/Feature Requests To report a bug, please use the "New issue" button on the project's [Issues page](https://github.com/JECO/jepy/issues). You may also contact the help desk below to report bugs. Please submit a ticket at the [Johns Eastern Helpdesk](https://je.zendesk.com/hc/en-us/requests/new) for all feature requests. Note that features that require changes to the API itself may not require any update in the wrapper (such as a change to a query). In this case, the branch will not be public and will exist under the API's repository. ## License This project is licensed under the GNU General Public License v3.0. Please see the [LICENSE.md](LICENSE.md) file for details. %prep %autosetup -n Jepy-1.0.0 %build %py3_build %install %py3_install install -d -m755 %{buildroot}/%{_pkgdocdir} if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi pushd %{buildroot} if [ -d usr/lib ]; then find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst fi if [ -d usr/lib64 ]; then find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst fi if [ -d usr/bin ]; then find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst fi if [ -d usr/sbin ]; then find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst fi touch doclist.lst if [ -d usr/share/man ]; then find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst fi popd mv %{buildroot}/filelist.lst . mv %{buildroot}/doclist.lst . %files -n python3-Jepy -f filelist.lst %dir %{python3_sitelib}/* %files help -f doclist.lst %{_docdir}/* %changelog * Tue Jun 20 2023 Python_Bot - 1.0.0-1 - Package Spec generated