How to remove a worksheet from an Excel XLSX spreadsheet in Python

While worksheet removal from an XLSX file may at first seem rather simple and straightforward, you may quickly find that the process has its share of pitfalls and time sinks. I am going to rescue from this minefield by showing you the easy way out.

We start with pip installation of the Cloudmersive API client for working with documents and file conversions.

pip install cloudmersive-convert-api-client

Let’s now move on to writing our function call for edit_document_xlsx_delete_worksheet. You can reference the following example code to see how to instance the API using a key, which is required for said function call.

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'
# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
req_config = cloudmersive_convert_api_client.RemoveXlsxWorksheetRequest() # RemoveXlsxWorksheetRequest | Spreadsheet input request
try:
# Delete, remove worksheet from an Excel XLSX spreadsheet document
api_response = api_instance.edit_document_xlsx_delete_worksheet(req_config)
pprint(api_response)
except ApiException as e:
print("Exception when calling EditDocumentApi->edit_document_xlsx_delete_worksheet: %s\n" % e)

Done!