chore: migrate to uv, src layout, and PEP 8 package name

README.md

@@ -8,7 +8,29 @@ by Aaron Caffrey, Colin Cheevers, Jose Garcia, Tania Prince
 
 A Salesforce.com [Open Source contribution](https://opensource.salesforce.com/).
 
-SalesforcePy is an absurdly simple package for making Salesforce Rest API calls. We created this package so you can:
+SalesforcePy is an absurdly simple package for making Salesforce Rest API calls.
+
+## Installation
+
+### With [uv](https://docs.astral.sh/uv/) (recommended)
+
+```bash
+uv add salesforcepy
+```
+
+**From GitHub (latest):**
+
+```bash
+uv add git+https://github.com/forcedotcom/SalesforcePy.git
+```
+
+### With pip
+
+```bash
+pip install salesforcepy
+# or from GitHub
+pip install git+https://github.com/forcedotcom/SalesforcePy.git
+``` We created this package so you can:
 
 + Have a Salesforce client that is reusable, minimalistic, and pythonic
 + Use interfaces that are closely knit to the Salesforce Rest API service specification

docs/contribute.rst

@@ -9,7 +9,7 @@ Git Workflow
 
 1. Fork this repo.
 2. Run ``git clone -b <yourbranch> <yourfork>``.
-3. From within the project root directory run pip install.
+3. From within the project root directory run ``uv sync`` (or ``pip install -e .``).
 4. Develop!
 5. Cover your code in ``/tests``.
 6. Create a pull request to the ``forcedotcom:developer branch``.

docs/faq.rst

@@ -24,7 +24,7 @@ Yes. Here's an example of how to do it, and what to expect.
 .. code-block:: python
 
     import logging
-    import SalesforcePy as sfdc
+    import salesforcepy as sfdc
 
     username = "jsoap@universalcontainers.com"
     password = "p@ssword1"
@@ -47,7 +47,7 @@ Yes. Here's an example of how to do it.
 
 .. code-block:: python
 
-    import SalesforcePy as sfdc
+    import salesforcepy as sfdc
 
     username = "jsoap@universalcontainers.com"
     password = "p@ssword1"

docs/get_started.rst

@@ -17,7 +17,7 @@ From Local Source
 ^^^^^^^^^^^^^^^^^
 1. Download and extract, or clone this repo.
 2. cd into the ``/SalesforcePy`` directory.
-3. Run ``pip install .``.
+3. Run ``uv sync`` (or ``pip install -e .``).
 
 Create a Client and Log In
 --------------------------
@@ -30,8 +30,8 @@ Getting started with SalesforcePy is a three-step process:
 
 .. code-block:: python
 
-    #Import SalesforcePy
-    import SalesforcePy as sfdc
+    #Import salesforcepy
+    import salesforcepy as sfdc
 
     # Create an instance of a Salesforce client. Replace the credentials here with valid ones.
     client = sfdc.client(

pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["uv_build>=0.11.8,<0.12"]
+build-backend = "uv_build"
+
+[project]
+name = "salesforcepy"
+version = "2.2.0"
+description = "An absurdly simple package for making Salesforce REST API calls"
+authors = [
+    {name = "Aaron Caffrey", email = "acaffrey@salesforce.com"},
+    {name = "Jose Garcia Ponce", email = "jgarciaponce@salesforce.com"},
+    {name = "Colin Cheevers", email = "ccheevers@salesforce.com"},
+    {name = "Tania Prince", email = "tania.prince@salesforce.com"},
+]
+license = {text = "BSD-3-Clause"}
+readme = "README.md"
+requires-python = ">=3.11,<4.0"
+keywords = ["salesforce", "rest", "api", "sfdc"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "requests>=2.20.0,<3",
+]
+
+[project.urls]
+repository = "https://github.com/forcedotcom/SalesforcePy"
+homepage = "https://github.com/forcedotcom/SalesforcePy"
+
+[dependency-groups]
+dev = [
+    "responses>=0.22.0",
+    "coverage>=7.3",
+    "pytest>=7.0.0",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src", "tests"]
+python_files = "test_*.py"
+python_classes = "Test*"
+python_functions = "test_*"

SalesforcePy/__init__.py → src/salesforcepy/__init__.py

@@ -1,7 +1,7 @@
-from __future__ import absolute_import
+# Local library imports
 from . import sfdc
 
-name = 'SalesforcePy'
+name = 'salesforcepy'
 client = sfdc.client
 
 LoginException = sfdc.LoginException

SalesforcePy/chatter.py → src/salesforcepy/chatter.py

@@ -6,8 +6,7 @@
 .. versionadded:: 1.0.0
 
 """
-from __future__ import absolute_import
-
+# Local library imports
 from . import commons
 
 FEED_COMMENT_SERVICE = '/services/data/v%s/chatter/feed-elements/%s/capabilities/comments/items'

SalesforcePy/commons.py → src/salesforcepy/commons.py

@@ -6,14 +6,15 @@
 .. versionadded:: 1.0.0
 
 """
-from __future__ import absolute_import
-
+# Built-in imports
 import collections
 import logging
-import requests
 import xml.etree.ElementTree as ET
 from urllib.parse import urlparse
 
+# Third-party imports
+import requests
+
 DEFAULT_API_VERSION = '37.0'
 
 
@@ -271,7 +272,7 @@ def request(self):
         except Exception as e:
             self.exceptions.append(e)
             logger.error('%s %s %s' % (self.http_method, service, self.status))
-            logger.error(e.message)
+            logger.error(str(e))
             return
         finally:
             return response
@@ -307,7 +308,7 @@ def request(self):
         except Exception as e:
             self.exceptions.append(e)
             logger.error('%s %s %s' % (self.http_method, service, self.status))
-            logger.error(e.message)
+            logger.error(str(e))
             return
         finally:
             return response
@@ -369,6 +370,6 @@ def request(self):
         except Exception as e:
             self.exceptions.append(e)
             logger.error('%s %s %s' % (self.http_method, service, self.status))
-            logger.error(e.message)
+            logger.error(str(e))
         finally:
             return response

SalesforcePy/device_flow.py → src/salesforcepy/device_flow.py

@@ -1,3 +1,4 @@
+# Local library imports
 from .commons import OAuthRequest
 
 

SalesforcePy/einstein/__init__.py → src/salesforcepy/einstein/__init__.py

@@ -4,8 +4,7 @@
 
 .. moduleauthor:: Aaron Caffrey <acaffrey@salesforce.com>
 """
-from __future__ import absolute_import
-
+# Local library imports
 from .. import commons
 from . import llm
 

SalesforcePy/einstein/llm/__init__.py → src/salesforcepy/einstein/llm/__init__.py

@@ -4,8 +4,7 @@
 
 .. moduleauthor:: Aaron Caffrey <acaffrey@salesforce.com>
 """
-from __future__ import absolute_import
-
+# Local library imports
 from .. import commons
 from . import embeddings
 from . import prompt

SalesforcePy/einstein/llm/embeddings.py → src/salesforcepy/einstein/llm/embeddings.py

@@ -4,8 +4,7 @@
 
 .. moduleauthor:: Aaron Caffrey <acaffrey@salesforce.com>
 """
-from __future__ import absolute_import
-
+# Local library imports
 from .. import commons
 
 EMBEDDINGS_SERVICE = "/services/data/v%s/einstein/llm/embeddings"

SalesforcePy/einstein/llm/prompt.py → src/salesforcepy/einstein/llm/prompt.py

@@ -4,8 +4,7 @@
 
 .. moduleauthor:: Aaron Caffrey <acaffrey@salesforce.com>
 """
-from __future__ import absolute_import
-
+# Local library imports
 from .. import commons
 
 GENERATIONS_SERVICE = "/services/data/v%s/einstein/llm/prompt/generations"

SalesforcePy/jobs.py → src/salesforcepy/jobs.py

@@ -5,7 +5,7 @@
 .. moduleauthor:: Aaron Caffrey <acaffrey@salesforce.com>
 
 """
-from __future__ import absolute_import
+# Local library imports
 from . import commons
 
 BATCHES_URI = '/services/data/v%s/jobs/ingest/%s/batches'

SalesforcePy/sfdc.py → src/salesforcepy/sfdc.py

@@ -6,26 +6,24 @@
     Colin Cheevers <ccheevers@salesforce.com>, Tania Prince <tania.prince@salesforce.com>
 
 """
-from __future__ import absolute_import
+# Built-in imports
+import json
+import logging
+import re
+import time
+from urllib.parse import urlencode
 
+# Third-party imports
+import requests
+
+# Local library imports
 from . import chatter
 from . import commons
 from . import device_flow
 from . import einstein
 from . import jobs
 from . import wave
 
-import json
-import logging
-import re
-import requests
-import time
-
-try:
-    from urllib.parse import urlencode
-except ImportError:
-    from urllib import urlencode
-
 DEFAULT_API_VERSION = commons.DEFAULT_API_VERSION
 SOBJ_SERVICE = '/services/data/v%s/sobjects%s'
 REVOKE_SERVICE = '/services/oauth2/revoke'
@@ -97,7 +95,7 @@ def __init__(self, *args, **kwargs):
                 - `*login_url` (`string`) - Salesforce login URL.
                 - `*client_id` (`string`) - Salesforce client ID.
                 - `*client_secret` (`string`) - Salesforce client secret.
-                - `\**kwargs` - kwargs (see below)
+                - `**kwargs` - kwargs (see below)
 
             :Keyword Arguments:
                 * *protocol* (`string`) --
@@ -1142,7 +1140,7 @@ def client(username, password, client_id=None, client_secret=None, **kwargs):
               Salesforce client ID.
             `*client_secret` (`string`)
               Salesforce client secret.
-            `\**kwargs`
+            `**kwargs`
               kwargs (see below)
 
         :Keyword Arguments:

SalesforcePy/wave.py → src/salesforcepy/wave.py

@@ -7,7 +7,7 @@
 
 """
 
-from __future__ import absolute_import
+# Local library imports
 from . import commons
 
 

tests/test_api_version.py

@@ -1,6 +1,6 @@
 import testutil
 import responses
-import SalesforcePy.sfdc as sfdc
+import salesforcepy.sfdc as sfdc
 
 
 @responses.activate

tests/test_client.py

@@ -1,7 +1,7 @@
 import pytest
 import responses
 
-import SalesforcePy as sfdc
+import salesforcepy as sfdc
 import testutil
 
 

tests/test_login.py

@@ -1,4 +1,4 @@
-import SalesforcePy as sfdc
+import salesforcepy as sfdc
 import testutil
 import responses
 import logging