Egnyte Public API SDK
Project description
Egnyte SDK
==========
This is the official Python client library for Egnyte.com Public APIs.
For overview of the HTTP API, go to https://developers.egnyte.com
Getting an API key
==================
Register on https://developers.egnyte.com/member/register to get API key
for your Egnyte account. This key is required to generate Egnyte OAuth
token.
Examples
========
* create a client object
.. code-block:: python
from egnyte import EgnyteClient
client = EgnyteClient({"domain": "<your domain here>.egnyte.com",
"access_token": "<your access token here"})
* create a folder
.. code-block:: python
folder = client.folder("/Shared/new").create(ignore_if_exists=True)
* delete a folder
.. code-block:: python
client.folder("/Shared/time to say goodbye").delete()
* get a list of files in a folder, download a file, replace it's contents, add a note
.. code-block:: python
folder = client.folder("/Shared/foo that need to be bar")
folder.list()
for file_obj in folder.files:
with file_obj.download() as download:
data = download.read()
# replace file contents
file_obj.upload(data.replace(b"foo", b"bar"))
file_obj.add_note("all occurrences of 'foo' replaced by 'bar'!")
* get a list of files in a subfolders
.. code-block:: python
folder = client.folder("/Shared")
folder.list()
for folder_obj in folder.folders:
do_something(folder_obj)
* upload a new file from local file
.. code-block:: python
file_obj = client.file("/Private/smeagol/my precious")
with open("local path", "rb") as fp:
file_obj.upload(fp)
* delete a file
.. code-block:: python
file_obj.delete()
* do a recursive download
.. code-block:: python
client.bulk_download(['/Shared/a dir', '/Shared/another dir'],
'/home/smeagol/', overwrite=True)
* do a recursive upload
.. code-block:: python
api.bulk_upload(['/tmp/some directory', '/tmp/some file'], '/Shared/Marketing')
Full documentation
==================
docs subdirectory contains just the source for the documentation.
You can read built docs at http://<to be determined>
Command line
============
If you're using implicit flow, you'll need to provide access token directly.
If you're using API token with resource flow, you can generate API access token using command line options.
See the full documentation or install, then use:
python -m egnyte -h
Dependencies
============
This library depends on:
- requests 2.2.1 or later - for HTTPS calls
- six 1.8.0 or later - for Python 2 and 3 compatibility using same
source
Thread safety
=============
Each client object should be used from one thread at a time. This
library does no locking of it's own - it is responsibility of the caller
to do so if necessary.
Running tests
=============
Tests can be run with nose or trial directly on the egnyte package, or
from setup.py:
python setup.py test
or
python setyp.py nosetests
Integration tests will be skipped unless you create ~/.egnyte/test\_config.json
You can create this file manually or with following command:
python -m egnyte -c test\_config.json config create -k -d -l \[-p ]
Helping with development
========================
First, report any problems you find to
https://developers.egnyte.com/forum/ or api-support@egnyte.com
If you'd like to fix something yourself, please fork this repository,
commit the fixes and updates to tests, then set up a pull request with
information what you're fixing.
Please remember to assign copyright of your fixes to Egnyte or make them
public domain so we can legally merge them.
==========
This is the official Python client library for Egnyte.com Public APIs.
For overview of the HTTP API, go to https://developers.egnyte.com
Getting an API key
==================
Register on https://developers.egnyte.com/member/register to get API key
for your Egnyte account. This key is required to generate Egnyte OAuth
token.
Examples
========
* create a client object
.. code-block:: python
from egnyte import EgnyteClient
client = EgnyteClient({"domain": "<your domain here>.egnyte.com",
"access_token": "<your access token here"})
* create a folder
.. code-block:: python
folder = client.folder("/Shared/new").create(ignore_if_exists=True)
* delete a folder
.. code-block:: python
client.folder("/Shared/time to say goodbye").delete()
* get a list of files in a folder, download a file, replace it's contents, add a note
.. code-block:: python
folder = client.folder("/Shared/foo that need to be bar")
folder.list()
for file_obj in folder.files:
with file_obj.download() as download:
data = download.read()
# replace file contents
file_obj.upload(data.replace(b"foo", b"bar"))
file_obj.add_note("all occurrences of 'foo' replaced by 'bar'!")
* get a list of files in a subfolders
.. code-block:: python
folder = client.folder("/Shared")
folder.list()
for folder_obj in folder.folders:
do_something(folder_obj)
* upload a new file from local file
.. code-block:: python
file_obj = client.file("/Private/smeagol/my precious")
with open("local path", "rb") as fp:
file_obj.upload(fp)
* delete a file
.. code-block:: python
file_obj.delete()
* do a recursive download
.. code-block:: python
client.bulk_download(['/Shared/a dir', '/Shared/another dir'],
'/home/smeagol/', overwrite=True)
* do a recursive upload
.. code-block:: python
api.bulk_upload(['/tmp/some directory', '/tmp/some file'], '/Shared/Marketing')
Full documentation
==================
docs subdirectory contains just the source for the documentation.
You can read built docs at http://<to be determined>
Command line
============
If you're using implicit flow, you'll need to provide access token directly.
If you're using API token with resource flow, you can generate API access token using command line options.
See the full documentation or install, then use:
python -m egnyte -h
Dependencies
============
This library depends on:
- requests 2.2.1 or later - for HTTPS calls
- six 1.8.0 or later - for Python 2 and 3 compatibility using same
source
Thread safety
=============
Each client object should be used from one thread at a time. This
library does no locking of it's own - it is responsibility of the caller
to do so if necessary.
Running tests
=============
Tests can be run with nose or trial directly on the egnyte package, or
from setup.py:
python setup.py test
or
python setyp.py nosetests
Integration tests will be skipped unless you create ~/.egnyte/test\_config.json
You can create this file manually or with following command:
python -m egnyte -c test\_config.json config create -k -d -l \[-p ]
Helping with development
========================
First, report any problems you find to
https://developers.egnyte.com/forum/ or api-support@egnyte.com
If you'd like to fix something yourself, please fork this repository,
commit the fixes and updates to tests, then set up a pull request with
information what you're fixing.
Please remember to assign copyright of your fixes to Egnyte or make them
public domain so we can legally merge them.
