Introduction

Welcome to CBFS Sync, a suite of classes enabling seamless synchronization between local files and Cloud Storage or other remote repositories.

Add OneDrive-style, bi-directional synchronization to your applications with CBFS Sync. The event-driven design of CBFS Sync provides an intuitive way to handle operations performed on local files and folders. When remote changes are made, use the included methods to notify the local system.

The CBSync class builds on industry-standard technologies, including the Cloud Filter API on Windows, FUSE on Linux, and File Provider on macOS. CBSync reduces development time and improves user experience by providing a single API. All icons and indicators visible to the user are presented by the operating system, ensuring a native experience.

The choice of the remote storage location is entirely up to you. Whether your data is stored on a popular cloud storage service, a custom file server, or anywhere else, CBFS Sync provides a simple API to facilitate synchronization. CBFS Sync handles integration with the OS, while your code is responsible for responding to events and transferring data between local and remote systems. Because your code interacts with the backend, you can also decide to make the synchronization one-way or bidirectional.

Included Classes

CBSync

The CBSync component enables seamless synchronization between local files and Cloud Storage or other remote repositories.

Additional Information

You will always find the latest information about CBFS Sync at our web site: www.callback.com. We offer free, fully-functional 30-day trials for all of our products, and our technical support staff are happy to answer any questions you may have during your evaluation.

Please direct all technical questions to support@callback.com. To help support technicians assist you as quickly as possible, please provide an detailed and accurate description of your problem, the results you expected, and the results that you received while using our product. For questions about licensing and pricing, and all other general inquiries, please contact sales@callback.com.

Thank You!

Thank you for choosing CBFS Sync for your development needs. We realize that you have a choice among development tools, and that by choosing us you are counting on us to be a key component in your business. We work around the clock to provide you with ongoing enhancements, support, and innovative products; and we will always do our best to exceed your expectations!

Deployment

The user-mode library comes in two pieces, both of which must be deployed with the application:

• A Python module named cbfssync.py.
• A native library (unmanaged), named as follows:
  • Windows: pycbfssync22.dll (available for x64 and x86 processor architectures)
  • Linux: libpycbfssync.so.22.0 (available for x64 and x86 processor architectures)
  • macOS: libpycbfssync22.0.dylib (available for x64 and ARM64 processor architectures)

Both the module and native library are included in the product's Python package, <install_dir>\cbfssync-22.0.xxxx.tar.gz, which should be installed using pip: cd C:\path\to\install_dir python -m pip install cbfssync-22.0.xxxx.tar.gz

Once the product's Python package has been installed, the module can be imported and used: from cbfssync import *. Nothing else is required to deploy the application.

As an alternative to installing the module using pip, you can utilize the built-in setuptools module to package the module for deployment or install it to the machine. python setup.py build --build-lib=<app_dir> The above setup command packages the module and native library for deployment. A folder is created in the app_dir directory with the module and the native library packaged inside.

Constants

All constants are defined in the cbfssync module.