apiverve-reversegeocode 1.0.11__tar.gz

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.
Files changed (16) hide show
  1. apiverve_reversegeocode-1.0.11/LICENSE +21 -0
  2. apiverve_reversegeocode-1.0.11/PKG-INFO +163 -0
  3. apiverve_reversegeocode-1.0.11/README.md +122 -0
  4. apiverve_reversegeocode-1.0.11/pyproject.toml +45 -0
  5. apiverve_reversegeocode-1.0.11/setup.cfg +4 -0
  6. apiverve_reversegeocode-1.0.11/src/apiverve_reversegeocode/__init__.py +1 -0
  7. apiverve_reversegeocode-1.0.11/src/apiverve_reversegeocode/apiClient.py +38 -0
  8. apiverve_reversegeocode-1.0.11/src/apiverve_reversegeocode/exceptions.py +3 -0
  9. apiverve_reversegeocode-1.0.11/src/apiverve_reversegeocode/setup.py +21 -0
  10. apiverve_reversegeocode-1.0.11/src/apiverve_reversegeocode/tests/__init__.py +1 -0
  11. apiverve_reversegeocode-1.0.11/src/apiverve_reversegeocode/tests/test_api.py +19 -0
  12. apiverve_reversegeocode-1.0.11/src/apiverve_reversegeocode.egg-info/PKG-INFO +163 -0
  13. apiverve_reversegeocode-1.0.11/src/apiverve_reversegeocode.egg-info/SOURCES.txt +14 -0
  14. apiverve_reversegeocode-1.0.11/src/apiverve_reversegeocode.egg-info/dependency_links.txt +1 -0
  15. apiverve_reversegeocode-1.0.11/src/apiverve_reversegeocode.egg-info/top_level.txt +1 -0
  16. apiverve_reversegeocode-1.0.11/tests/test_api.py +27 -0
apiverve_reversegeocode-1.0.11/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2024 APIVerve, and Evlar LLC
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
apiverve_reversegeocode-1.0.11/PKG-INFO ADDED
@@ -0,0 +1,163 @@
1
+ Metadata-Version: 2.1
2
+ Name: apiverve-reversegeocode
3
+ Version: 1.0.11
4
+ Summary: Reverse Geocode is a simple tool for getting the location of a set of coordinates. Only supports USA and Canada Coordinates. It returns the city, state, and more.
5
+ Author-email: APIVerve <hello@apiverve.com>
6
+ Project-URL: Homepage, https://apiverve.com
7
+ Keywords: reverse geocode,reverse geocode api,reverse geocode tool,reverse geocode software,reverse geocode service
8
+ Classifier: Development Status :: 5 - Production/Stable
9
+ Classifier: Programming Language :: Python :: 3
10
+ Classifier: License :: OSI Approved :: MIT License
11
+ Classifier: Operating System :: OS Independent
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Intended Audience :: Financial and Insurance Industry
14
+ Classifier: Intended Audience :: Healthcare Industry
15
+ Classifier: Intended Audience :: Education
16
+ Classifier: Intended Audience :: Science/Research
17
+ Classifier: Intended Audience :: Information Technology
18
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
19
+ Classifier: Topic :: Utilities
20
+ Classifier: Topic :: Scientific/Engineering
21
+ Classifier: Topic :: Education
22
+ Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
23
+ Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
24
+ Classifier: Topic :: Internet :: WWW/HTTP
25
+ Classifier: Topic :: Software Development :: Libraries
26
+ Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
27
+ Classifier: Topic :: Internet
28
+ Classifier: Topic :: Communications
29
+ Classifier: Topic :: Office/Business
30
+ Classifier: Topic :: Text Processing
31
+ Classifier: Topic :: Security
32
+ Classifier: Topic :: Database
33
+ Classifier: Topic :: Software Development :: Code Generators
34
+ Classifier: Topic :: Software Development :: Pre-processors
35
+ Classifier: Topic :: Software Development :: Quality Assurance
36
+ Classifier: Topic :: Software Development :: Testing
37
+ Classifier: Natural Language :: English
38
+ Requires-Python: >=3.12
39
+ Description-Content-Type: text/markdown
40
+ License-File: LICENSE
41
+
42
+ Reverse Geocode API
43
+ ============
44
+
45
+ Reverse Geocode is a simple tool for getting the location of a set of coordinates. Only supports USA and Canada Coordinates. It returns the city, state, and more.
46
+
47
+ ![Build Status](https://img.shields.io/badge/build-passing-green)
48
+ ![Code Climate](https://img.shields.io/badge/maintainability-B-purple)
49
+ ![Prod Ready](https://img.shields.io/badge/production-ready-blue)
50
+
51
+ This is a Python API Wrapper for the [Reverse Geocode API](https://apiverve.com/marketplace/api/reversegeocode)
52
+
53
+ ---
54
+
55
+ ## Installation
56
+ pip install apiverve-reversegeocode
57
+
58
+ ---
59
+
60
+ ## Configuration
61
+
62
+ Before using the reversegeocode API client, you have to setup your account and obtain your API Key.
63
+ You can get it by signing up at [https://apiverve.com](https://apiverve.com)
64
+
65
+ ---
66
+
67
+ ## Usage
68
+
69
+ The Reverse Geocode API documentation is found here: [https://docs.apiverve.com/api/reversegeocode](https://docs.apiverve.com/api/reversegeocode).
70
+ You can find parameters, example responses, and status codes documented here.
71
+
72
+ ### Setup
73
+
74
+ ```
75
+ # Import the client module
76
+ from apiverve_reversegeocode.apiClient import ReversegeocodeAPIClient
77
+
78
+ # Initialize the client with your APIVerve API key
79
+ api = ReversegeocodeAPIClient("[YOUR_API_KEY]")
80
+ ```
81
+
82
+ ---
83
+
84
+
85
+ ### Perform Request
86
+ Using the API client, you can perform requests to the API.
87
+
88
+ ###### Define Query
89
+
90
+ ```
91
+ query = { "lat": 40.714224, "lon": -73.961452 }
92
+ ```
93
+
94
+ ###### Simple Request
95
+
96
+ ```
97
+ # Make a request to the API
98
+ result = api.execute(query)
99
+
100
+ # Print the result
101
+ print(result)
102
+ ```
103
+
104
+ ###### Example Response
105
+
106
+ ```
107
+ {
108
+ "status": "ok",
109
+ "error": null,
110
+ "data": {
111
+ "zipcode": "11211",
112
+ "state_abbr": "NY",
113
+ "city": "Brooklyn",
114
+ "state": "New York",
115
+ "distance": 0.65017573007586638,
116
+ "latitudeClosest": "40.712090",
117
+ "longitudeClosest": "-73.95427",
118
+ "countryCode": "US",
119
+ "latitudeClosestCity": null,
120
+ "longitudeClosestCity": null,
121
+ "latitude": 40.714224,
122
+ "longitude": -73.961452,
123
+ "estimatedCity": true,
124
+ "nearestCities": [
125
+ "Brooklyn",
126
+ "Brooklyn Park",
127
+ "East Brooklyn",
128
+ "Brooklyn Center",
129
+ "Brooklyn Heights"
130
+ ]
131
+ }
132
+ }
133
+ ```
134
+
135
+ ---
136
+
137
+ ## Customer Support
138
+
139
+ Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).
140
+
141
+ ---
142
+
143
+ ## Updates
144
+ Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
145
+
146
+ ---
147
+
148
+ ## Legal
149
+
150
+ All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms) and all legal documents and agreements.
151
+
152
+ ---
153
+
154
+ ## License
155
+ Licensed under the The MIT License (MIT)
156
+
157
+ Copyright (&copy;) 2024 APIVerve, and Evlar LLC
158
+
159
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
160
+
161
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
162
+
163
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
apiverve_reversegeocode-1.0.11/README.md ADDED
@@ -0,0 +1,122 @@
1
+ Reverse Geocode API
2
+ ============
3
+
4
+ Reverse Geocode is a simple tool for getting the location of a set of coordinates. Only supports USA and Canada Coordinates. It returns the city, state, and more.
5
+
6
+ ![Build Status](https://img.shields.io/badge/build-passing-green)
7
+ ![Code Climate](https://img.shields.io/badge/maintainability-B-purple)
8
+ ![Prod Ready](https://img.shields.io/badge/production-ready-blue)
9
+
10
+ This is a Python API Wrapper for the [Reverse Geocode API](https://apiverve.com/marketplace/api/reversegeocode)
11
+
12
+ ---
13
+
14
+ ## Installation
15
+ pip install apiverve-reversegeocode
16
+
17
+ ---
18
+
19
+ ## Configuration
20
+
21
+ Before using the reversegeocode API client, you have to setup your account and obtain your API Key.
22
+ You can get it by signing up at [https://apiverve.com](https://apiverve.com)
23
+
24
+ ---
25
+
26
+ ## Usage
27
+
28
+ The Reverse Geocode API documentation is found here: [https://docs.apiverve.com/api/reversegeocode](https://docs.apiverve.com/api/reversegeocode).
29
+ You can find parameters, example responses, and status codes documented here.
30
+
31
+ ### Setup
32
+
33
+ ```
34
+ # Import the client module
35
+ from apiverve_reversegeocode.apiClient import ReversegeocodeAPIClient
36
+
37
+ # Initialize the client with your APIVerve API key
38
+ api = ReversegeocodeAPIClient("[YOUR_API_KEY]")
39
+ ```
40
+
41
+ ---
42
+
43
+
44
+ ### Perform Request
45
+ Using the API client, you can perform requests to the API.
46
+
47
+ ###### Define Query
48
+
49
+ ```
50
+ query = { "lat": 40.714224, "lon": -73.961452 }
51
+ ```
52
+
53
+ ###### Simple Request
54
+
55
+ ```
56
+ # Make a request to the API
57
+ result = api.execute(query)
58
+
59
+ # Print the result
60
+ print(result)
61
+ ```
62
+
63
+ ###### Example Response
64
+
65
+ ```
66
+ {
67
+ "status": "ok",
68
+ "error": null,
69
+ "data": {
70
+ "zipcode": "11211",
71
+ "state_abbr": "NY",
72
+ "city": "Brooklyn",
73
+ "state": "New York",
74
+ "distance": 0.65017573007586638,
75
+ "latitudeClosest": "40.712090",
76
+ "longitudeClosest": "-73.95427",
77
+ "countryCode": "US",
78
+ "latitudeClosestCity": null,
79
+ "longitudeClosestCity": null,
80
+ "latitude": 40.714224,
81
+ "longitude": -73.961452,
82
+ "estimatedCity": true,
83
+ "nearestCities": [
84
+ "Brooklyn",
85
+ "Brooklyn Park",
86
+ "East Brooklyn",
87
+ "Brooklyn Center",
88
+ "Brooklyn Heights"
89
+ ]
90
+ }
91
+ }
92
+ ```
93
+
94
+ ---
95
+
96
+ ## Customer Support
97
+
98
+ Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).
99
+
100
+ ---
101
+
102
+ ## Updates
103
+ Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
104
+
105
+ ---
106
+
107
+ ## Legal
108
+
109
+ All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms) and all legal documents and agreements.
110
+
111
+ ---
112
+
113
+ ## License
114
+ Licensed under the The MIT License (MIT)
115
+
116
+ Copyright (&copy;) 2024 APIVerve, and Evlar LLC
117
+
118
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
119
+
120
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
121
+
122
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
apiverve_reversegeocode-1.0.11/pyproject.toml ADDED
@@ -0,0 +1,45 @@
1
+ [project]
2
+ name = "apiverve-reversegeocode"
3
+ version = "1.0.11"
4
+ authors = [
5
+ { name="APIVerve", email="hello@apiverve.com" },
6
+ ]
7
+ description = "Reverse Geocode is a simple tool for getting the location of a set of coordinates. Only supports USA and Canada Coordinates. It returns the city, state, and more."
8
+ keywords = ["reverse geocode","reverse geocode api","reverse geocode tool","reverse geocode software","reverse geocode service"]
9
+ readme = "README.md"
10
+ requires-python = ">=3.12"
11
+ classifiers = [
12
+ "Development Status :: 5 - Production/Stable",
13
+ "Programming Language :: Python :: 3",
14
+ "License :: OSI Approved :: MIT License",
15
+ "Operating System :: OS Independent",
16
+ "Intended Audience :: Developers",
17
+ "Intended Audience :: Financial and Insurance Industry",
18
+ "Intended Audience :: Healthcare Industry",
19
+ "Intended Audience :: Education",
20
+ "Intended Audience :: Science/Research",
21
+ "Intended Audience :: Information Technology",
22
+ "Topic :: Software Development :: Libraries :: Python Modules",
23
+ "Topic :: Utilities",
24
+ "Topic :: Scientific/Engineering",
25
+ "Topic :: Education",
26
+ "Topic :: Internet :: WWW/HTTP :: Indexing/Search",
27
+ "Topic :: Internet :: WWW/HTTP :: Site Management",
28
+ "Topic :: Internet :: WWW/HTTP",
29
+ "Topic :: Software Development :: Libraries",
30
+ "Topic :: Software Development :: Libraries :: Application Frameworks",
31
+ "Topic :: Internet",
32
+ "Topic :: Communications",
33
+ "Topic :: Office/Business",
34
+ "Topic :: Text Processing",
35
+ "Topic :: Security",
36
+ "Topic :: Database",
37
+ "Topic :: Software Development :: Code Generators",
38
+ "Topic :: Software Development :: Pre-processors",
39
+ "Topic :: Software Development :: Quality Assurance",
40
+ "Topic :: Software Development :: Testing",
41
+ "Natural Language :: English",
42
+ ]
43
+
44
+ [project.urls]
45
+ Homepage = "https://apiverve.com"
apiverve_reversegeocode-1.0.11/setup.cfg ADDED
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
apiverve_reversegeocode-1.0.11/src/apiverve_reversegeocode/__init__.py ADDED
@@ -0,0 +1 @@
1
+ from .apiClient import ReversegeocodeAPIClient
apiverve_reversegeocode-1.0.11/src/apiverve_reversegeocode/apiClient.py ADDED
@@ -0,0 +1,38 @@
1
+ import requests
2
+
3
+ class ReversegeocodeAPIClient:
4
+ def __init__(self, api_key, secure=True):
5
+ """
6
+ Initialize the ReversegeocodeAPIClient with the API key and secure flag
7
+ :param api_key: API key
8
+ :param secure: Deprecated. Always set to True
9
+ """
10
+
11
+ self.api_key = api_key
12
+ self.secure = secure
13
+ self.base_url = 'https://api.apiverve.com/v1/reversegeocode'
14
+ self.headers = {
15
+ 'x-api-key': self.api_key,
16
+ 'auth-mode': 'pypi'
17
+ }
18
+
19
+ def execute(self, params=None):
20
+ """
21
+ Execute the API request
22
+ :param params: API parameters, if any
23
+ :return: API response
24
+ """
25
+
26
+ method = "GET"
27
+
28
+ try:
29
+ if method.upper() == 'POST':
30
+ response = requests.post(self.base_url, headers=self.headers, json=params)
31
+ else:
32
+ response = requests.get(self.base_url, headers=self.headers, params=params)
33
+
34
+ response.raise_for_status()
35
+ return response.json()
36
+ except requests.exceptions.RequestException as e:
37
+ print(f"An error occurred: {e}")
38
+ raise e
apiverve_reversegeocode-1.0.11/src/apiverve_reversegeocode/exceptions.py ADDED
@@ -0,0 +1,3 @@
1
+ class ReversegeocodeReverseGeocodeAPIError(Exception):
2
+ """A custom exception for API errors"""
3
+ pass
apiverve_reversegeocode-1.0.11/src/apiverve_reversegeocode/setup.py ADDED
@@ -0,0 +1,21 @@
1
+ from setuptools import setup, find_packages
2
+
3
+ setup(
4
+ name='apiverve_reversegeocode',
5
+ version='1.0.11',
6
+ packages=find_packages(),
7
+ include_package_data=True,
8
+ install_requires=[
9
+ 'requests',
10
+ 'setuptools'
11
+ ],
12
+ description='Reverse Geocode is a simple tool for getting the location of a set of coordinates. Only supports USA and Canada Coordinates. It returns the city, state, and more.',
13
+ author='APIVerve',
14
+ author_email='hello@apiverve.com',
15
+ url='https://apiverve.com',
16
+ classifiers=[
17
+ 'Programming Language :: Python :: 3',
18
+ 'Operating System :: OS Independent',
19
+ ],
20
+ python_requires='>=3.6',
21
+ )
apiverve_reversegeocode-1.0.11/src/apiverve_reversegeocode/tests/__init__.py ADDED
@@ -0,0 +1 @@
1
+ # Initialize test module
apiverve_reversegeocode-1.0.11/src/apiverve_reversegeocode/tests/test_api.py ADDED
@@ -0,0 +1,19 @@
1
+ import unittest
2
+ from apiverve_reversegeocode.apiClient import ReversegeocodeAPIClient
3
+
4
+ class TestClient(unittest.TestCase):
5
+
6
+ def setUp(self):
7
+ self.api_key = 'test_api_key'
8
+ self.client = ReversegeocodeAPIClient(self.api_key)
9
+
10
+ def test_get(self):
11
+ # Assuming there's an endpoint 'test_endpoint' for testing purposes
12
+ try:
13
+ response = self.client.get('test_endpoint')
14
+ self.assertIsInstance(response, dict)
15
+ except Exception as e:
16
+ self.fail(f"GET request failed with exception {e}")
17
+
18
+ if __name__ == '__main__':
19
+ unittest.main()
apiverve_reversegeocode-1.0.11/src/apiverve_reversegeocode.egg-info/PKG-INFO ADDED
@@ -0,0 +1,163 @@
1
+ Metadata-Version: 2.1
2
+ Name: apiverve-reversegeocode
3
+ Version: 1.0.11
4
+ Summary: Reverse Geocode is a simple tool for getting the location of a set of coordinates. Only supports USA and Canada Coordinates. It returns the city, state, and more.
5
+ Author-email: APIVerve <hello@apiverve.com>
6
+ Project-URL: Homepage, https://apiverve.com
7
+ Keywords: reverse geocode,reverse geocode api,reverse geocode tool,reverse geocode software,reverse geocode service
8
+ Classifier: Development Status :: 5 - Production/Stable
9
+ Classifier: Programming Language :: Python :: 3
10
+ Classifier: License :: OSI Approved :: MIT License
11
+ Classifier: Operating System :: OS Independent
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Intended Audience :: Financial and Insurance Industry
14
+ Classifier: Intended Audience :: Healthcare Industry
15
+ Classifier: Intended Audience :: Education
16
+ Classifier: Intended Audience :: Science/Research
17
+ Classifier: Intended Audience :: Information Technology
18
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
19
+ Classifier: Topic :: Utilities
20
+ Classifier: Topic :: Scientific/Engineering
21
+ Classifier: Topic :: Education
22
+ Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
23
+ Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
24
+ Classifier: Topic :: Internet :: WWW/HTTP
25
+ Classifier: Topic :: Software Development :: Libraries
26
+ Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
27
+ Classifier: Topic :: Internet
28
+ Classifier: Topic :: Communications
29
+ Classifier: Topic :: Office/Business
30
+ Classifier: Topic :: Text Processing
31
+ Classifier: Topic :: Security
32
+ Classifier: Topic :: Database
33
+ Classifier: Topic :: Software Development :: Code Generators
34
+ Classifier: Topic :: Software Development :: Pre-processors
35
+ Classifier: Topic :: Software Development :: Quality Assurance
36
+ Classifier: Topic :: Software Development :: Testing
37
+ Classifier: Natural Language :: English
38
+ Requires-Python: >=3.12
39
+ Description-Content-Type: text/markdown
40
+ License-File: LICENSE
41
+
42
+ Reverse Geocode API
43
+ ============
44
+
45
+ Reverse Geocode is a simple tool for getting the location of a set of coordinates. Only supports USA and Canada Coordinates. It returns the city, state, and more.
46
+
47
+ ![Build Status](https://img.shields.io/badge/build-passing-green)
48
+ ![Code Climate](https://img.shields.io/badge/maintainability-B-purple)
49
+ ![Prod Ready](https://img.shields.io/badge/production-ready-blue)
50
+
51
+ This is a Python API Wrapper for the [Reverse Geocode API](https://apiverve.com/marketplace/api/reversegeocode)
52
+
53
+ ---
54
+
55
+ ## Installation
56
+ pip install apiverve-reversegeocode
57
+
58
+ ---
59
+
60
+ ## Configuration
61
+
62
+ Before using the reversegeocode API client, you have to setup your account and obtain your API Key.
63
+ You can get it by signing up at [https://apiverve.com](https://apiverve.com)
64
+
65
+ ---
66
+
67
+ ## Usage
68
+
69
+ The Reverse Geocode API documentation is found here: [https://docs.apiverve.com/api/reversegeocode](https://docs.apiverve.com/api/reversegeocode).
70
+ You can find parameters, example responses, and status codes documented here.
71
+
72
+ ### Setup
73
+
74
+ ```
75
+ # Import the client module
76
+ from apiverve_reversegeocode.apiClient import ReversegeocodeAPIClient
77
+
78
+ # Initialize the client with your APIVerve API key
79
+ api = ReversegeocodeAPIClient("[YOUR_API_KEY]")
80
+ ```
81
+
82
+ ---
83
+
84
+
85
+ ### Perform Request
86
+ Using the API client, you can perform requests to the API.
87
+
88
+ ###### Define Query
89
+
90
+ ```
91
+ query = { "lat": 40.714224, "lon": -73.961452 }
92
+ ```
93
+
94
+ ###### Simple Request
95
+
96
+ ```
97
+ # Make a request to the API
98
+ result = api.execute(query)
99
+
100
+ # Print the result
101
+ print(result)
102
+ ```
103
+
104
+ ###### Example Response
105
+
106
+ ```
107
+ {
108
+ "status": "ok",
109
+ "error": null,
110
+ "data": {
111
+ "zipcode": "11211",
112
+ "state_abbr": "NY",
113
+ "city": "Brooklyn",
114
+ "state": "New York",
115
+ "distance": 0.65017573007586638,
116
+ "latitudeClosest": "40.712090",
117
+ "longitudeClosest": "-73.95427",
118
+ "countryCode": "US",
119
+ "latitudeClosestCity": null,
120
+ "longitudeClosestCity": null,
121
+ "latitude": 40.714224,
122
+ "longitude": -73.961452,
123
+ "estimatedCity": true,
124
+ "nearestCities": [
125
+ "Brooklyn",
126
+ "Brooklyn Park",
127
+ "East Brooklyn",
128
+ "Brooklyn Center",
129
+ "Brooklyn Heights"
130
+ ]
131
+ }
132
+ }
133
+ ```
134
+
135
+ ---
136
+
137
+ ## Customer Support
138
+
139
+ Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).
140
+
141
+ ---
142
+
143
+ ## Updates
144
+ Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
145
+
146
+ ---
147
+
148
+ ## Legal
149
+
150
+ All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms) and all legal documents and agreements.
151
+
152
+ ---
153
+
154
+ ## License
155
+ Licensed under the The MIT License (MIT)
156
+
157
+ Copyright (&copy;) 2024 APIVerve, and Evlar LLC
158
+
159
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
160
+
161
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
162
+
163
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
apiverve_reversegeocode-1.0.11/src/apiverve_reversegeocode.egg-info/SOURCES.txt ADDED
@@ -0,0 +1,14 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ src/apiverve_reversegeocode/__init__.py
5
+ src/apiverve_reversegeocode/apiClient.py
6
+ src/apiverve_reversegeocode/exceptions.py
7
+ src/apiverve_reversegeocode/setup.py
8
+ src/apiverve_reversegeocode.egg-info/PKG-INFO
9
+ src/apiverve_reversegeocode.egg-info/SOURCES.txt
10
+ src/apiverve_reversegeocode.egg-info/dependency_links.txt
11
+ src/apiverve_reversegeocode.egg-info/top_level.txt
12
+ src/apiverve_reversegeocode/tests/__init__.py
13
+ src/apiverve_reversegeocode/tests/test_api.py
14
+ tests/test_api.py
apiverve_reversegeocode-1.0.11/tests/test_api.py ADDED
@@ -0,0 +1,27 @@
1
+ import unittest
2
+ from apiverve_reversegeocode.apiClient import ReversegeocodeAPIClient
3
+ from unittest.mock import patch
4
+
5
+ class TestReversegeocodeAPIClient(unittest.TestCase):
6
+
7
+ def setUp(self):
8
+ self.api_key = 'test_api_key'
9
+ self.client = ReversegeocodeAPIClient(self.api_key)
10
+
11
+ @patch('apiverve_reversegeocode.apiClient.requests.get')
12
+ def test_make_request_success(self, mock_get):
13
+ # Assuming there's an endpoint 'test_endpoint' for testing purposes
14
+ mock_get.return_value.status_code = 200
15
+ mock_get.return_value.json.return_value = {'test': 'test'}
16
+ response = self.client.get('test_endpoint')
17
+ self.assertIsInstance(response, dict)
18
+
19
+ @patch('apiverve_reversegeocode.apiClient.requests.get')
20
+ def test_make_request_failure(self, mock_get):
21
+ # Assuming there's an endpoint 'test_endpoint' for testing purposes
22
+ mock_get.return_value.status_code = 404
23
+ with self.assertRaises(Exception):
24
+ self.client.get('test_endpoint')
25
+
26
+ if __name__ == '__main__':
27
+ unittest.main()