Skip to content

Commit 38fc248

Browse files
Ronald LangeveldRonald Langeveld
Ronald Langeveld
authored and
Ronald Langeveld
committed
renamed a lot to publish it
1 parent 145f246 commit 38fc248

File tree

7 files changed

+79
-51
lines changed

7 files changed

+79
-51
lines changed

‎LICENSE

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
MIT License
2+
Copyright (c) 2021 Ronald Langeveld
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is
8+
furnished to do so, subject to the following conditions:
9+
The above copyright notice and this permission notice shall be included in all
10+
copies or substantial portions of the Software.
11+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17+
SOFTWARE.

‎README.md

Lines changed: 2 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,4 @@
1-
# Python Wrapper for the Fiix CMMS API
1+
# Fiix CMMS client for JavaScript
22

3-
A simple wrapper for the Fiix CMMS API in Python.
4-
5-
## Description
6-
7-
An in-depth paragraph about your project and overview of use.
8-
9-
## Getting Started
10-
11-
### Dependencies
12-
13-
* Describe any prerequisites, libraries, OS version, etc., needed before installing program.
14-
* ex. Windows 10
15-
16-
### Installing
17-
18-
* How/where to download your program
19-
* Any modifications needed to be made to files/folders
20-
21-
### Executing program
22-
23-
* How to run the program
24-
* Step-by-step bullets
25-
```
26-
code blocks for commands
27-
```
28-
29-
## Help
30-
31-
Any advise for common problems or issues.
32-
```
33-
command to run if program contains helper info
34-
```
35-
36-
## Version History
37-
38-
* 0.1
39-
* Initial Release
40-
41-
## License
42-
43-
This project is licensed under the MIT License - see the LICENSE file for details
3+
The unofficial [Fiix CMMS](https://www.fiixsoftware.com) client for Python.
444

‎client/__init__.py renamed to ‎fiixclient/__init__.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@
33
"""
44
woocommerce
55
~~~~~~~~~~~~~~~
6-
A Python wrapper for WooCommerce API.
7-
:copyright: (c) 2019 by Automattic.
6+
A Python wrapper for the Fiix CMMS API
7+
:copyright: (c) 2021 by Ronald Langeved.
88
:license: MIT, see LICENSE for details.
99
"""
1010

1111
__title__ = "python fiix client"
1212
__version__ = "1.0.0"
1313
__author__ = "Ronald Langeveld"
14-
__license__ = "MIT"
14+
__license__ = "MIT"
15+
16+
from fiixclient.client import FiixClient

‎client/fiix.py renamed to ‎fiixclient/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import json
55

66

7-
class Client(object):
7+
class FiixClient(object):
88
def __init__(self, subdomain, api_key, access_key, api_secret, version):
99
self.version = version
1010
self.subdomain = subdomain

‎requirements.txt

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
autopep8==1.5.7
2+
bleach==4.1.0
3+
certifi==2021.5.30
4+
charset-normalizer==2.0.4
5+
colorama==0.4.4
6+
docutils==0.17.1
7+
idna==3.2
8+
importlib-metadata==4.8.0
9+
keyring==23.1.0
10+
packaging==21.0
11+
pkginfo==1.7.1
12+
pycodestyle==2.7.0
13+
Pygments==2.10.0
14+
pyparsing==2.4.7
15+
python-dotenv==0.19.0
16+
readme-renderer==29.0
17+
requests==2.26.0
18+
requests-toolbelt==0.9.1
19+
rfc3986==1.5.0
20+
six==1.16.0
21+
toml==0.10.2
22+
tqdm==4.62.2
23+
twine==3.4.2
24+
urllib3==1.26.6
25+
webencodings==0.5.1
26+
zipp==3.5.0

‎setup.py

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
from distutils.core import setup
2+
3+
setup(
4+
name = 'fiixclient', # How you named your package folder (MyLib)
5+
packages = ['fiixclient'], # Chose the same as "name"
6+
version = '1.0', # Start with a small number and increase it with every change you make
7+
license='MIT', # Chose a license from here: https://help.github.com/articles/licensing-a-repository
8+
description = 'An easy to use Python wrapper for the Fiix CMMS API', # Give a short description about your library
9+
author = 'Ronald Langeveld', # Type in your name
10+
author_email = 'hi@ronaldlangeveld.com', # Type in your E-Mail
11+
url = 'https://www.ronaldlangeveld.com', # Provide either the link to your github or to your website
12+
download_url = 'https://github.com/user/reponame/archive/v_01.tar.gz', # I explain this later on
13+
keywords = ['FIIX', 'CMMS', 'API', 'MAINTENANCE'], # Keywords that define your package best
14+
install_requires=[ # I get to this in a second
15+
'requests',
16+
],
17+
classifiers=[
18+
'Development Status :: 4 - Beta', # Chose either "3 - Alpha", "4 - Beta" or "5 - Production/Stable" as the current state of your package
19+
'Intended Audience :: Developers', # Define that your audience are developers
20+
'Topic :: Software Development :: Build Tools',
21+
'License :: OSI Approved :: MIT License', # Again, pick a license
22+
'Programming Language :: Python :: 3.8',
23+
'Programming Language :: Python :: 3.9',
24+
],
25+
)

‎test.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
from client.fiix import Client
1+
from fiixclient.client import FiixClient
22
import os
33
from dotenv import dotenv_values
44

55
config = dotenv_values(".env")
66

7-
# print(config['API_KEY'])
8-
97
client_version = {"clientVersion": {"major": 2, "minor": 8, "patch": 1}}
108

11-
test = Client(subdomain=config['SUBDOMAIN'], api_key=config['API_KEY'],
9+
fiix = FiixClient(subdomain=config['SUBDOMAIN'], api_key=config['API_KEY'],
1210
access_key=config['ACCESS_KEY'], api_secret=config['API_SECRET'], version=client_version)
1311

1412
context = {
@@ -27,5 +25,5 @@
2725
}
2826

2927

30-
r = test.batch(context=context)
28+
r = fiix.batch(context=context)
3129
print(r.json())

0 commit comments

Comments
 (0)