polypheny 0.2.0__tar.gz → 2.0.0__tar.gz

polypheny-2.0.0/MANIFEST.in

@@ -0,0 +1 @@
+include polypheny-connector-version.txt

{polypheny-0.2.0 → polypheny-2.0.0}/PKG-INFO

@@ -1,35 +1,37 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: polypheny
-Version: 0.2.0
-Summary: Polypheny Connector for Python
-Home-page: https://polypheny.org/
+Version: 2.0.0
+Summary: Driver for Polypheny
+Home-page: https://polypheny.com/
 Author: The Polypheny Project
 Author-email: mail@polypheny.org
 License: Apache License, Version 2.0
-Project-URL: Documentation, https://polypheny.org/documentation/
+Project-URL: Documentation, https://docs.polypheny.com/en/latest/drivers/python/overview
 Project-URL: Code, https://github.com/polypheny/Polypheny-Connector-Python
 Project-URL: Issue tracker, https://github.com/polypheny/Polypheny-DB/labels/A-python
-Platform: UNKNOWN
-Classifier: Programming Language :: Python :: 3.6
-Requires-Python: >=3.6
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-
-<!--<p align="center">
-<picture>
-  <source 
-    srcset="https://raw.githubusercontent.com/polypheny/Admin/master/Logo/logo-white-text.png" 
-    media="(prefers-color-scheme: dark)">
-  <a href="https://polypheny.org/">
-    <img align="center" width="300" height="300" src="https://raw.githubusercontent.com/polypheny/Admin/master/Logo/logo-transparent.png">
-   </a>
-</picture>
-</p>
--->
-
-<a href="https://polypheny.org/">
-    <img align="right" width="300" height="300" src="https://raw.githubusercontent.com/polypheny/Admin/master/Logo/logo-transparent.png" alt="Resume application project app icon">
-</a>
+Requires-Dist: polypheny-prism-api==2.2
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+<p align="center">
+    <a href="https://polypheny.org/">
+        <picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/polypheny/Admin/master/Logo/logo-white-text_cropped.png">
+            <img width='50%' alt="Light: 'Resume application project app icon' Dark: 'Resume application project app icon'" src="https://raw.githubusercontent.com/polypheny/Admin/master/Logo/logo-transparent_cropped.png">
+        </picture>
+    </a>    
+</p> 
 
 
 # Polypheny Connector for Python
@@ -37,7 +39,7 @@ License-File: LICENSE
 This enables Python programs to access Polypheny databases, using an API that is compliant with the [Python Database API Specification v2.0 (PEP 249)](https://www.python.org/dev/peps/pep-0249/).
 
 
-### Installation
+## Installation
 
 The recommended way to install the Python Connector for Polypheny is via pip:
 ```bash
@@ -50,6 +52,9 @@ cd /path/to/polyphney-connector-python-x.y.z/
 python setup.py install
 ```
 
+The connector uses the Prism 2.2 client definitions and connects to servers
+that report a compatible Prism 2.x API. The minor versions do not have to match.
+Document collection metadata requires server-side support introduced in Prism 2.2.
 
 
 ## Getting Started
@@ -57,33 +62,57 @@ python setup.py install
 A few examples of the most common functionalities provided by the adapter:
 
 
-```python
+```python3
 import polypheny
 
-# Connect to Polypheny
-connection = polypheny.connect('localhost', 20591, user='pa', password='')
+# Connect to locally running Polypheny via UNIX sockets (on Linux, BSD and macOS)
+con = polypheny.connect()
+
+# Unencrypted over the network (all systems)
+con = polypheny.connect(
+  ('127.0.0.1', 20590),
+  username='pa',
+  password='',
+  transport='plain',
+)
 
 # Get a cursor
-cursor = connection.cursor()
+cursor = con.cursor()
 
 # Create a new table
 cursor.execute("CREATE TABLE dummy (id INT NOT NULL, text VARCHAR(2), num INT, PRIMARY KEY(id))")
 
 # Insert values into table
 cursor.execute("INSERT INTO dummy VALUES (407 , 'de', 93)")
-connection.commit()
+con.commit()
 
 # Execute a query
 cursor.execute("SELECT * from dummy")
-result = cursor.fetchall()
+
+print("\nRelational results from SQL")
+for row in cursor:
+    print("\t", row)
+
+# Accessing data using MQL
+cursor.executeany('mongo', 'db.dummy.find()', namespace='public')
+
+print("\nDocument results from MQL (as Python dicts)")
+for doc in cursor:
+    print("\t", doc)
+
+cursor.execute("DROP TABLE dummy")
 
 # Close the connection
-connection.close()
+con.close()
 ```
 
-An in-depth and more detailed documentation can be found [here]()
-
+An in-depth and more detailed documentation can be found [here](https://docs.polypheny.com/en/latest/drivers/python/overview).
 
+## Tests
+Run the tests with coverage report:
+```
+coverage run --source polypheny -m pytest && coverage report -m
+```
 
 ## Roadmap
 See the [open issues](https://github.com/polypheny/Polypheny-DB/labels/A-python) for a list of proposed features (and known issues).
@@ -95,14 +124,5 @@ We highly welcome your contributions to the _Polypheny Connector for Python_. If
 Please note that we have a [code of conduct](https://github.com/polypheny/Admin/blob/master/CODE_OF_CONDUCT.md). Please follow it in all your interactions with the project. 
 
 
-## Credits
-This work was influenced by the following projects:
-
-* [python-phoenixdb](https://github.com/lalinsky/python-phoenixdb)
-* [snowflake-connector-python](https://github.com/snowflakedb/snowflake-connector-python)
-
-
 ## License
 The Apache 2.0 License
-
-

{polypheny-0.2.0 → polypheny-2.0.0}/README.md

@@ -1,18 +1,10 @@
-<!--<p align="center">
-<picture>
-  <source 
-    srcset="https://raw.githubusercontent.com/polypheny/Admin/master/Logo/logo-white-text.png" 
-    media="(prefers-color-scheme: dark)">
-  <a href="https://polypheny.org/">
-    <img align="center" width="300" height="300" src="https://raw.githubusercontent.com/polypheny/Admin/master/Logo/logo-transparent.png">
-   </a>
-</picture>
-</p>
--->
-
-<a href="https://polypheny.org/">
-    <img align="right" width="300" height="300" src="https://raw.githubusercontent.com/polypheny/Admin/master/Logo/logo-transparent.png" alt="Resume application project app icon">
-</a>
+<p align="center">
+    <a href="https://polypheny.org/">
+        <picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/polypheny/Admin/master/Logo/logo-white-text_cropped.png">
+            <img width='50%' alt="Light: 'Resume application project app icon' Dark: 'Resume application project app icon'" src="https://raw.githubusercontent.com/polypheny/Admin/master/Logo/logo-transparent_cropped.png">
+        </picture>
+    </a>    
+</p> 
 
 
 # Polypheny Connector for Python
@@ -20,7 +12,7 @@
 This enables Python programs to access Polypheny databases, using an API that is compliant with the [Python Database API Specification v2.0 (PEP 249)](https://www.python.org/dev/peps/pep-0249/).
 
 
-### Installation
+## Installation
 
 The recommended way to install the Python Connector for Polypheny is via pip:
 ```bash
@@ -33,6 +25,9 @@ cd /path/to/polyphney-connector-python-x.y.z/
 python setup.py install
 ```
 
+The connector uses the Prism 2.2 client definitions and connects to servers
+that report a compatible Prism 2.x API. The minor versions do not have to match.
+Document collection metadata requires server-side support introduced in Prism 2.2.
 
 
 ## Getting Started
@@ -40,33 +35,57 @@ python setup.py install
 A few examples of the most common functionalities provided by the adapter:
 
 
-```python
+```python3
 import polypheny
 
-# Connect to Polypheny
-connection = polypheny.connect('localhost', 20591, user='pa', password='')
+# Connect to locally running Polypheny via UNIX sockets (on Linux, BSD and macOS)
+con = polypheny.connect()
+
+# Unencrypted over the network (all systems)
+con = polypheny.connect(
+  ('127.0.0.1', 20590),
+  username='pa',
+  password='',
+  transport='plain',
+)
 
 # Get a cursor
-cursor = connection.cursor()
+cursor = con.cursor()
 
 # Create a new table
 cursor.execute("CREATE TABLE dummy (id INT NOT NULL, text VARCHAR(2), num INT, PRIMARY KEY(id))")
 
 # Insert values into table
 cursor.execute("INSERT INTO dummy VALUES (407 , 'de', 93)")
-connection.commit()
+con.commit()
 
 # Execute a query
 cursor.execute("SELECT * from dummy")
-result = cursor.fetchall()
+
+print("\nRelational results from SQL")
+for row in cursor:
+    print("\t", row)
+
+# Accessing data using MQL
+cursor.executeany('mongo', 'db.dummy.find()', namespace='public')
+
+print("\nDocument results from MQL (as Python dicts)")
+for doc in cursor:
+    print("\t", doc)
+
+cursor.execute("DROP TABLE dummy")
 
 # Close the connection
-connection.close()
+con.close()
 ```
 
-An in-depth and more detailed documentation can be found [here]()
-
+An in-depth and more detailed documentation can be found [here](https://docs.polypheny.com/en/latest/drivers/python/overview).
 
+## Tests
+Run the tests with coverage report:
+```
+coverage run --source polypheny -m pytest && coverage report -m
+```
 
 ## Roadmap
 See the [open issues](https://github.com/polypheny/Polypheny-DB/labels/A-python) for a list of proposed features (and known issues).
@@ -78,12 +97,5 @@ We highly welcome your contributions to the _Polypheny Connector for Python_. If
 Please note that we have a [code of conduct](https://github.com/polypheny/Admin/blob/master/CODE_OF_CONDUCT.md). Please follow it in all your interactions with the project. 
 
 
-## Credits
-This work was influenced by the following projects:
-
-* [python-phoenixdb](https://github.com/lalinsky/python-phoenixdb)
-* [snowflake-connector-python](https://github.com/snowflakedb/snowflake-connector-python)
-
-
 ## License
 The Apache 2.0 License

polypheny-2.0.0/polypheny/__init__.py

@@ -0,0 +1,85 @@
+# Copyright 2024 The Polypheny Project
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from polypheny.connection import Connection, Cursor
+from polypheny.exceptions import *
+
+import datetime
+from typing import Union
+
+# See https://peps.python.org/pep-0249/#globals
+apilevel = '2.0'
+threadsafety = 0
+paramstyle = 'qmark'
+
+
+def Date(year, month, day):
+    return datetime.date(year, month, day)
+
+
+def Time(hour, minute, second):
+    return datetime.time(hour, minute, second)
+
+
+def Timestamp(year, month, day, hour, minute, second):
+    return datetime.datetime(year, month, day, hour, minute, second)
+
+
+# See PEP 249
+import time
+
+
+def DateFromTicks(ticks):
+    return Date(*time.localtime(ticks)[:3])  # TODO: Really local time?
+
+
+def TimeFromTicks(ticks):
+    return Time(*time.localtime(ticks)[3:6])
+
+
+def TimestampFromTicks(ticks):
+    return Timestamp(*time.localtime(ticks)[:6])
+
+
+def Binary(string):
+    return string.encode('UTF-8')
+
+
+# Intentionally omitted, we always give type_code = None, like sqlite3
+# STRING = 1
+# BINARY = 2
+# NUMBER = 3
+# DATETIME = 4
+# ROWID = 5
+
+
+def connect(address: Union[tuple[str, int], str] = None, *, username: str = None, password: str = None,
+            transport: str = None, **kwargs) -> Connection:
+    """
+    Connect to a Polypheny instance with the given parameters.  When
+    no parameters are given, the driver will connect via the ``unix``
+    transport to ``~/.polypheny/polypheny-prism.sock``.
+
+    :param address:  A :py:class:`str` for ``unix`` transport or a (hostname, port) :py:class:`tuple` for ``plain`` transport.
+    :param username:  username
+    :param password:  password
+    :param transport:  Either ``plain`` or ``unix``
+
+    """
+    if address is None and transport is None and username is None and password is None and len(kwargs) == 0:
+        transport = 'unix'
+    elif address is None or transport is None:
+        raise Error("Address and transport must be given")
+
+    return Connection(address, username, password, transport, kwargs)