sfq 0.0.4__tar.gz → 0.0.6__tar.gz

sfq-0.0.6/.python-version

@@ -0,0 +1 @@
+3.7

sfq-0.0.4/README.md → sfq-0.0.6/PKG-INFO

@@ -1,3 +1,22 @@
+Metadata-Version: 2.1
+Name: sfq
+Version: 0.0.6
+Summary: Python wrapper for the Salesforce's Query API.
+Author-email: David Moruzzi <sfq.pypi@dmoruzi.com>
+Keywords: salesforce,salesforce query
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.7
+Requires-Dist: prompt-toolkit>=3.0.3
+Description-Content-Type: text/markdown
+
 # sfq (Salesforce Query)
 
 sfq is a lightweight Python wrapper library designed to simplify querying Salesforce, reducing repetitive code for accessing Salesforce data.
@@ -20,7 +39,25 @@ pip install sfq
 
 ## Usage
 
-### Querying Salesforce Data
+### Interactive Querying 
+
+```powershell
+usage: python -m sfq [-a SFDXAUTHURL] [--dry-run] [--disable-fuzzy-completion]
+
+Interactively query Salesforce data with real-time autocompletion.
+
+options:
+  -h, --help            show this help message and exit
+  -a, --sfdxAuthUrl SFDXAUTHURL
+                        Salesforce auth url
+  --dry-run             Print the query without executing it
+  --disable-fuzzy-completion
+                        Disable fuzzy completion
+```
+
+You can run the `sfq` library in interactive mode by passing the `-a` option with the `SFDX_AUTH_URL` argument or by setting the `SFDX_AUTH_URL` environment variable.
+
+### Library Querying
 
 ```python
 from sfq import SFAuth
@@ -39,7 +76,7 @@ print(sf.query("SELECT Id FROM Account LIMIT 5"))
 print(sf.query("SELECT Id, FullName, Metadata FROM SandboxSettings LIMIT 5", tooling=True))
 ```
 
-### Querying from Bash
+### Bash Querying 
 
 You can easily incorporate this into ad-hoc bash scripts or commands:
 
@@ -112,4 +149,4 @@ To use the `sfq` library, you'll need a **client ID** and **refresh token**. The
 ## Notes
 
 - **Authentication**: Make sure your refresh token is kept secure, as it grants access to your Salesforce instance.
-- **Tooling API**: You can set the `tooling=True` argument in the `query` method to access the Salesforce Tooling API for more advanced metadata queries.
+- **Tooling API**: You can set the `tooling=True` argument in the `query` method to access the Salesforce Tooling API for more advanced metadata queries. This is limited to library usage only.

sfq-0.0.4/PKG-INFO → sfq-0.0.6/README.md

@@ -1,19 +1,3 @@
-Metadata-Version: 2.4
-Name: sfq
-Version: 0.0.4
-Summary: Python wrapper for the Salesforce's Query API.
-Author-email: David Moruzzi <sfq.pypi@dmoruzi.com>
-Keywords: salesforce,salesforce query
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-
 # sfq (Salesforce Query)
 
 sfq is a lightweight Python wrapper library designed to simplify querying Salesforce, reducing repetitive code for accessing Salesforce data.
@@ -36,7 +20,25 @@ pip install sfq
 
 ## Usage
 
-### Querying Salesforce Data
+### Interactive Querying 
+
+```powershell
+usage: python -m sfq [-a SFDXAUTHURL] [--dry-run] [--disable-fuzzy-completion]
+
+Interactively query Salesforce data with real-time autocompletion.
+
+options:
+  -h, --help            show this help message and exit
+  -a, --sfdxAuthUrl SFDXAUTHURL
+                        Salesforce auth url
+  --dry-run             Print the query without executing it
+  --disable-fuzzy-completion
+                        Disable fuzzy completion
+```
+
+You can run the `sfq` library in interactive mode by passing the `-a` option with the `SFDX_AUTH_URL` argument or by setting the `SFDX_AUTH_URL` environment variable.
+
+### Library Querying
 
 ```python
 from sfq import SFAuth
@@ -55,7 +57,7 @@ print(sf.query("SELECT Id FROM Account LIMIT 5"))
 print(sf.query("SELECT Id, FullName, Metadata FROM SandboxSettings LIMIT 5", tooling=True))
 ```
 
-### Querying from Bash
+### Bash Querying 
 
 You can easily incorporate this into ad-hoc bash scripts or commands:
 
@@ -128,4 +130,4 @@ To use the `sfq` library, you'll need a **client ID** and **refresh token**. The
 ## Notes
 
 - **Authentication**: Make sure your refresh token is kept secure, as it grants access to your Salesforce instance.
-- **Tooling API**: You can set the `tooling=True` argument in the `query` method to access the Salesforce Tooling API for more advanced metadata queries.
+- **Tooling API**: You can set the `tooling=True` argument in the `query` method to access the Salesforce Tooling API for more advanced metadata queries. This is limited to library usage only.

{sfq-0.0.4 → sfq-0.0.6}/pyproject.toml

@@ -1,17 +1,21 @@
 [project]
 name = "sfq"
-version = "0.0.4"
+version = "0.0.6"
 description = "Python wrapper for the Salesforce's Query API."
 readme = "README.md"
 authors = [{ name = "David Moruzzi", email = "sfq.pypi@dmoruzi.com" }]
 keywords = ["salesforce", "salesforce query"]
-requires-python = ">=3.9"
-dependencies = []
+requires-python = ">=3.7"
+dependencies = [
+    "prompt-toolkit>=3.0.3",
+]
 
 classifiers = [
   "Development Status :: 3 - Alpha",
   "Intended Audience :: Developers",
   "Topic :: Software Development :: Libraries :: Python Modules",
+  "Programming Language :: Python :: 3.7",
+  "Programming Language :: Python :: 3.8",
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.12",
@@ -20,4 +24,4 @@ classifiers = [
 
 [build-system]
 requires = ["hatchling"]
-build-backend = "hatchling.build"
+build-backend = "hatchling.build"

{sfq-0.0.4 → sfq-0.0.6}/src/sfq/__init__.py

@@ -13,7 +13,7 @@ class SFAuth:
         instance_url,
         client_id,
         refresh_token,
-        api_version="v62.0",
+        api_version="v63.0",
         token_endpoint="/services/oauth2/token",
         access_token=None,
         token_expiration_time=None,
@@ -131,7 +131,7 @@ class SFAuth:
         try:
             return time.time() >= float(self.token_expiration_time)
         except (TypeError, ValueError):
-            return False
+            return True
 
     def query(self, query, tooling=False):
         """Query Salesforce using SOQL or Tooling API, depending on the `tooling` parameter."""

sfq-0.0.6/src/sfq/__main__.py

@@ -0,0 +1,151 @@
+import difflib
+import http.client
+import json
+
+from sfq import SFAuth
+
+from prompt_toolkit import prompt
+from prompt_toolkit.completion import Completer, Completion
+
+def _interactive_shell(sf: SFAuth, dry_run: bool, disable_fuzzy_completion: bool):
+    """Runs an interactive REPL for querying Salesforce data with real-time autocompletion."""
+
+    sobject = None
+    fields = None
+
+    class DynamicSeparatorCompleter(Completer):
+        """Custom completer that adapts to different separators."""
+        
+        def __init__(self, words: list[str], separators: list[str] = [","]):
+            self.words = words
+            self.separators = separators
+
+        def get_completions(self, document, complete_event):
+            text_before_cursor = document.text_before_cursor
+            
+            for separator in self.separators:
+                if separator in text_before_cursor:
+                    last_token = text_before_cursor.split(separator)[-1].strip()
+                    break
+            else:
+                last_token = text_before_cursor.strip()
+
+
+            matches_difflib = difflib.get_close_matches(last_token, self.words, n=20, cutoff=0.6)
+            matches_starting = [word for word in self.words if word.lower().startswith(last_token.lower())]
+
+            if not disable_fuzzy_completion and (len(last_token) > 6 or not(matches_starting)):
+                matches = matches_difflib
+            else:
+                matches = matches_starting
+
+            for word in matches:
+                yield Completion(word, start_position=-len(last_token))
+                
+    def _get_objects(sf: SFAuth):
+        """Retrieve available Salesforce objects."""
+        host = sf.instance_url.split("://")[1].split("/")[0]
+        conn = http.client.HTTPSConnection(host)
+        uri = f"/services/data/{sf.api_version}/sobjects/"
+        headers = {'Authorization': f'Bearer {sf._refresh_token_if_needed()}'}
+        conn.request("GET", uri, headers=headers)
+        response = conn.getresponse()
+        
+        if response.status != 200:
+            print(f'Error: {response.status} {response.reason}')
+            return []
+        
+        data = json.loads(response.read())
+        return [sobject['name'] for sobject in data['sobjects']]
+
+    def _get_fields(sobject: str, sf: SFAuth):
+        """Retrieve available fields for a given Salesforce object."""
+        host = sf.instance_url.split("://")[1].split("/")[0]
+        conn = http.client.HTTPSConnection(host)
+        uri = f"/services/data/{sf.api_version}/sobjects/{sobject}/describe/"
+        headers = {'Authorization': f'Bearer {sf._refresh_token_if_needed()}'}
+        conn.request("GET", uri, headers=headers)
+        response = conn.getresponse()
+        
+        if response.status != 200:
+            print(f'Error: {response.status} {response.reason}')
+            raise ValueError(f'Unable to fetch fields for sObject "{sobject}": {response.status}, {response.reason}')
+        
+        data = json.loads(response.read())
+        return [f['name'] for f in data['fields']]
+
+    available_objects = _get_objects(sf)
+    
+    object_completer = DynamicSeparatorCompleter(available_objects)
+    while not sobject:
+        sobject = prompt('FROM ', completer=object_completer).strip()
+
+
+    available_fields = _get_fields(sobject, sf)
+    field_completer = DynamicSeparatorCompleter(available_fields, separators=[","])
+    while not fields:
+        fields = prompt('SELECT ', completer=field_completer).strip()
+
+    where_completer = DynamicSeparatorCompleter(available_fields, separators=[" AND ", " OR "])
+    where = prompt("WHERE ", completer=where_completer).strip()
+    where_clause = f"WHERE {where}" if where else ""
+    
+    limit = prompt("LIMIT ", default="200").strip()
+    limit_clause = f"LIMIT {limit}" if limit else ""
+    
+    query = f"SELECT {fields} FROM {sobject} {where_clause} {limit_clause}".replace('  ', ' ')
+    
+    if dry_run:
+        print('\nDry-run, skipping execution...')
+        print(f'\nQuery: {query}\n')
+        return query
+    
+    print('\nExecuting query...\n')
+    data = sf.query(query)
+    print(json.dumps(data, indent=4))
+    print(f'\nQuery: {query}\n')
+    return data
+
+if __name__ == "__main__":
+    import argparse
+    import os
+
+    parser = argparse.ArgumentParser(
+        description='Interactively query Salesforce data with real-time autocompletion.'
+    )
+    parser.add_argument(
+        '-a', '--sfdxAuthUrl', type=str, help='Salesforce auth url', default=os.environ.get('SFDX_AUTH_URL')
+    )
+    parser.add_argument(
+        '--dry-run', action='store_true', help='Print the query without executing it', default=str(os.environ.get('SFQ_DRY_RUN')),
+    )
+    parser.add_argument(
+        '--disable-fuzzy-completion', action='store_true', help='Disable fuzzy completion', default=str(os.environ.get('SFQ_DISABLE_FUZZY_COMPLETION')),
+    )
+    args = parser.parse_args()
+
+    if not args.sfdxAuthUrl:
+        raise ValueError('SFDX_AUTH_URL environment variable is not set nor provided as an argument')
+    
+    try:
+        if args.dry_run.lower() not in ['true', '1']:
+            args.dry_run = False
+    except AttributeError:
+        pass
+
+    try:
+        if args.disable_fuzzy_completion.lower() not in ['true', '1']:
+            args.disable_fuzzy_completion = False
+    except AttributeError:
+        pass
+
+
+    _interactive_shell(
+        SFAuth(
+            instance_url=f"https://{str(args.sfdxAuthUrl).split('@')[1]}",
+            client_id=str(args.sfdxAuthUrl).split('//')[1].split('::')[0],
+            refresh_token=str(args.sfdxAuthUrl).split('::')[1].split('@')[0],
+        ),
+        args.dry_run,
+        args.disable_fuzzy_completion
+    )

sfq-0.0.6/uv.lock

@@ -0,0 +1,35 @@
+version = 1
+revision = 1
+requires-python = ">=3.7"
+
+[[package]]
+name = "prompt-toolkit"
+version = "3.0.3"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "wcwidth" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/8f/bc/58ba47a2a864d8e3d968d03b577c85fbdf52c8d324a030df71ac9c06c1b5/prompt_toolkit-3.0.3.tar.gz", hash = "sha256:a402e9bf468b63314e37460b68ba68243d55b2f8c4d0192f85a019af3945050e", size = 2997855 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/f5/22/f00412fafc68169054cc623a35c32773f22b403ddbe516c8adfdecf25341/prompt_toolkit-3.0.3-py3-none-any.whl", hash = "sha256:c93e53af97f630f12f5f62a3274e79527936ed466f038953dfa379d4941f651a", size = 348445 },
+]
+
+[[package]]
+name = "sfq"
+version = "0.0.6"
+source = { editable = "." }
+dependencies = [
+    { name = "prompt-toolkit" },
+]
+
+[package.metadata]
+requires-dist = [{ name = "prompt-toolkit", specifier = ">=3.0.3" }]
+
+[[package]]
+name = "wcwidth"
+version = "0.2.13"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/6c/63/53559446a878410fc5a5974feb13d31d78d752eb18aeba59c7fef1af7598/wcwidth-0.2.13.tar.gz", hash = "sha256:72ea0c06399eb286d978fdedb6923a9eb47e1c486ce63e9b4e64fc18303972b5", size = 101301 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/fd/84/fd2ba7aafacbad3c4201d395674fc6348826569da3c0937e75505ead3528/wcwidth-0.2.13-py2.py3-none-any.whl", hash = "sha256:3da69048e4540d84af32131829ff948f1e022c1c6bdb8d6102117aac784f6859", size = 34166 },
+]

sfq-0.0.4/.python-version

@@ -1 +0,0 @@
-3.9

sfq-0.0.4/uv.lock

@@ -1,7 +0,0 @@
-version = 1
-requires-python = ">=3.9"
-
-[[package]]
-name = "sfq"
-version = "0.0.4"
-source = { editable = "." }