polyanalyst6api 0.35.1__tar.gz → 0.35.3__tar.gz

{polyanalyst6api-0.35.1 → polyanalyst6api-0.35.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: polyanalyst6api
-Version: 0.35.1
+Version: 0.35.3
 Summary: polyanalyst6api is a PolyAnalyst API client for Python.
 Home-page: https://github.com/Megaputer/polyanalyst6api-py
 License: MIT
@@ -16,10 +16,11 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Internet
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: pytus (>=0.2.1,<0.3.0)
-Requires-Dist: requests (>=2.28,<3.0)
+Requires-Dist: requests (>=2.31,<3.0)
 Requires-Dist: urllib3 (==1.26.18) ; python_version == "3.7"
 Requires-Dist: urllib3 ; python_version >= "3.8"
 Project-URL: Changelog, https://github.com/Megaputer/polyanalyst6api-py/blob/master/CHANGELOG.md
@@ -33,78 +34,59 @@ Description-Content-Type: text/markdown
 [![Supported Python versions](https://img.shields.io/pypi/pyversions/polyanalyst6api)](https://pypi.org/project/polyanalyst6api/)
 [![MIT License](https://img.shields.io/github/license/megaputer/polyanalyst6api-py)](https://github.com/Megaputer/polyanalyst6api-py/blob/master/LICENSE)
 
-**_polyanalyst6api_ is a simple and easy to use client library for the PolyAnalyst API.**
+Welcome to the official Python client library for the PolyAnalyst REST API.
 
-This package provides wrappers for PolyAnalyst `Analytical Client`, `Scheduler` and `Drive`.
-Using it you can execute nodes, view datasets, run tasks, download/upload files and so on.
+This package provides python wrappers for PolyAnalyst applications, such as *Analytical Client*, *Scheduler*, *Drive*.
+Using `polyanalyst6api` you can access and edit projects, publications, files and more.
 
 ## Installation
 
-Python 3.7+ is required. Install and upgrade `polyanalyst6api` with these commands:
-
 ```shell
-pip install polyanalyst6api
-pip install --upgrade polyanalyst6api
+pip install -u polyanalyst6api
 ```
+> Python 3.7 or later is required.
 
 ## Documentation
 
 See [API Reference](https://polyanalyst6api-py.rtfd.io) for the client library methods.
 
-Refer to **PolyAnalyst User Manual** at **Application Programming Interfaces** > **Version 01** for REST API specification.
+Refer to PolyAnalyst's **User Manual** at **Application Programming Interfaces** > **Version 1** for REST API specification.
 
 ## Usage
 
-Import an api client and log in to PolyAnalyst server
-
+Import and initialize a client:
 ```python
 from polyanalyst6api import API
 
-with API(POLYANALIST_URL, USERNAME, PASSWORD) as api:
-    # making a request to PolyAnalyst endpoint that require authorization
-    print(api.get_server_info())
-```
+# using an api token
+client = API(<POLYANALIST_URL>, token=<API_TOKEN>)
 
-### Working with project
-
-Instantiate project wrapper by calling with existing project ID:
-```python
-prj = api.project(PROJECT_UUID)
-```
-
-Set `Python` node code using parent `Parameters` node.
-```python
-prj.parameters('Parameters (1)').set(
-    'Dataset/Python',
-    {'Script': 'result = pandas.DataFrame([{"val": 42}])'}
-)
-```
-
-Execute `Python` node and wait to complete execution
-```python
-prj.execute('Python', wait=True)
-```
-
-Check node results:
-```python
-ds = prj.dataset('Python').preview()
-assert ds[0]['val'] == 42
-```
-
-Save project:
-```python
-prj.save()
+# or using PolyAnalyst user credentials. Note that in this case you need to call .login()
+client = API(<POLYANALIST_URL>, <USERNAME>, <PASSWORD>)
+client.login()
 ```
 
-### Downloading file from user home folder using PA Drive API
+Request data using client methods:
 
 ```python
-content = api.drive.download_file('README.txt')
-with open(r'C:\README.txt', mode='wb+') as local_file:
-    local_file.write(content)
+>>> prj = client.project(<prjUUID>)
+>>> prj.status()
+{'status': 'Loaded'}
+
+>>> prj.get_node_list()
+[{'id': 11,
+  'name': 'Internet Source',
+  'status': 'synchronized',
+  'subtype': 'INET',
+  'type': 'DataSource'},
+ {'id': 12,
+  'name': 'Python',
+  'status': 'synchronized',
+  'subtype': 'Python',
+  'type': 'Dataset'}]
 ```
 
-See [polyanalyst6api-python/examples](https://github.com/Megaputer/polyanalyst6api-py/tree/master/examples) for more complex examples.
+View the [examples](https://github.com/Megaputer/polyanalyst6api-py/tree/master/examples) directory for more code snippets.
 
 ## License
 

polyanalyst6api-0.35.3/README.md

@@ -0,0 +1,63 @@
+[![Telegram Group](https://img.shields.io/badge/support-join-blue?logo=telegram)](https://t.me/+_AdHkBRnul4xZTg6)
+[![PyPI package](https://img.shields.io/pypi/v/polyanalyst6api)](https://pypi.org/project/polyanalyst6api)
+[![Downloads](https://static.pepy.tech/badge/polyanalyst6api/month)](https://pepy.tech/project/polyanalyst6api)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/polyanalyst6api)](https://pypi.org/project/polyanalyst6api/)
+[![MIT License](https://img.shields.io/github/license/megaputer/polyanalyst6api-py)](https://github.com/Megaputer/polyanalyst6api-py/blob/master/LICENSE)
+
+Welcome to the official Python client library for the PolyAnalyst REST API.
+
+This package provides python wrappers for PolyAnalyst applications, such as *Analytical Client*, *Scheduler*, *Drive*.
+Using `polyanalyst6api` you can access and edit projects, publications, files and more.
+
+## Installation
+
+```shell
+pip install -u polyanalyst6api
+```
+> Python 3.7 or later is required.
+
+## Documentation
+
+See [API Reference](https://polyanalyst6api-py.rtfd.io) for the client library methods.
+
+Refer to PolyAnalyst's **User Manual** at **Application Programming Interfaces** > **Version 1** for REST API specification.
+
+## Usage
+
+Import and initialize a client:
+```python
+from polyanalyst6api import API
+
+# using an api token
+client = API(<POLYANALIST_URL>, token=<API_TOKEN>)
+
+# or using PolyAnalyst user credentials. Note that in this case you need to call .login()
+client = API(<POLYANALIST_URL>, <USERNAME>, <PASSWORD>)
+client.login()
+```
+
+Request data using client methods:
+
+```python
+>>> prj = client.project(<prjUUID>)
+>>> prj.status()
+{'status': 'Loaded'}
+
+>>> prj.get_node_list()
+[{'id': 11,
+  'name': 'Internet Source',
+  'status': 'synchronized',
+  'subtype': 'INET',
+  'type': 'DataSource'},
+ {'id': 12,
+  'name': 'Python',
+  'status': 'synchronized',
+  'subtype': 'Python',
+  'type': 'Dataset'}]
+```
+
+View the [examples](https://github.com/Megaputer/polyanalyst6api-py/tree/master/examples) directory for more code snippets.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/Megaputer/polyanalyst6api-py/tree/master/LICENSE) file for details

{polyanalyst6api-0.35.1 → polyanalyst6api-0.35.3}/polyanalyst6api/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '0.35.1'
+__version__ = '0.35.2'
 
 from .api import *
 from .exceptions import *

{polyanalyst6api-0.35.1 → polyanalyst6api-0.35.3}/polyanalyst6api/api.py

@@ -116,6 +116,8 @@ class API:
         )
         self._s.mount('http://', adapter)
         self._s.mount('https://', adapter)
+        # do not retry SSLError. without this login takes ~30 seconds to throw an error
+        self._s.mount('https://', HTTPAdapter(max_retries=urllib3.util.Retry(0, status_forcelist=[495])))
         self._s.verify = kwargs.get('verify', True)
         self._s.headers.update({'User-Agent': self.user_agent})
 
@@ -256,7 +258,7 @@ class API:
             time.sleep(1)
             status = self.get_project_import_status(import_id)
             # status has only empty state key when the server rebooted during the project import: T32492#776729
-            if status.get('state') in ('Error', 'Imported'):
+            if status.get('state') in ('Error', 'Imported', 'Cancelled'):
                 return status
 
     def project(self, uuid: str) -> Project:

{polyanalyst6api-0.35.1 → polyanalyst6api-0.35.3}/polyanalyst6api/project.py

@@ -277,6 +277,14 @@ class Project:
         .. versionadded:: 0.31
         """
         return self.api.get('project/status', params={'prjUUID': self.uuid})
+    
+    def info(self):
+        """This operation returns information about a project.
+        
+        :return: project information
+        """
+        return self.api.get('project/info', params={'prjUUID': self.uuid})
+        
 
     def unload(self, force_unload: bool = False) -> None:
         """

{polyanalyst6api-0.35.1 → polyanalyst6api-0.35.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "polyanalyst6api"
-version = "0.35.1"
+version = "0.35.3"
 description = "polyanalyst6api is a PolyAnalyst API client for Python."
 authors = ["yatmanov <yatmanov@megaputer.ru>"]
 license = "MIT"
@@ -21,7 +21,7 @@ classifiers = [
 
 [tool.poetry.dependencies]
 python = "^3.7"
-requests = "^2.28"
+requests = "^2.31"
 pytus = "^0.2.1"
 urllib3 = [
     {version = "1.26.18", python = "3.7"},
@@ -33,12 +33,4 @@ pytest = "^7.4.0"
 
 [tool.poetry.group.docs.dependencies]
 sphinx = {version = "^7.0.1", python = "3.11"}
-towncrier = "^23.6.0"
 sphinx-autodoc-typehints = {version = "^1.23.3", python = "3.11"}
-
-[tool.towncrier]
-package = "polyanalyst6api"
-package_dir = "polyanalyst6api"
-filename = "CHANGELOG.md"
-directory = ".changes"
-title_format = "{version} ({project_date})"

polyanalyst6api-0.35.1/README.md

@@ -1,82 +0,0 @@
-[![Telegram Group](https://img.shields.io/badge/support-join-blue?logo=telegram)](https://t.me/+_AdHkBRnul4xZTg6)
-[![PyPI package](https://img.shields.io/pypi/v/polyanalyst6api)](https://pypi.org/project/polyanalyst6api)
-[![Downloads](https://static.pepy.tech/badge/polyanalyst6api/month)](https://pepy.tech/project/polyanalyst6api)
-[![Supported Python versions](https://img.shields.io/pypi/pyversions/polyanalyst6api)](https://pypi.org/project/polyanalyst6api/)
-[![MIT License](https://img.shields.io/github/license/megaputer/polyanalyst6api-py)](https://github.com/Megaputer/polyanalyst6api-py/blob/master/LICENSE)
-
-**_polyanalyst6api_ is a simple and easy to use client library for the PolyAnalyst API.**
-
-This package provides wrappers for PolyAnalyst `Analytical Client`, `Scheduler` and `Drive`.
-Using it you can execute nodes, view datasets, run tasks, download/upload files and so on.
-
-## Installation
-
-Python 3.7+ is required. Install and upgrade `polyanalyst6api` with these commands:
-
-```shell
-pip install polyanalyst6api
-pip install --upgrade polyanalyst6api
-```
-
-## Documentation
-
-See [API Reference](https://polyanalyst6api-py.rtfd.io) for the client library methods.
-
-Refer to **PolyAnalyst User Manual** at **Application Programming Interfaces** > **Version 01** for REST API specification.
-
-## Usage
-
-Import an api client and log in to PolyAnalyst server
-
-```python
-from polyanalyst6api import API
-
-with API(POLYANALIST_URL, USERNAME, PASSWORD) as api:
-    # making a request to PolyAnalyst endpoint that require authorization
-    print(api.get_server_info())
-```
-
-### Working with project
-
-Instantiate project wrapper by calling with existing project ID:
-```python
-prj = api.project(PROJECT_UUID)
-```
-
-Set `Python` node code using parent `Parameters` node.
-```python
-prj.parameters('Parameters (1)').set(
-    'Dataset/Python',
-    {'Script': 'result = pandas.DataFrame([{"val": 42}])'}
-)
-```
-
-Execute `Python` node and wait to complete execution
-```python
-prj.execute('Python', wait=True)
-```
-
-Check node results:
-```python
-ds = prj.dataset('Python').preview()
-assert ds[0]['val'] == 42
-```
-
-Save project:
-```python
-prj.save()
-```
-
-### Downloading file from user home folder using PA Drive API
-
-```python
-content = api.drive.download_file('README.txt')
-with open(r'C:\README.txt', mode='wb+') as local_file:
-    local_file.write(content)
-```
-
-See [polyanalyst6api-python/examples](https://github.com/Megaputer/polyanalyst6api-py/tree/master/examples) for more complex examples.
-
-## License
-
-This project is licensed under the MIT License - see the [LICENSE](https://github.com/Megaputer/polyanalyst6api-py/tree/master/LICENSE) file for details