<p align="center">
<img src="https://github.com/box/sdks/blob/master/images/box-dev-logo.png" alt= “box-dev-logo” width="30%" height="50%">
</p>
# Box Python SDK GENERATED
We are excited to introduce the latest generation (currently in Beta) of Box Python SDK, designed to elevate the developer experience and streamline your integration with the Box Content Cloud.
With this SDK, you’ll have access to:
1. Full API Support: The new generation of Box SDKs empowers developers with complete coverage of the Box API ecosystem. You can now access all the latest features and functionalities offered by Box, allowing you to build even more sophisticated and feature-rich applications.
2. Rapid API Updates: Say goodbye to waiting for new Box APIs to be incorporated into the SDK. With our new auto-generation development approach, we can now add new Box APIs to the SDK at a much faster pace (in a matter of days). This means you can leverage the most up-to-date features in your applications without delay.
3. Embedded Documentation: We understand that easy access to information is crucial for developers. With our new approach, we have included comprehensive documentation for all objects and parameters directly in the source code of the SDK. This means you no longer need to look up this information on the developer portal, saving you time and streamlining your development process.
4. Enhanced Convenience Methods: Our commitment to enhancing your development experience continues with the introduction of convenience methods. These methods cover various aspects such as chunk uploads, classification, and much more.
5. Seamless Start: The new SDKs integrate essential functionalities like authentication, automatic retries with exponential backoff, exception handling, request cancellation, and type checking, enabling you to focus solely on your application's business logic.
Embrace the new generation of Box SDKs and unlock the full potential of the Box Content Cloud.
# Table of contents
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
- [Installing](#installing)
- [Getting Started](#getting-started)
- [Integration Tests](#integration-tests)
- [Running integration tests locally](#running-integration-tests-locally)
- [Create Custom Application](#create-custom-application)
- [Export configuration](#export-configuration)
- [Running tests](#running-tests)
- [Questions, Bugs, and Feature Requests?](#questions-bugs-and-feature-requests)
- [Copyright and License](#copyright-and-license)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
# Installing
```console
pip install box-sdk-gen
```
This is autogenerated Box SDK Beta version.
Supported Python versions are Python 3.8 and above.
To install also extra dependencies required for JWT authentication, use command:
```console
pip install box-sdk-gen[jwt]
```
# Getting Started
To get started with the SDK, get a Developer Token from the Configuration page of your app in the [Box Developer
Console](https://app.box.com/developers/console). You can use this token to make test calls for your own Box account.
The SDK provides an `BoxDeveloperTokenAuth` class, which allows you to authenticate using your Developer Token.
Use instance of `BoxDeveloperTokenAuth` to initialize `BoxClient` object.
Using `BoxClient` object you can access managers, which allow you to perform some operations on your Box account.
The example below demonstrates how to authenticate with Developer Token and print names of all items inside a root folder.
```python
from box_sdk_gen import BoxClient, BoxDeveloperTokenAuth
def main(token: str):
auth: BoxDeveloperTokenAuth = BoxDeveloperTokenAuth(token=token)
client: BoxClient = BoxClient(auth=auth)
for item in client.folders.get_folder_items('0').entries:
print(item.name)
if __name__ == '__main__':
main('INSERT YOUR DEVELOPER TOKEN HERE')
```
# Integration Tests
## Running integration tests locally
### Create Custom Application
To run integration tests locally you will need a `Custom App` created in the [Box Developer
Console](https://app.box.com/developers/console)
with `Server Authentication (with JWT)` selected as authentication method.
Once created you can edit properties of the application:
- In section `App Access Level` select `App + Enterprise Access`. You can enable all `Application Scopes`.
- In section `Advanced Features` enable `Make API calls using the as-user header` and `Generate user access tokens`.
Now select `Authorization` and submit application to be reviewed by account admin.
### Export configuration
1. Select `Configuration` tab and in the bottom in the section `App Settings`
download your app configuration settings as JSON.
2. Encode configuration file to Base64, e.g. using command: `base64 -i path_to_json_file`
3. Set environment variable: `JWT_CONFIG_BASE_64` with base64 encoded jwt configuration file
4. Set environment variable: `BOX_FILE_REQUEST_ID` with ID of file request already created in the user account, `BOX_EXTERNAL_USER_EMAIL` with email of free external user which not belongs to any enterprise.
5. Set environment variable: `WORKFLOW_FOLDER_ID` with the ID of the Relay workflow that deletes the file that triggered the workflow. The workflow should have a manual start to be able to start it from the API.
### Running tests
To run integration tests locally:
1. `pip install -r requirements-test.txt`
2. `pytest`
# Questions, Bugs, and Feature Requests?
Need to contact us directly? [Browse the issues
tickets](https://github.com/box/box-python-sdk-gen/issues)! Or, if that
doesn't work, [file a new
one](https://github.com/box/box-python-sdk-gen/issues/new) and we will get
back to you. If you have general questions about the Box API, you can
post to the [Box Developer Forum](https://forum.box.com/).
# Copyright and License
Copyright 2023 Box, Inc. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Raw data
{
"_id": null,
"home_page": "https://github.com/box/box-python-sdk-gen.git",
"name": "box-sdk-gen",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "box, sdk, api, rest, boxsdk",
"author": "Box",
"author_email": "oss@box.com",
"download_url": "https://files.pythonhosted.org/packages/7c/ff/281a74c9ceeb4e3f9570ae7ef03e27cb748c5dee8f333d6db3bf8c0e4649/box-sdk-gen-0.6.4.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"https://github.com/box/sdks/blob/master/images/box-dev-logo.png\" alt= \u201cbox-dev-logo\u201d width=\"30%\" height=\"50%\">\n</p>\n\n# Box Python SDK GENERATED\n\nWe are excited to introduce the latest generation (currently in Beta) of Box Python SDK, designed to elevate the developer experience and streamline your integration with the Box Content Cloud.\n\nWith this SDK, you\u2019ll have access to:\n\n1. Full API Support: The new generation of Box SDKs empowers developers with complete coverage of the Box API ecosystem. You can now access all the latest features and functionalities offered by Box, allowing you to build even more sophisticated and feature-rich applications.\n2. Rapid API Updates: Say goodbye to waiting for new Box APIs to be incorporated into the SDK. With our new auto-generation development approach, we can now add new Box APIs to the SDK at a much faster pace (in a matter of days). This means you can leverage the most up-to-date features in your applications without delay.\n3. Embedded Documentation: We understand that easy access to information is crucial for developers. With our new approach, we have included comprehensive documentation for all objects and parameters directly in the source code of the SDK. This means you no longer need to look up this information on the developer portal, saving you time and streamlining your development process.\n4. Enhanced Convenience Methods: Our commitment to enhancing your development experience continues with the introduction of convenience methods. These methods cover various aspects such as chunk uploads, classification, and much more.\n5. Seamless Start: The new SDKs integrate essential functionalities like authentication, automatic retries with exponential backoff, exception handling, request cancellation, and type checking, enabling you to focus solely on your application's business logic.\n\nEmbrace the new generation of Box SDKs and unlock the full potential of the Box Content Cloud.\n\n# Table of contents\n\n<!-- START doctoc generated TOC please keep comment here to allow auto update -->\n<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->\n\n- [Installing](#installing)\n- [Getting Started](#getting-started)\n- [Integration Tests](#integration-tests)\n - [Running integration tests locally](#running-integration-tests-locally)\n - [Create Custom Application](#create-custom-application)\n - [Export configuration](#export-configuration)\n - [Running tests](#running-tests)\n- [Questions, Bugs, and Feature Requests?](#questions-bugs-and-feature-requests)\n- [Copyright and License](#copyright-and-license)\n\n<!-- END doctoc generated TOC please keep comment here to allow auto update -->\n\n# Installing\n\n```console\npip install box-sdk-gen\n```\n\nThis is autogenerated Box SDK Beta version.\nSupported Python versions are Python 3.8 and above.\n\nTo install also extra dependencies required for JWT authentication, use command:\n\n```console\npip install box-sdk-gen[jwt]\n```\n\n# Getting Started\n\nTo get started with the SDK, get a Developer Token from the Configuration page of your app in the [Box Developer\nConsole](https://app.box.com/developers/console). You can use this token to make test calls for your own Box account.\n\nThe SDK provides an `BoxDeveloperTokenAuth` class, which allows you to authenticate using your Developer Token.\nUse instance of `BoxDeveloperTokenAuth` to initialize `BoxClient` object.\nUsing `BoxClient` object you can access managers, which allow you to perform some operations on your Box account.\n\nThe example below demonstrates how to authenticate with Developer Token and print names of all items inside a root folder.\n\n```python\nfrom box_sdk_gen import BoxClient, BoxDeveloperTokenAuth\n\ndef main(token: str):\n auth: BoxDeveloperTokenAuth = BoxDeveloperTokenAuth(token=token)\n client: BoxClient = BoxClient(auth=auth)\n for item in client.folders.get_folder_items('0').entries:\n print(item.name)\n\nif __name__ == '__main__':\n main('INSERT YOUR DEVELOPER TOKEN HERE')\n```\n\n# Integration Tests\n\n## Running integration tests locally\n\n### Create Custom Application\n\nTo run integration tests locally you will need a `Custom App` created in the [Box Developer\nConsole](https://app.box.com/developers/console)\nwith `Server Authentication (with JWT)` selected as authentication method.\nOnce created you can edit properties of the application:\n\n- In section `App Access Level` select `App + Enterprise Access`. You can enable all `Application Scopes`.\n- In section `Advanced Features` enable `Make API calls using the as-user header` and `Generate user access tokens`.\n\nNow select `Authorization` and submit application to be reviewed by account admin.\n\n### Export configuration\n\n1. Select `Configuration` tab and in the bottom in the section `App Settings`\n download your app configuration settings as JSON.\n2. Encode configuration file to Base64, e.g. using command: `base64 -i path_to_json_file`\n3. Set environment variable: `JWT_CONFIG_BASE_64` with base64 encoded jwt configuration file\n4. Set environment variable: `BOX_FILE_REQUEST_ID` with ID of file request already created in the user account, `BOX_EXTERNAL_USER_EMAIL` with email of free external user which not belongs to any enterprise.\n5. Set environment variable: `WORKFLOW_FOLDER_ID` with the ID of the Relay workflow that deletes the file that triggered the workflow. The workflow should have a manual start to be able to start it from the API.\n\n### Running tests\n\nTo run integration tests locally:\n\n1. `pip install -r requirements-test.txt`\n2. `pytest`\n\n# Questions, Bugs, and Feature Requests?\n\nNeed to contact us directly? [Browse the issues\ntickets](https://github.com/box/box-python-sdk-gen/issues)! Or, if that\ndoesn't work, [file a new\none](https://github.com/box/box-python-sdk-gen/issues/new) and we will get\nback to you. If you have general questions about the Box API, you can\npost to the [Box Developer Forum](https://forum.box.com/).\n\n# Copyright and License\n\nCopyright 2023 Box, Inc. All rights reserved.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n",
"bugtrack_url": null,
"license": "Apache-2.0, http://www.apache.org/licenses/LICENSE-2.0",
"summary": "[Box Platform](https://box.dev) provides functionality to provide access to content stored within [Box](https://box.com). It provides endpoints for basic manipulation of files and folders, management of users within an enterprise, as well as more complex topics such as legal holds and retention policies.",
"version": "0.6.4",
"project_urls": {
"Homepage": "https://github.com/box/box-python-sdk-gen.git"
},
"split_keywords": [
"box",
" sdk",
" api",
" rest",
" boxsdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fccca95441e486478ed111180bfbbeb18f07d30ee9e3fb7ad245aa1fd4e24d2c",
"md5": "c99198b9a97435165c1f34098dd35809",
"sha256": "c60996018b3216459aab443d1a7427ffae730073b8708e6ff987d358806a0773"
},
"downloads": -1,
"filename": "box_sdk_gen-0.6.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c99198b9a97435165c1f34098dd35809",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 264504,
"upload_time": "2024-04-04T15:27:43",
"upload_time_iso_8601": "2024-04-04T15:27:43.834571Z",
"url": "https://files.pythonhosted.org/packages/fc/cc/a95441e486478ed111180bfbbeb18f07d30ee9e3fb7ad245aa1fd4e24d2c/box_sdk_gen-0.6.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7cff281a74c9ceeb4e3f9570ae7ef03e27cb748c5dee8f333d6db3bf8c0e4649",
"md5": "59a2e211ef78227fea88ec8b49b838fc",
"sha256": "048e8478b27212d8a4c7d66f9e84a0de75ee898ad06f09ad5a53e4ac62b2f8c5"
},
"downloads": -1,
"filename": "box-sdk-gen-0.6.4.tar.gz",
"has_sig": false,
"md5_digest": "59a2e211ef78227fea88ec8b49b838fc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 182555,
"upload_time": "2024-04-04T15:27:46",
"upload_time_iso_8601": "2024-04-04T15:27:46.370344Z",
"url": "https://files.pythonhosted.org/packages/7c/ff/281a74c9ceeb4e3f9570ae7ef03e27cb748c5dee8f333d6db3bf8c0e4649/box-sdk-gen-0.6.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 15:27:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "box",
"github_project": "box-python-sdk-gen",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "box-sdk-gen"
}
JSON
