Skip to main content
https://img.shields.io/pypi/v/netstorageapi.svg https://travis-ci.org/akamai-open/NetStorageKit-Python.svg?branch=master http://img.shields.io/:license-apache-blue.svg

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.

Installation

To install Netstorage API for Python:

$ pip install netstorageapi

Example

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 [200]> # Response object from requests.get|post|put
print(response.text)
# '<HTML>Request Processed</HTML>'

Methods

>>> ns.delete(NETSTORAGE_PATH)
>>> ns.dir(NETSTORAGE_PATH)
>>> ns.download(NETSTORAGE_SOURCE, LOCAL_DESTINATION)
>>> ns.du(NETSTORAGE_PATH)
>>> 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.symlink(NETSTORAGE_TARGET, NETSTORAGE_DESTINATION)
>>> ns.upload(LOCAL_SOURCE, NETSTORAGE_DESTINATION, INDEX_ZIP)
>>>
>>>
>>> # 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.
>>> #       "upload" INDEX_ZIP value is are bool(True or False).
>>> #       (This supports only for FileStore)
>>> # 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):

$ python test/test_netstorage.py
[TEST] dir /360949 done
[TEST] mkdir /360949/048a30de-e6af-45d0-81e6-fc38bf985fb9 done
[TEST] upload 6ae30c1a-289a-42a7-9d3d-f634357098b3.txt to /360949/048a30de-e6af-45d0-81e6-fc38bf985fb9/6ae30c1a-289a-42a7-9d3d-f634357098b3.txt done
[TEST] du done
[TEST] mtime /360949/048a30de-e6af-45d0-81e6-fc38bf985fb9/6ae30c1a-289a-42a7-9d3d-f634357098b3.txt to 1462674018 done
[TEST] stat done
[TEST] symlink /360949/048a30de-e6af-45d0-81e6-fc38bf985fb9/6ae30c1a-289a-42a7-9d3d-f634357098b3.txt to /360949/048a30de-e6af-45d0-81e6-fc38bf985fb9/6ae30c1a-289a-42a7-9d3d-f634357098b3.txt_lnk done
[TEST] rename /360949/048a30de-e6af-45d0-81e6-fc38bf985fb9/6ae30c1a-289a-42a7-9d3d-f634357098b3.txt to /360949/048a30de-e6af-45d0-81e6-fc38bf985fb9/6ae30c1a-289a-42a7-9d3d-f634357098b3.txt_rename done
[TEST] download /360949/048a30de-e6af-45d0-81e6-fc38bf985fb9/6ae30c1a-289a-42a7-9d3d-f634357098b3.txt_rename done
[TEST] delete /360949/048a30de-e6af-45d0-81e6-fc38bf985fb9/6ae30c1a-289a-42a7-9d3d-f634357098b3.txt_rename done
[TEST] delete /360949/048a30de-e6af-45d0-81e6-fc38bf985fb9/6ae30c1a-289a-42a7-9d3d-f634357098b3.txt_lnk done
[TEST] rmdir /360949/048a30de-e6af-45d0-81e6-fc38bf985fb9 done
[TEARDOWN] remove 6ae30c1a-289a-42a7-9d3d-f634357098b3.txt from local done
[TEARDOWN] remove 6ae30c1a-289a-42a7-9d3d-f634357098b3.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.

$ 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 (achoi@akamai.com)

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 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.

Release files for netstorageapi 1.2.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for netstorageapi 1.2.7
File Size Uploaded
netstorageapi-1.2.7.tar.gz 6.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for netstorageapi 1.2.7
File Interpreter ABI Platform
netstorageapi-1.2.7-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 15.6 kB

Release files / netstorageapi-1.2.7.tar.gz

Download URL netstorageapi-1.2.7.tar.gz
Size 6.7 kB
Tags Source
SHA-256 checksum
How to use checksums
e953c74b610a8759a8ab856a8de0b0be582b722a1bb73f6f1110d4e7c4ae1417
BLAKE2b-256 checksum
How to use checksums
d7a00af832b2d7bee73ee123e79719ac7856e0beed1c54faecbddd193c4de05d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / netstorageapi-1.2.7-py2.py3-none-any.whl

Download URL netstorageapi-1.2.7-py2.py3-none-any.whl
Size 9.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
b2dc837ee0911276ee077bb1c7d145c2578ee98117edee766b4b7e8bb3597239
BLAKE2b-256 checksum
How to use checksums
7842663825d9c440139d5eba23a020ac29c548f14b002776ec1cc8d070284049
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

1.2.11

2 release files

1.2.10

2 release files

1.2.9

1 release file

1.2.8

2 release files

This release

1.2.7 This release

2 release files

1.2.6

2 release files

1.2.5

2 release files

1.2.4

2 release files

1.2.3

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page