greip 1.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
greip/__init__.py ADDED
@@ -0,0 +1,5 @@
1
+ __version__ = '1.0.0'
2
+ __author__ = 'Greip'
3
+ __email__ = 'info@greip.io'
4
+
5
+ from .greip import Greip
greip/greip.py ADDED
@@ -0,0 +1,399 @@
1
+ import requests
2
+
3
+ available_country_params = ['EN', 'AR', 'DE', 'FR', 'ES', 'JA', 'ZH', 'RU']
4
+ available_geoip_params = ['location', 'security', 'timezone', 'currency', 'device']
5
+
6
+ class CustomResponse:
7
+ def __init__(self, **kwargs):
8
+ #? Initialize attributes from the JSON response
9
+ for key, value in kwargs.items():
10
+ setattr(self, key, value)
11
+
12
+ def __str__(self):
13
+ #? Create a string representation of all attributes
14
+ properties = {key: value for key, value in self.__dict__.items()}
15
+ return f"CustomResponse({properties})"
16
+
17
+ def __repr__(self):
18
+ return self.__str__()
19
+
20
+ class Greip:
21
+ """Greip instance: it's used to interact with the Greip API.
22
+
23
+ Attributes:
24
+ token (str): Your Greip API token.
25
+ test_mode (bool): Whether to use the test mode or not.
26
+
27
+ Raises:
28
+ ValueError: If the token is not provided.
29
+
30
+ Methods
31
+ -------
32
+ lookup(ip, params=None, lang="EN")
33
+ Get geolocation information about an IP address.
34
+ threats(ip)
35
+ Get information about threats related to an IP address.
36
+ bulk_lookup(ips, params=None, lang="EN")
37
+ Get geolocation information about multiple IP addresses.
38
+ country(country_code, params=None, lang="EN")
39
+ Get information about a country.
40
+ profanity(text, params=None, lang="EN")
41
+ Check if a text contains profanity.
42
+ asn(asn)
43
+ Get information about an ASN.
44
+ email(email)
45
+ Validate an email address.
46
+ phone(phone, country_code)
47
+ Validate/lookup a phone number.
48
+ iban(iban)
49
+ Validate/lookup an IBAN number.
50
+ payment(data)
51
+ Check if a payment transaction is fraudulent.
52
+ """
53
+
54
+ def __init__(self, token: str, test_mode=False):
55
+ #? Check if the token is provided
56
+ if not token:
57
+ raise ValueError("Token is required")
58
+ self.token = token
59
+ self.test_mode = test_mode
60
+
61
+ def _make_http_request(self, endpoint: str, payload: dict):
62
+ url = f"https://greipapi.com/{endpoint}"
63
+ headers = {
64
+ "Authorization": f"Bearer {self.token}",
65
+ "Content-Type": "application/json"
66
+ }
67
+
68
+ #? Add the test mode to the payload if it's enabled
69
+ if self.test_mode:
70
+ payload['mode'] = 'test'
71
+
72
+ response = requests.get(url, headers=headers, params=payload)
73
+
74
+ #? Raise exception if the response status code is not 2xx
75
+ if not response.ok:
76
+ raise requests.exceptions.RequestException(response.text)
77
+
78
+ json_response = response.json()
79
+ if json_response.get('status') == 'error':
80
+ raise requests.exceptions.RequestException(json_response['description'])
81
+
82
+ data = json_response['data']
83
+ return CustomResponse(**data)
84
+
85
+ def _make_http_post_request(self, endpoint: str, payload: dict):
86
+ url = f"https://greipapi.com/{endpoint}"
87
+ headers = {
88
+ "Authorization": f"Bearer {self.token}",
89
+ "Content-Type": "application/json"
90
+ }
91
+
92
+ #? Add the test mode to the payload if it's enabled
93
+ if self.test_mode:
94
+ payload['mode'] = 'test'
95
+
96
+ response = requests.post(url, headers=headers, json=payload)
97
+
98
+ #? Raise exception if the response status code is not 2xx
99
+ if not response.ok:
100
+ raise requests.exceptions.RequestException(response.text)
101
+
102
+ json_response = response.json()
103
+ data = json_response['data']
104
+ return CustomResponse(**data)
105
+
106
+ def lookup(self, ip: str, params=None, lang="EN"):
107
+ """Get geolocation information about an IP address.
108
+
109
+ Parameters:
110
+ ip (str): The IP address to lookup.
111
+ params (list): The modules to include in the response.
112
+ lang (str): The language of the response.
113
+
114
+ Returns:
115
+ CustomResponse: The response object.
116
+
117
+ Raises:
118
+ ValueError: If the `ip` parameter is not provided.
119
+ ValueError: If the `params` parameter is not a list.
120
+ ValueError: If the `params` or `lang` are invalid.
121
+ """
122
+
123
+ if not ip:
124
+ raise ValueError("You should pass the `ip` parameter.")
125
+
126
+ if not isinstance(params, list):
127
+ params = []
128
+
129
+ #? Validate the params, and lang
130
+ self._validate_params(params, available_geoip_params)
131
+ self._validate_lang(lang)
132
+
133
+ payload = {
134
+ "ip": ip,
135
+ "params": ",".join(params),
136
+ "lang": lang.upper(),
137
+ }
138
+
139
+ return self._make_http_request("IPLookup", payload)
140
+
141
+ def threats(self, ip: str):
142
+ """Get information about threats related to an IP address.
143
+
144
+ Parameters:
145
+ ip (str): The IP address to lookup.
146
+
147
+ Returns:
148
+ CustomResponse: The response object.
149
+
150
+ Raises:
151
+ ValueError: If the `ip` parameter is not provided.
152
+ """
153
+ if not ip:
154
+ raise ValueError("You should pass the `ip` parameter.")
155
+
156
+ payload = {
157
+ "ip": ip,
158
+ }
159
+
160
+ return self._make_http_request("threats", payload)
161
+
162
+ def bulk_lookup(self, ips: list, params=None, lang="EN"):
163
+ """Get geolocation information about multiple IP addresses.
164
+
165
+ Parameters:
166
+ ips (list): The list of IP addresses to lookup.
167
+ params (list): The modules to include in the response.
168
+ lang (str): The language of the response.
169
+
170
+ Returns:
171
+ CustomResponse: The response object.
172
+
173
+ Raises:
174
+ ValueError: If the `ips` parameter is not provided or not a list.
175
+ ValueError: If the `params` parameter is not a list.
176
+ ValueError: If the `params` or `lang` are invalid.
177
+ """
178
+ if not ips or not isinstance(ips, list) or len(ips) == 0:
179
+ raise ValueError("You should pass the `ips` parameter as a list of IPs.")
180
+
181
+ self._validate_ips(ips)
182
+ if not isinstance(params, list):
183
+ params = []
184
+
185
+ #? Validate the params, and lang
186
+ self._validate_params(params, available_geoip_params)
187
+ self._validate_lang(lang)
188
+
189
+ payload = {
190
+ "ips": ",".join(ips),
191
+ "params": ",".join(params),
192
+ "lang": lang.upper(),
193
+ }
194
+
195
+ return self._make_http_request("BulkLookup", payload)
196
+
197
+ def country(self, country_code: str, params=None, lang="EN"):
198
+ """Get information about a country.
199
+
200
+ Parameters:
201
+ country_code (str): The ISO 3166-1 alpha-2 country code.
202
+ params (list): The modules to include in the response.
203
+ lang (str): The language of the response.
204
+
205
+ Returns:
206
+ CustomResponse: The response object.
207
+
208
+ Raises:
209
+ ValueError: If the `country_code` parameter is not provided.
210
+ ValueError: If the `country_code` is not in ISO 3166-1 alpha-2 format.
211
+ ValueError: If the `params` parameter is not a list.
212
+ ValueError: If the `params` or `lang` are invalid
213
+ """
214
+
215
+ if not country_code:
216
+ raise ValueError("You should pass the `country_code` parameter.")
217
+ if len(country_code) != 2:
218
+ raise ValueError("The `country_code` parameter should be in ISO 3166-1 alpha-2 format.")
219
+
220
+ if not isinstance(params, list):
221
+ params = []
222
+
223
+ #? Validate the params, and lang
224
+ self._validate_params(params, available_country_params)
225
+ self._validate_lang(lang)
226
+
227
+ payload = {
228
+ "CountryCode": country_code.upper(),
229
+ "params": ",".join(params),
230
+ "lang": lang.upper(),
231
+ }
232
+
233
+ return self._make_http_request("Country", payload)
234
+
235
+ def profanity(self, text: str, params=None, lang="EN"):
236
+ """Check if a text contains profanity.
237
+
238
+ Parameters:
239
+ text (str): The text to check.
240
+ params (list): The modules to include in the response.
241
+ lang (str): The language of the response.
242
+
243
+ Returns:
244
+ CustomResponse: The response object.
245
+
246
+ Raises:
247
+ ValueError: If the `text` parameter is not provided.
248
+ ValueError: If the `params` parameter is not a list.
249
+ ValueError: If the `params` or `lang` are invalid.
250
+ """
251
+
252
+ if not text:
253
+ raise ValueError("You should pass the `text` parameter.")
254
+
255
+ if not isinstance(params, list):
256
+ params = []
257
+
258
+ #? Validate lang
259
+ self._validate_lang(lang)
260
+
261
+ payload = {
262
+ "text": text,
263
+ "params": ",".join(params),
264
+ "lang": lang.upper(),
265
+ }
266
+
267
+ return self._make_http_request("badWords", payload)
268
+
269
+ def asn(self, asn: str):
270
+ """Get information about an ASN.
271
+
272
+ Parameters:
273
+ asn (str): The ASN to lookup.
274
+
275
+ Returns:
276
+ CustomResponse: The response object.
277
+
278
+ Raises:
279
+ ValueError: If the `asn` parameter is not provided.
280
+ """
281
+
282
+ if not asn:
283
+ raise ValueError("You should pass the `asn` parameter.")
284
+
285
+ payload = {
286
+ "asn": asn,
287
+ }
288
+
289
+ return self._make_http_request("ASNLookup", payload)
290
+
291
+ def email(self, email: str):
292
+ """Validate an email address.
293
+
294
+ Parameters:
295
+ email (str): The email address to validate.
296
+
297
+ Returns:
298
+ CustomResponse: The response object.
299
+
300
+ Raises:
301
+ ValueError: If the `email` parameter is not provided.
302
+ """
303
+
304
+ if not email:
305
+ raise ValueError("You should pass the `email` parameter.")
306
+
307
+ payload = {
308
+ "email": email,
309
+ }
310
+
311
+ return self._make_http_request("validateEmail", payload)
312
+
313
+ def phone(self, phone: str, country_code: str):
314
+ """Validate/lookup a phone number.
315
+
316
+ Parameters:
317
+ phone (str): The phone number to validate.
318
+ country_code (str): The ISO 3166-1 alpha-2 country code.
319
+
320
+ Returns:
321
+ CustomResponse: The response object.
322
+
323
+ Raises:
324
+ ValueError: If the `phone` or `country_code` parameters are not provided.
325
+ ValueError: If the `country_code` is not in ISO 3166-1 alpha-2 format.
326
+ """
327
+
328
+ if not phone:
329
+ raise ValueError("You should pass the `phone` parameter.")
330
+
331
+ if len(country_code) != 2:
332
+ raise ValueError("The `country_code` parameter should be in ISO 3166-1 alpha-2 format.")
333
+
334
+ payload = {
335
+ "phone": phone,
336
+ "countryCode": country_code,
337
+ }
338
+
339
+ return self._make_http_request("validatePhone", payload)
340
+
341
+ def iban(self, iban: str):
342
+ """Validate/lookup an IBAN number.
343
+
344
+ Parameters:
345
+ iban (str): The IBAN number to validate.
346
+
347
+ Returns:
348
+ CustomResponse: The response object.
349
+
350
+ Raises:
351
+ ValueError: If the `iban` parameter is not provided.
352
+ """
353
+
354
+ if not iban:
355
+ raise ValueError("You should pass the `iban` parameter.")
356
+
357
+ payload = {
358
+ "iban": iban,
359
+ }
360
+
361
+ return self._make_http_request("validateIBAN", payload)
362
+
363
+ def payment(self, data: dict):
364
+ """Check if a payment transaction is fraudulent.
365
+
366
+ Parameters:
367
+ data (dict): The payment data to check.
368
+
369
+ Returns:
370
+ CustomResponse: The response object.
371
+
372
+ Raises:
373
+ ValueError: If the `data` parameter is not provided or not a dictionary.
374
+ """
375
+
376
+ if not data or not isinstance(data, dict):
377
+ raise ValueError("You should pass the `data` parameter as a dictionary.")
378
+
379
+ payload = {
380
+ "data": data,
381
+ }
382
+
383
+ return self._make_http_post_request("paymentFraud", payload)
384
+
385
+ #? Helper methods for validation
386
+ def _validate_params(self, params, valid_params):
387
+ for param in params:
388
+ if param not in valid_params:
389
+ raise ValueError(f'The "{param}" module is unknown. Check available params in the documentation.')
390
+
391
+ def _validate_lang(self, lang):
392
+ available_languages = ["EN", "AR", "DE", "FR", "ES", "JA", "ZH", "RU"]
393
+ if lang.upper() not in available_languages:
394
+ raise ValueError(f'The language "{lang}" is invalid. Use one of: {available_languages}')
395
+
396
+ def _validate_ips(self, ips):
397
+ for ip in ips:
398
+ if len(ip) < 7:
399
+ raise ValueError("Invalid IP address in the `ips` list.")
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,318 @@
1
+ Metadata-Version: 2.1
2
+ Name: greip
3
+ Version: 1.0.0
4
+ Summary: Python wrapper for Greip API
5
+ Home-page: https://github.com/Greipio/python
6
+ Author: Greip
7
+ Author-email: Greip <info@greip.io>
8
+ License: Apache License
9
+ Version 2.0, January 2004
10
+ http://www.apache.org/licenses/
11
+
12
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
13
+
14
+ 1. Definitions.
15
+
16
+ "License" shall mean the terms and conditions for use, reproduction,
17
+ and distribution as defined by Sections 1 through 9 of this document.
18
+
19
+ "Licensor" shall mean the copyright owner or entity authorized by
20
+ the copyright owner that is granting the License.
21
+
22
+ "Legal Entity" shall mean the union of the acting entity and all
23
+ other entities that control, are controlled by, or are under common
24
+ control with that entity. For the purposes of this definition,
25
+ "control" means (i) the power, direct or indirect, to cause the
26
+ direction or management of such entity, whether by contract or
27
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
28
+ outstanding shares, or (iii) beneficial ownership of such entity.
29
+
30
+ "You" (or "Your") shall mean an individual or Legal Entity
31
+ exercising permissions granted by this License.
32
+
33
+ "Source" form shall mean the preferred form for making modifications,
34
+ including but not limited to software source code, documentation
35
+ source, and configuration files.
36
+
37
+ "Object" form shall mean any form resulting from mechanical
38
+ transformation or translation of a Source form, including but
39
+ not limited to compiled object code, generated documentation,
40
+ and conversions to other media types.
41
+
42
+ "Work" shall mean the work of authorship, whether in Source or
43
+ Object form, made available under the License, as indicated by a
44
+ copyright notice that is included in or attached to the work
45
+ (an example is provided in the Appendix below).
46
+
47
+ "Derivative Works" shall mean any work, whether in Source or Object
48
+ form, that is based on (or derived from) the Work and for which the
49
+ editorial revisions, annotations, elaborations, or other modifications
50
+ represent, as a whole, an original work of authorship. For the purposes
51
+ of this License, Derivative Works shall not include works that remain
52
+ separable from, or merely link (or bind by name) to the interfaces of,
53
+ the Work and Derivative Works thereof.
54
+
55
+ "Contribution" shall mean any work of authorship, including
56
+ the original version of the Work and any modifications or additions
57
+ to that Work or Derivative Works thereof, that is intentionally
58
+ submitted to Licensor for inclusion in the Work by the copyright owner
59
+ or by an individual or Legal Entity authorized to submit on behalf of
60
+ the copyright owner. For the purposes of this definition, "submitted"
61
+ means any form of electronic, verbal, or written communication sent
62
+ to the Licensor or its representatives, including but not limited to
63
+ communication on electronic mailing lists, source code control systems,
64
+ and issue tracking systems that are managed by, or on behalf of, the
65
+ Licensor for the purpose of discussing and improving the Work, but
66
+ excluding communication that is conspicuously marked or otherwise
67
+ designated in writing by the copyright owner as "Not a Contribution."
68
+
69
+ "Contributor" shall mean Licensor and any individual or Legal Entity
70
+ on behalf of whom a Contribution has been received by Licensor and
71
+ subsequently incorporated within the Work.
72
+
73
+ 2. Grant of Copyright License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ copyright license to reproduce, prepare Derivative Works of,
77
+ publicly display, publicly perform, sublicense, and distribute the
78
+ Work and such Derivative Works in Source or Object form.
79
+
80
+ 3. Grant of Patent License. Subject to the terms and conditions of
81
+ this License, each Contributor hereby grants to You a perpetual,
82
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
83
+ (except as stated in this section) patent license to make, have made,
84
+ use, offer to sell, sell, import, and otherwise transfer the Work,
85
+ where such license applies only to those patent claims licensable
86
+ by such Contributor that are necessarily infringed by their
87
+ Contribution(s) alone or by combination of their Contribution(s)
88
+ with the Work to which such Contribution(s) was submitted. If You
89
+ institute patent litigation against any entity (including a
90
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
91
+ or a Contribution incorporated within the Work constitutes direct
92
+ or contributory patent infringement, then any patent licenses
93
+ granted to You under this License for that Work shall terminate
94
+ as of the date such litigation is filed.
95
+
96
+ 4. Redistribution. You may reproduce and distribute copies of the
97
+ Work or Derivative Works thereof in any medium, with or without
98
+ modifications, and in Source or Object form, provided that You
99
+ meet the following conditions:
100
+
101
+ (a) You must give any other recipients of the Work or
102
+ Derivative Works a copy of this License; and
103
+
104
+ (b) You must cause any modified files to carry prominent notices
105
+ stating that You changed the files; and
106
+
107
+ (c) You must retain, in the Source form of any Derivative Works
108
+ that You distribute, all copyright, patent, trademark, and
109
+ attribution notices from the Source form of the Work,
110
+ excluding those notices that do not pertain to any part of
111
+ the Derivative Works; and
112
+
113
+ (d) If the Work includes a "NOTICE" text file as part of its
114
+ distribution, then any Derivative Works that You distribute must
115
+ include a readable copy of the attribution notices contained
116
+ within such NOTICE file, excluding those notices that do not
117
+ pertain to any part of the Derivative Works, in at least one
118
+ of the following places: within a NOTICE text file distributed
119
+ as part of the Derivative Works; within the Source form or
120
+ documentation, if provided along with the Derivative Works; or,
121
+ within a display generated by the Derivative Works, if and
122
+ wherever such third-party notices normally appear. The contents
123
+ of the NOTICE file are for informational purposes only and
124
+ do not modify the License. You may add Your own attribution
125
+ notices within Derivative Works that You distribute, alongside
126
+ or as an addendum to the NOTICE text from the Work, provided
127
+ that such additional attribution notices cannot be construed
128
+ as modifying the License.
129
+
130
+ You may add Your own copyright statement to Your modifications and
131
+ may provide additional or different license terms and conditions
132
+ for use, reproduction, or distribution of Your modifications, or
133
+ for any such Derivative Works as a whole, provided Your use,
134
+ reproduction, and distribution of the Work otherwise complies with
135
+ the conditions stated in this License.
136
+
137
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
138
+ any Contribution intentionally submitted for inclusion in the Work
139
+ by You to the Licensor shall be under the terms and conditions of
140
+ this License, without any additional terms or conditions.
141
+ Notwithstanding the above, nothing herein shall supersede or modify
142
+ the terms of any separate license agreement you may have executed
143
+ with Licensor regarding such Contributions.
144
+
145
+ 6. Trademarks. This License does not grant permission to use the trade
146
+ names, trademarks, service marks, or product names of the Licensor,
147
+ except as required for reasonable and customary use in describing the
148
+ origin of the Work and reproducing the content of the NOTICE file.
149
+
150
+ 7. Disclaimer of Warranty. Unless required by applicable law or
151
+ agreed to in writing, Licensor provides the Work (and each
152
+ Contributor provides its Contributions) on an "AS IS" BASIS,
153
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
154
+ implied, including, without limitation, any warranties or conditions
155
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
156
+ PARTICULAR PURPOSE. You are solely responsible for determining the
157
+ appropriateness of using or redistributing the Work and assume any
158
+ risks associated with Your exercise of permissions under this License.
159
+
160
+ 8. Limitation of Liability. In no event and under no legal theory,
161
+ whether in tort (including negligence), contract, or otherwise,
162
+ unless required by applicable law (such as deliberate and grossly
163
+ negligent acts) or agreed to in writing, shall any Contributor be
164
+ liable to You for damages, including any direct, indirect, special,
165
+ incidental, or consequential damages of any character arising as a
166
+ result of this License or out of the use or inability to use the
167
+ Work (including but not limited to damages for loss of goodwill,
168
+ work stoppage, computer failure or malfunction, or any and all
169
+ other commercial damages or losses), even if such Contributor
170
+ has been advised of the possibility of such damages.
171
+
172
+ 9. Accepting Warranty or Additional Liability. While redistributing
173
+ the Work or Derivative Works thereof, You may choose to offer,
174
+ and charge a fee for, acceptance of support, warranty, indemnity,
175
+ or other liability obligations and/or rights consistent with this
176
+ License. However, in accepting such obligations, You may act only
177
+ on Your own behalf and on Your sole responsibility, not on behalf
178
+ of any other Contributor, and only if You agree to indemnify,
179
+ defend, and hold each Contributor harmless for any liability
180
+ incurred by, or claims asserted against, such Contributor by reason
181
+ of your accepting any such warranty or additional liability.
182
+
183
+ END OF TERMS AND CONDITIONS
184
+
185
+ APPENDIX: How to apply the Apache License to your work.
186
+
187
+ To apply the Apache License to your work, attach the following
188
+ boilerplate notice, with the fields enclosed by brackets "[]"
189
+ replaced with your own identifying information. (Don't include
190
+ the brackets!) The text should be enclosed in the appropriate
191
+ comment syntax for the file format. We also recommend that a
192
+ file or class name and description of purpose be included on the
193
+ same "printed page" as the copyright notice for easier
194
+ identification within third-party archives.
195
+
196
+ Copyright [yyyy] [name of copyright owner]
197
+
198
+ Licensed under the Apache License, Version 2.0 (the "License");
199
+ you may not use this file except in compliance with the License.
200
+ You may obtain a copy of the License at
201
+
202
+ http://www.apache.org/licenses/LICENSE-2.0
203
+
204
+ Unless required by applicable law or agreed to in writing, software
205
+ distributed under the License is distributed on an "AS IS" BASIS,
206
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
207
+ See the License for the specific language governing permissions and
208
+ limitations under the License.
209
+
210
+ Project-URL: Homepage, https://greip.io
211
+ Project-URL: Documentation, https://docs.greip.io
212
+ Project-URL: Repository, https://github.com/Greipio/python
213
+ Project-URL: Issues, https://github.com/Greipio/python/issues
214
+ Keywords: geolocation,geoip,fraud-prevention,profanity-detection,fraud-detection,asn-lookup,bin-lookup
215
+ Classifier: Programming Language :: Python :: 3
216
+ Classifier: License :: OSI Approved :: Apache Software License
217
+ Classifier: Operating System :: OS Independent
218
+ Classifier: Natural Language :: English
219
+ Requires-Python: >=3.6
220
+ Description-Content-Type: text/markdown
221
+ License-File: LICENSE
222
+ Requires-Dist: requests
223
+ Provides-Extra: dev
224
+ Requires-Dist: pytest; extra == "dev"
225
+
226
+ # Greip Python SDK
227
+
228
+ The Greip Python SDK allows you to easily interact with the Greip API for various functionalities, including IP geolocation, threat intelligence, email validation, and more.
229
+
230
+ [Report Issue](https://github.com/Greipio/python/issues/new) ·
231
+ [Request Feature](https://github.com/Greipio/python/discussions/new?category=ideas)
232
+ · [Greip Website](https://greip.io/) · [Documentation](https://docs.greip.io/)
233
+
234
+ ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/Greipio/python?color=green&label=Minified%20size&logo=github)
235
+ &nbsp;&nbsp;
236
+ [![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/apache-2-0)
237
+ &nbsp;&nbsp;
238
+ ![API Status](https://img.shields.io/website?down_color=orange&down_message=down&label=API%20status&up_color=green&up_message=up&url=https%3A%2F%2Fgreipapi.com)
239
+
240
+ ---
241
+
242
+ ## Installation
243
+
244
+ You can install the Greip SDK via pip. Run the following command:
245
+
246
+ ```bash
247
+ pip install greip
248
+ ```
249
+
250
+ ## Usage
251
+
252
+ To use the Greip SDK, you need to initialize a Greip object with your API token. Here’s a basic example:
253
+
254
+ ```python
255
+ import greip
256
+
257
+ # Initialize the Greip instance with your API token
258
+ greip_instance = greip.Greip("YOUR_API_TOKEN")
259
+
260
+ # Example: Lookup IP information
261
+ response = greip_instance.lookup("1.1.1.1")
262
+ print(response) # Access properties like response.ip, response.country, etc.
263
+ ```
264
+
265
+ ## Methods
266
+
267
+ The Greip SDK provides various methods to interact with the API:
268
+
269
+ - **lookup(ip, params=None, lang=“EN”)**: Get geolocation information about an IP address.
270
+ - **threats(ip)**: Get information about threats related to an IP address.
271
+ - **bulk_lookup(ips, params=None, lang=“EN”)**: Get geolocation information about multiple IP addresses.
272
+ - **country(country_code, params=None, lang=“EN”)**: Get information about a country.
273
+ - **profanity(text, params=None, lang=“EN”)**: Check if a text contains profanity.
274
+ - **asn(asn)**: Get information about an ASN.
275
+ - **email(email)**: Validate an email address.
276
+ - **phone(phone,** country_code): Validate/lookup a phone number.
277
+ - **iban(iban)**: Validate/lookup an IBAN number.
278
+ - **payment(data)**: Check if a payment transaction is fraudulent.
279
+
280
+ ## Example of Method Usage
281
+
282
+ ```python
283
+ # Lookup country information
284
+ country_info = greip_instance.country("US")
285
+ print(country_info) # Access properties like country_info.countryName, country_info.population, etc.
286
+ ```
287
+
288
+ ## Development mode
289
+
290
+ If you need to test the integration without affecting your account subscription usage you can simple set the `test_mode` attribute to `True` when you initialize the Greip instance, here's an example:
291
+
292
+ ```python
293
+ greip_instance = greip.Greip("YOUR_API_TOKEN", test_mode=True)
294
+ ```
295
+
296
+ > [!WARNING]
297
+ > Enabling the development environment will lead to return fake information. Just make sure to not use it in production.
298
+
299
+ ## Error Handling
300
+
301
+ The SDK raises ValueError for invalid input parameters and requests.exceptions.RequestException for issues related to API requests. Ensure you handle exceptions properly in your code.
302
+
303
+ ```python
304
+ try:
305
+ response = greip_instance.lookup("INVALID_IP")
306
+ except ValueError as ve:
307
+ print(f"ValueError: {ve}")
308
+ except requests.exceptions.RequestException as re:
309
+ print(f"RequestException: {re}")
310
+ ```
311
+
312
+ ## Contributing
313
+
314
+ Contributions are welcome! Please feel free to submit a pull request or open an issue for any improvements or bugs you encounter.
315
+
316
+ ## License
317
+
318
+ This project is licensed under the Apache 2.0 License - see the LICENSE file for details.
@@ -0,0 +1,7 @@
1
+ greip/__init__.py,sha256=ocaxMBtnRrhAFjWD5QbnoTGjugOhlIiqErsoG16Ugcc,96
2
+ greip/greip.py,sha256=ZK35o1Xj4khwMno0afVmtRcs2oFvw5VEmpDqfQYRU6c,12699
3
+ greip-1.0.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
4
+ greip-1.0.0.dist-info/METADATA,sha256=jQgLMROCk-iCnr79pAQgFiF1TJ4Lsp0w7Lbju9H77vM,17340
5
+ greip-1.0.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
6
+ greip-1.0.0.dist-info/top_level.txt,sha256=s6-bqImx7F2qOEkNUSXupfPcZb1sszs_ALGetzJAGlw,6
7
+ greip-1.0.0.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (75.1.0)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1 @@
1
+ greip