pygeobox 1.0.0__tar.gz → 1.0.2__tar.gz

{pygeobox-1.0.0 → pygeobox-1.0.2}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 Geobox
-
-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:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-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.
+MIT License
+
+Copyright (c) 2023 Geobox
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

{pygeobox-1.0.0 → pygeobox-1.0.2}/PKG-INFO

@@ -1,12 +1,11 @@
 Metadata-Version: 2.4
 Name: pygeobox
-Version: 1.0.0
+Version: 1.0.2
 Summary: SDK for Geobox's APIs
-Home-page: https://gitlab.com/geobox-sdks/pygeobox.git
-Author: Hamid Heydari
 Author-email: Hamid Heydari <heydari.h62@gmail.com>
 License: MIT
-Project-URL: Homepage, https://gitlab.com/geobox-sdks/pygeobox.git
+Project-URL: Homepage, https://geobox.ir
+Project-URL: Documentation, https://geobox.ir
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -30,18 +29,11 @@ Requires-Dist: sphinx-copybutton; extra == "docs"
 Provides-Extra: all
 Requires-Dist: shapely; extra == "all"
 Requires-Dist: pyproj; extra == "all"
-Requires-Dist: pytest; extra == "all"
-Requires-Dist: pytest-cov; extra == "all"
 Requires-Dist: tqdm; extra == "all"
 Requires-Dist: ipywidgets; extra == "all"
-Requires-Dist: Sphinx; extra == "all"
-Requires-Dist: sphinx-rtd-theme; extra == "all"
-Requires-Dist: sphinx-copybutton; extra == "all"
-Dynamic: author
-Dynamic: home-page
 Dynamic: license-file
 
-[<img width="200" alt="Geobox logo" src="LOGO.png">](https://www.geobox.ir/)
+[<img width="200" alt="Geobox logo" src="https://www.geobox.ir/wp-content/uploads/2022/05/geologo-slider.png">](https://www.geobox.ir/)
 
 # Geobox
 SDK for Geobox's APIs
@@ -49,46 +41,45 @@ SDK for Geobox's APIs
 Installation
 ============
 
-Clone the Repo, cd Into the Repo Folder, Create and Enable Virtualenv, Install Dependencies and Run Tests:
+Enable Virtualenv, Install Dependencies and Run Tests:
 
 ```
-cd geobox
-python -m venv .venv
-source .venv/bin/activate
-pip install -e .
+pip install pygeobox
 ```
 
 Install with Geometry Dependencies
 
 ```
-pip install -e .[geometry]
+pip install pygeobox[geometry]
 ```
+```
+from pygeobox import GeoboxClient
 
-Install with Documentation Dependencies
+client = GeoboxClient()
 
-```
-pip install -e .[docs]
-cd geobox_docs
-make.bat html
+layer = client.get_vectors(search='tehran')[0]
+features = layer.get_feature(feature_id=1)
+geom = feature.geometry
 ```
 
-Install with Test Dependencies
+Install with Progress Bar Support
 
 ```
-pip install -e .[test]
-pytest -vv
+pip install pygeobox[tqdm]
 ```
+```
+from pygeobox import GeoboxClient
 
-and generate coverage report
+client = GeoboxClient()
 
-```
-pytest --cov=geobox --cov-report=html
+task = client.geet_tasks()[0]
+task.wait() # shows progress bar by default. use progress_bar=False to disable it.
 ```
 
 Install with All Available Dependencies
 
 ```
-pip install -e .[all]
+pip install pygeobox[all]
 ```
 
 
@@ -96,7 +87,7 @@ Example
 =======
 
 ```
-from geobox import GeoboxClient
+from pygeobox import GeoboxClient
 
 client = GeoboxClient()
 

pygeobox-1.0.2/README.md

@@ -0,0 +1,62 @@
+[<img width="200" alt="Geobox logo" src="https://www.geobox.ir/wp-content/uploads/2022/05/geologo-slider.png">](https://www.geobox.ir/)
+
+# Geobox
+SDK for Geobox's APIs
+
+Installation
+============
+
+Enable Virtualenv, Install Dependencies and Run Tests:
+
+```
+pip install pygeobox
+```
+
+Install with Geometry Dependencies
+
+```
+pip install pygeobox[geometry]
+```
+```
+from pygeobox import GeoboxClient
+
+client = GeoboxClient()
+
+layer = client.get_vectors(search='tehran')[0]
+features = layer.get_feature(feature_id=1)
+geom = feature.geometry
+```
+
+Install with Progress Bar Support
+
+```
+pip install pygeobox[tqdm]
+```
+```
+from pygeobox import GeoboxClient
+
+client = GeoboxClient()
+
+task = client.geet_tasks()[0]
+task.wait() # shows progress bar by default. use progress_bar=False to disable it.
+```
+
+Install with All Available Dependencies
+
+```
+pip install pygeobox[all]
+```
+
+
+Example
+=======
+
+```
+from pygeobox import GeoboxClient
+
+client = GeoboxClient()
+
+layer = client.get_vectors(search='tehran')[0]
+features = layer.get_features(out_srid=4326, bbox_srid=4326)
+fields = layer.get_fields()
+```

{pygeobox-1.0.0 → pygeobox-1.0.2}/pygeobox/__init__.py

@@ -1,63 +1,63 @@
-"""
-GeoBox SDK
-
-This package provides classes and functions to interact with the GeoBox API.
-
-Modules:
-    api (module): Contains the Api class for making API requests.
-    vectors (module): Contains classes for interacting with vector layers, fields, and features.
-    exception (module): Contains custom exception classes for error handling.
-
-Classes:
-    Api: A class to interact with the GeoBox API.
-    VectorLayers: A class to interact with vector layers in the GeoBox API.
-    Fields: A class to interact with fields in a vector layer.
-    Features: A class to interact with features in a vector layer.
-    GeoboxError: Base class for all exceptions raised by the GeoBox SDK.
-    AuthenticationError: Raised when there is an authentication error.
-    AuthorizationError: Raised when there is an authorization error.
-    ApiRequestError: Raised when there is an error with the API request.
-    NotFoundError: Raised when a requested resource is not found.
-    ValidationError: Raised when there is a validation error.
-    ServerError: Raised when there is a server error.
-"""
-import logging, os, dotenv
-from .api import GeoboxClient
-
-from .exception import (
-    GeoboxError,
-    AuthenticationError,
-    AuthorizationError,
-    ApiRequestError,
-    NotFoundError,
-    ValidationError,
-    ServerError
-)
-
-dotenv.load_dotenv()
-DEBUG = os.getenv('DEBUG', 'False').lower() == 'true'
-
-logger = logging.getLogger(__name__)
-if DEBUG:
-    logging.basicConfig(
-        level=logging.DEBUG,
-        format="%(asctime)s - %(name)s - %(levelname)s - %(message)s"
-    )
-    logger.info("Logging is set to DEBUG level.")
-else:
-    logging.basicConfig(level=logging.WARNING)
-
-
-__all__ = [
-    'GeoboxClient',
-    'Feature',
-    'VectorLayer',
-    'GeoboxError',
-    'AuthenticationError',
-    'AuthorizationError',
-    'ApiRequestError',
-    'NotFoundError',
-    'ValidationError',
-    'ServerError'
-]
-
+"""
+GeoBox SDK
+
+This package provides classes and functions to interact with the GeoBox API.
+
+Modules:
+    api (module): Contains the Api class for making API requests.
+    vectors (module): Contains classes for interacting with vector layers, fields, and features.
+    exception (module): Contains custom exception classes for error handling.
+
+Classes:
+    Api: A class to interact with the GeoBox API.
+    VectorLayers: A class to interact with vector layers in the GeoBox API.
+    Fields: A class to interact with fields in a vector layer.
+    Features: A class to interact with features in a vector layer.
+    GeoboxError: Base class for all exceptions raised by the GeoBox SDK.
+    AuthenticationError: Raised when there is an authentication error.
+    AuthorizationError: Raised when there is an authorization error.
+    ApiRequestError: Raised when there is an error with the API request.
+    NotFoundError: Raised when a requested resource is not found.
+    ValidationError: Raised when there is a validation error.
+    ServerError: Raised when there is a server error.
+"""
+import logging, os, dotenv
+from .api import GeoboxClient
+
+from .exception import (
+    GeoboxError,
+    AuthenticationError,
+    AuthorizationError,
+    ApiRequestError,
+    NotFoundError,
+    ValidationError,
+    ServerError
+)
+
+dotenv.load_dotenv()
+DEBUG = os.getenv('DEBUG', 'False').lower() == 'true'
+
+logger = logging.getLogger(__name__)
+if DEBUG:
+    logging.basicConfig(
+        level=logging.DEBUG,
+        format="%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+    )
+    logger.info("Logging is set to DEBUG level.")
+else:
+    logging.basicConfig(level=logging.WARNING)
+
+
+__all__ = [
+    'GeoboxClient',
+    'Feature',
+    'VectorLayer',
+    'GeoboxError',
+    'AuthenticationError',
+    'AuthorizationError',
+    'ApiRequestError',
+    'NotFoundError',
+    'ValidationError',
+    'ServerError'
+]
+