v1.0.0

v1.0.0

Author: SendSafely-GitHub

README.md

@@ -1,2 +1,55 @@
-# Python-Client-API
-SendSafely API for Python
+# SendSafely Python API
+The SendSafely Python API lets you integrate SendSafely secure data transfer capabilities directly into your Python application. 
+
+## Quickstart
+The example below shows you how to install the SendSafely-Python-API package, import it as a module, and use it to create a package. Make sure that you have [Python 3 or higher installed, as well as pip and Setuptools](https://packaging.python.org/tutorials/installing-packages/). 
+
+Install the SendSafely-Python-API package with pip
+```console
+python3 -m pip install /dist/SendSafely-Python-API-1.0.0.tar.gz
+```
+
+Import the SendSafely module to start making your API calls
+
+```python
+from sendsafely import SendSafely, Package
+```
+Create a Sendsafely instance object
+```python
+sendsafely = SendSafely("https://your-company.sendsafely.com", "API_KEY", "API_SECRET")
+```
+Create a new package
+```python
+package = Package(sendsafely)
+```
+Add a secure message to the package
+```python
+package.encrypt_and_upload_message("hello this is a message")
+```
+Add a recipient to the package
+```python
+package.add_recipient("user@foobar.com")
+```
+Finalize the package so it can be delivered to the recipients. The returned response contains the Secure Link needed for recipients to access the package. 
+```python
+response = package.finalize()
+```
+*You will need to generate your own API_KEY and API_SECRET from the API Keys section of your Profile page when logged into your SendSafely portal.*
+
+## Examples
+**sendsafely_python_example.py** - demonstrates how the SendSafely Python API can be used to create packages and handle encrypt/upload and download/decrypt operations without the API developer having to implement these complex operations.
+```
+python3 sendsafely_python_example.py
+```
+
+**sendsafely_rest_example.py** - demonstrates how the SendSafely Python API can be used to call SendSafely REST API endpoints directly. This is useful for cases where the SendSafely Python API does not currently implement a function for calling the endpoint. 
+```
+python3 sendsafely_rest_example.py
+```
+
+*Before running the example scripts, you will need to update the `api_key`, `api_secret`, and `base_url` variables in the script before running it.*
+
+For more information, please refer to our [Developer Website](https://sendsafely.github.io) to familiarize yourself with the core SendSafely API and common operations. You can find our documented REST API endpoints [here](https://bump.sh/doc/sendsafely-rest-api). 
+
+## Support
+For support, please contact support@sendsafely.com. 

build.sh

@@ -0,0 +1,4 @@
+cp README.md src/README
+cd src
+python3 setup.py sdist --dist-dir=../dist
+cd ..

dist/SendSafely-Python-API-1.0.0.tar.gz

@@ -0,0 +1 @@
+Thank you for using SendSafely! :) 

scripts/fileToUpload.txt

@@ -0,0 +1,28 @@
+import sys
+
+from sendsafely import SendSafely, Package, Progress
+
+
+class CustomProgress(Progress):
+
+    def update_progress(self, file_id, progress):
+        self.progress = progress
+
+        if progress == '100.0':
+            last = '\n'
+        else:
+            last = ''
+
+        sys.stdout.write('\rCustom Progress for fileId {0}: {1}{2} complete{3}'.format(file_id, progress, '%', last))
+        sys.stdout.flush()
+
+
+sendsafely = SendSafely("https://companyabc.sendsafely.com", "", "")
+package = Package(sendsafely)
+recipient = "me@sendsafely.net"
+recipient = package.add_recipient(recipient)
+test_file_path = "fileToUpload.txt"
+# custom case
+custom = package.encrypt_and_upload_file(test_file_path, progress_instance=CustomProgress())
+# default case
+default = package.encrypt_and_upload_file(test_file_path)

scripts/sendsafely_progress_example.py

@@ -0,0 +1,43 @@
+import json
+
+from sendsafely import SendSafely, Package
+
+# Edit these variables
+api_key = ""
+api_secret = ""
+base_url = "https://companyabc.sendsafely.com"
+# Make sure all directories exist on your file system
+upload_file = "fileToUpload.txt"
+download_filename = "fileDownloaded.txt"
+download_dir = "."
+recipient = "user@foobar.com"
+
+def main():
+    sendsafely = SendSafely(base_url, api_key, api_secret)
+    package = Package(sendsafely)
+
+    with open(upload_file, 'wb') as file:
+        content = bytes("SendSafely lets you easily exchange encrypted files and information with anyone on any device.", "utf-8")
+        file.write(content)
+
+    f = package.encrypt_and_upload_file(upload_file)
+    file_id = f["fileId"]
+    print("Successfully encrypted and uploaded file id " + str(file_id))
+
+    package.encrypt_and_upload_message("hello this is a message")
+    print("Successfully encrypted and uploaded secure message")
+
+    package.add_recipient(recipient)
+    print("Successfully added recipient " + recipient)
+
+    response = package.finalize()
+    print("Successfully submitted package - link for sending: " + response["message"])
+
+    package.download_and_decrypt_file(file_id, download_directory=download_dir, file_name=download_filename)
+    print("Successfully downloaded and decrypted file " + download_filename)
+
+    print("Package Info: ")
+    print(json.dumps(package.get_info(), indent=4, sort_keys=True))
+
+if __name__ == '__main__':
+    main()

scripts/sendsafely_python_example.py

@@ -0,0 +1,64 @@
+from sendsafely import SendSafely, Package, utilities
+
+# Edit these variables
+api_key = ""
+api_secret = ""
+base_url = "https://companyabc.sendsafely.com"
+
+
+def rest_get_example_user_information(sendsafely):
+    get_endpoint = "/user/"
+    response = utilities.get_request(sendsafely, get_endpoint)
+    print(response)
+
+
+def rest_post_example_update_package_life(sendsafely):
+    package = Package(sendsafely)
+    post_endpoint = "/package/" + package.package_id
+    body = {"life": 10}
+    response = utilities.post_request(sendsafely, post_endpoint, body)
+    print(response)
+
+
+def rest_delete_example_delete_package(sendsafely):
+    package = Package(sendsafely)
+    delete_endpoint = "/package/" + package.package_id
+    response = utilities.delete_request(sendsafely, delete_endpoint)
+    print(response)
+
+
+def rest_put_example_add_recipients(sendsafely):
+    package = Package(sendsafely)
+    put_endpoint = "/package/" + package.package_id + "/recipients/"
+    response = utilities.put_request(sendsafely, put_endpoint,
+                                     {'emails': ['user@foobar.com', 'user2@foobar.com']})
+    print(response)
+
+
+def rest_patch_example_update_file(sendsafely):
+    # Edit
+    package_id = 'packageId of Dropzone package'
+    file_id = 'fileId of Dropzone package'
+    body = {'fileName': 'new file name'}
+
+    patch_endpoint = "/package/" + package_id + "/file/" + file_id
+    response = utilities.patch_request(sendsafely, patch_endpoint, body)
+    print(response)
+
+
+def main():
+    sendsafely = SendSafely(base_url, api_key, api_secret)
+    print("GET: User Information")
+    rest_get_example_user_information(sendsafely)
+    print("POST: Update Package Life")
+    rest_post_example_update_package_life(sendsafely)
+    print("PUT: Add Recipients")
+    rest_put_example_add_recipients(sendsafely)
+    print("DELETE: Delete Package")
+    rest_delete_example_delete_package(sendsafely)
+    # print("PATCH: Update Dropzone File")
+    # rest_patch_example_update_file(sendsafely)
+
+
+if __name__ == '__main__':
+    main()

scripts/sendsafely_rest_example.py

@@ -0,0 +1,2 @@
+README
+MANIFEST

src/.gitignore

@@ -0,0 +1 @@
+include README

src/MANIFEST.in

@@ -0,0 +1,2 @@
+requests~=2.24.0
+PGPy~=0.5.3