Ready to get started?

Learn more about the CData ODBC Driver for UPS or download a free trial:

Download Now

Using the CData ODBC Driver for UPS in PyCharm

Connect to UPS as an ODBC data source in PyCharm using the CData ODBC Driver for UPS.

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for UPS from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for UPS as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

  1. Click File -> Settings to open the project settings window.
  2. Click Project Interpreter from the Project: YourProjectName menu.
  3. To add pyodbc, click the + button and enter pyodbc.
  4. Click Install Package to install pyodbc.

Connect to UPS

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

The driver uses five pieces of information in order to authenticate its actions with the UPS service.

  • Server: This controls the URL where the requests should be sent. Common testing options for this are: https://wwwcie.ups.com/ups.app/xml and https://wwwcie.ups.com/webservices
  • AccessKey: This is an identifier that is required to connect to a UPS Server. This value will be provided to you by UPS after registration.
  • UserId: This value is used for logging into UPS. This value is the one you chose to login with when registering for service with UPS.
  • Password: This value is used for logging into UPS. This value is the one you chose to login with when registering for service with UPS.
  • AccountNumber: This is a valid 6-digit or 10-digit UPS account number.
  • PrintLabelLocation: This property is required if one intends to use the GenerateLabels or GenerateReturnLabels stored procedures. This should be set to the folder location where generated labels should be stored.

Below is the syntax for a DSN:

[CData UPS Source] Driver = CData ODBC Driver for UPS Description = My Description Server = https://wwwcie.ups.com/ups.app/xml AccessKey = myAccessKey Password = myPassword AccountNumber = myAccountNumber UserId = myUserId

Execute SQL to UPS

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for UPS};Server = https://wwwcie.ups.com/ups.app/xml;AccessKey = myAccessKey;Password = myPassword;AccountNumber = myAccountNumber;UserId = myUserId') cursor = cnxn.cursor() cursor.execute("SELECT FirstName, Phone FROM Senders WHERE SenderID = '25'") rows = cursor.fetchall() for row in rows: print(row.FirstName, row.Phone)

After connecting to UPS in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to UPS data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at support@cdata.com.