Please see the File API Reference for more details.
It is often necessary to make use of non-code assets such as datasets, models, or files when generating reports. In many situations, deploying these alongside your script is not ideal.
- If they are deployed on a different cadence to your script; for instance, you want to make use of a model which is trained on a daily cadence, even though the code of your script remains static.
- If they are deployed from a different environment than your script; for instance, you may train a model on Sagemaker and want to use it in your script.
- If they are large, and re-uploading them each time you deploy your script is cumbersome.
For these use-cases, Datapane provides a File API which allows you to upload files from any Python or CLI environment, and access them inside your scripts or through the CLI. See the Python API Docs for more information on using Files.
Upload a file and return an id and a url which you can use to retrieve the file.
Download a file and save it on your local machine.
upload_df, upload_file, upload_obj
All upload methods take the object to upload as the first parameter. Depending on the method, this can be a file path, DataFrame, or a Python object.
All methods have the additional parameters:
||The value of your variable||True|
download_df, download_file, download_obj
Download a DataFrame, file, or object. All download operations have the following parameters:
||The name of your file||True|
||The project to upload the file to.||False|
If you want other people inside your organization to run your apps which access a file which you created, you must specify yourself as the
owner in this method. When someone runs your app, it runs under their name, and if you do not set an explicitly specify the
owner , it will try and look for the file under their name and fail.
If your teammates within your private workspace want to access your file, they need to specifying the name of the file and project name(provided they are a member of that project) in
Now others can use your file for their code!