Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akamai/netstoragekit-python
Akamai Netstorage API for Python
https://github.com/akamai/netstoragekit-python
akamai akamai-netstorage akamai-open filestore netstorage netstorage-api objectstore python
Last synced: 17 days ago
JSON representation
Akamai Netstorage API for Python
- Host: GitHub
- URL: https://github.com/akamai/netstoragekit-python
- Owner: akamai
- License: apache-2.0
- Created: 2016-01-26T13:37:05.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-05-11T14:39:24.000Z (over 1 year ago)
- Last Synced: 2024-04-15T16:22:17.531Z (8 months ago)
- Topics: akamai, akamai-netstorage, akamai-open, filestore, netstorage, netstorage-api, objectstore, python
- Language: Python
- Size: 90.8 KB
- Stars: 24
- Watchers: 14
- Forks: 24
- Open Issues: 7
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
NetstorageAPI: Akamai Netstorage API for Python
===============================================
.. image:: https://img.shields.io/pypi/v/netstorageapi.svg
:target: https://pypi.python.org/pypi/netstorageapi
.. image:: https://travis-ci.org/akamai/NetStorageKit-Python.svg?branch=master
:target: https://travis-ci.org/akamai/NetStorageKit-Python
.. image:: http://img.shields.io/:license-apache-blue.svg
:target: https://github.com/akamai/NetStorageKit-Python/blob/master/LICENSE
NetstorageAPI is Akamai Netstorage (File/Object Store) API for Python and uses `requests `_.
NetstorageAPI supports Python 2.6–2.7 & 3.3–3.6, and runs great on PyPy as `requests `_.
Important
------------
Akamai does not maintain or regulate this package. While it can be incorporated to assist you in API use, Akamai Technical Support will not offer assistance and Akamai cannot be held liable if issues arise from its use.
Installation
------------
To install Netstorage API for Python:
.. code-block:: bash
$ pip install netstorageapi
Example
-------
.. code-block:: python
from akamai.netstorage import Netstorage, NetstorageError
NS_HOSTNAME = 'astin-nsu.akamaihd.net'
NS_KEYNAME = 'astinapi'
NS_KEY = 'xxxxxxxxxx' # Don't expose NS_KEY on public repository.
NS_CPCODE = '360949'
ns = Netstorage(NS_HOSTNAME, NS_KEYNAME, NS_KEY, ssl=False) # ssl is optional (default: False)
local_source = 'hello.txt'
netstorage_destination = '/{0}/hello.txt'.format(NS_CPCODE) # or '/{0}/'.format(NS_CPCODE) is same.
ok, response = ns.upload(local_source, netstorage_destination)
# "ok": True means 200 OK; If False, it's not 200 OK
# "response": # Response object from requests.get|post|put
print(response.text)
# 'Request Processed'
Methods
-------
.. code-block:: python
>>> ns.delete(NETSTORAGE_PATH)
>>> dir_option = {
... 'max_entries': INTEGER,
... 'start': 'STRING',
... 'end': 'STRING',
... 'prefix': 'object-prefix',
... 'slash': 'both',
... 'encoding': 'utf-8'
... }
>>> ns.dir(NETSTORAGE_PATH, dir_option)
>>> ns.download(NETSTORAGE_SOURCE, LOCAL_DESTINATION)
>>> ns.du(NETSTORAGE_PATH)
>>> list_option = {
... 'max_entries': INTEGER,
... 'end': '/CPCODE/path',
... 'encoding': 'utf-8'
... }
>>> ns.list(NETSTORAGE_PATH, list_option)
>>> ns.mkdir(NETSTORAGE_PATH + DIRECTORY_NAME)
>>> ns.mtime(NETSTORAGE_PATH, TIME) # ex) TIME: int(time.time())
>>> ns.quick_delete(NETSTORAGE_DIR) # needs to be enabled on the CP Code
>>> ns.rename(NETSTORAGE_TARGET, NETSTORAGE_DESTINATION)
>>> ns.rmdir(NETSTORAGE_DIR)
>>> ns.stat(NETSTORAGE_PATH)
>>> ns.stream_download(NETSTORAGE_SOURCE)
>>> ns.stream_upload(DATA, NETSTORAGE_DESTINATION)
>>> ns.symlink(NETSTORAGE_TARGET, NETSTORAGE_DESTINATION)
>>> ns.upload(LOCAL_SOURCE_PATH, NETSTORAGE_DESTINATION, INDEX_ZIP=False)
>>>
>>>
>>> # INFO: Return (True/False, Response Object from requests.get|post|put)
>>> # True means 200 OK.
>>> # INFO: Can "upload" Only a single file, not a directory.
>>> # To use 'INDEX_ZIP=True',
>>> # Must turn on index_zip on your Netstorage configuration
>>> # WARN: Can raise NetstorageError at all methods.
>>>
Test
----
You can test all above methods with `unittest script `_
(NOTE: You should input NS_HOSTNAME, NS_KEYNAME, NS_KEY and NS_CPCODE in the script):
.. code-block:: bash
$ python test/test_netstorage.py
[TEST] dir /360949 done
[TEST] mkdir /360949/78fab6cd-f3d8-4fde-a6bf-16dc9c6a22d0 done
[TEST] upload 2f58618a-cacd-4e03-b3a7-21cc92d1bfe9.txt to /360949/78fab6cd-f3d8-4fde-a6bf-16dc9c6a22d0/2f58618a-cacd-4e03-b3a7-21cc92d1bfe9.txt done
[TEST] stream_upload /360949/78fab6cd-f3d8-4fde-a6bf-16dc9c6a22d0/stream_2f58618a-cacd-4e03-b3a7-21cc92d1bfe9.txt done
[TEST] stream_download /360949/78fab6cd-f3d8-4fde-a6bf-16dc9c6a22d0/stream_2f58618a-cacd-4e03-b3a7-21cc92d1bfe9.txt done
[TEST] du done
[TEST] mtime /360949/78fab6cd-f3d8-4fde-a6bf-16dc9c6a22d0/2f58618a-cacd-4e03-b3a7-21cc92d1bfe9.txt to 1508482349 done
[TEST] stat done
[TEST] symlink /360949/78fab6cd-f3d8-4fde-a6bf-16dc9c6a22d0/2f58618a-cacd-4e03-b3a7-21cc92d1bfe9.txt to /360949/78fab6cd-f3d8-4fde-a6bf-16dc9c6a22d0/2f58618a-cacd-4e03-b3a7-21cc92d1bfe9.txt_lnk done
[TEST] rename /360949/78fab6cd-f3d8-4fde-a6bf-16dc9c6a22d0/2f58618a-cacd-4e03-b3a7-21cc92d1bfe9.txt to /360949/78fab6cd-f3d8-4fde-a6bf-16dc9c6a22d0/2f58618a-cacd-4e03-b3a7-21cc92d1bfe9.txt_rename done
[TEST] download /360949/78fab6cd-f3d8-4fde-a6bf-16dc9c6a22d0/2f58618a-cacd-4e03-b3a7-21cc92d1bfe9.txt_rename done
[TEST] delete /360949/78fab6cd-f3d8-4fde-a6bf-16dc9c6a22d0/stream_2f58618a-cacd-4e03-b3a7-21cc92d1bfe9.txt done
[TEST] delete /360949/78fab6cd-f3d8-4fde-a6bf-16dc9c6a22d0/2f58618a-cacd-4e03-b3a7-21cc92d1bfe9.txt_rename done
[TEST] delete /360949/78fab6cd-f3d8-4fde-a6bf-16dc9c6a22d0/2f58618a-cacd-4e03-b3a7-21cc92d1bfe9.txt_lnk done
[TEST] rmdir /360949/78fab6cd-f3d8-4fde-a6bf-16dc9c6a22d0 done
[TEARDOWN] remove 2f58618a-cacd-4e03-b3a7-21cc92d1bfe9.txt from local done
[TEARDOWN] remove 2f58618a-cacd-4e03-b3a7-21cc92d1bfe9.txt_rename from local done
.
[TEST] Invalid ns path NetstorageError test done
[TEST] Invalid local path NetstorageError test done
[TEST] Download directory path NetstorageError test done
.
----------------------------------------------------------------------
Ran 2 tests in x.xxxs
OK
Command
-------
You can run the `script `_ with command line parameters.
.. code-block:: bash
$ python cms_netstorage.py -H astin-nsu.akamaihd.net -k astinapi -K xxxxxxxxxx -a dir /360949
Use -h or --help option for more detail.
Author
------
Astin Choi ([email protected])
License
-------
Copyright 2016 Akamai Technologies, 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 ``_.
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.