code
stringlengths 1
5.19M
| package
stringlengths 1
81
| path
stringlengths 9
304
| filename
stringlengths 4
145
|
|---|---|---|---|
#Imports
import scipy
from scipy import ndimage
import numpy as np
class RotateImage(object):
'''
Rotates the image about the centre of the image.
'''
def __init__(self, degrees):
'''
Arguments:
degrees: rotation degree.
'''
self.degrees = degrees
# Write your code here
def __call__(self, sample):
'''
Arguments:
image (numpy array or PIL image)
Returns:
image (numpy array or PIL image)
'''
return scipy.ndimage.rotate(sample, self.degrees)
|
19CS30055-package1
|
/19CS30055_package1-0.0.6.tar.gz/19CS30055_package1-0.0.6/my_package/data/transforms/rotate.py
|
rotate.py
|
#Imports
import numpy as np
from scipy.ndimage.filters import gaussian_filter
class BlurImage(object):
'''
Applies Gaussian Blur on the image.
'''
def __init__(self, radius):
self.radius = radius
'''
Arguments:
radius (int): radius to blur
'''
# Write your code here
def __call__(self, image):
'''
Arguments:
image (numpy array or PIL Image)
Returns:
image (numpy array or PIL Image)
'''
return (gaussian_filter(image, sigma=[self.radius, self.radius, 0]))
|
19CS30055-package1
|
/19CS30055_package1-0.0.6.tar.gz/19CS30055_package1-0.0.6/my_package/data/transforms/blur.py
|
blur.py
|
#Imports
import numpy as np
from skimage.transform import resize
import cv2
import math
class RescaleImage(object):
'''
Rescales the image to a given size.
'''
def __init__(self, output_size):
self.output_size = output_size
''' Arguments:
output_size (tuple or int): Desired output size. If tuple, output is
matched to output_size. If int, smaller of image edges is matched
to output_size keeping aspect ratio the same.
'''
# Write your code here
def __call__(self, image):
'''
Arguments:
image (numpy array or PIL image)
Returns:
image (numpy array or PIL image)
Note: You do not need to resize the bounding boxes. ONLY RESIZE THE IMAGE.
'''
image_resized = np.array([])
if(isinstance(self.output_size, tuple)):
image_resized = resize(image, self.output_size)
return image_resized
elif(isinstance(self.output_size, int)):
h, w, ch = image.shape
if(w < h):
image_resized = resize(image, (math.floor(h*self.output_size/w), self.output_size), anti_aliasing = True)
return image_resized
else:
image_resized = resize(image, (self.output_size, math.floor(w*self.output_size/h)), anti_aliasing = True)
return image_resized
|
19CS30055-package1
|
/19CS30055_package1-0.0.6.tar.gz/19CS30055_package1-0.0.6/my_package/data/transforms/rescale.py
|
rescale.py
|
from .blur import BlurImage
from .crop import CropImage
from .flip import FlipImage
from .rotate import RotateImage
from .rescale import RescaleImage
|
19CS30055-package1
|
/19CS30055_package1-0.0.6.tar.gz/19CS30055_package1-0.0.6/my_package/data/transforms/__init__.py
|
__init__.py
|
# -1NeuronPerceptron_Pypi
1Neuron|Perceptron|_Pypi
"""
author: Nazmul
email: [email protected]
"""
## How to use this
## First install the library using below command by using latest version-
```bash
pip install 1NeuronPerceptron-Pypi-mdnazmulislam0087==0.0.4
```
## Run the below code to see the training and plot file for or Gate, similarly you can use AND, NAND and XOR GATE to see the difference-
```python
from oneNeuronPerceptron.perceptron import Perceptron
from oneNeuronPerceptron.all_utils import prepare_data, save_model, save_plot
import pandas as pd
import numpy as np
import logging
import os
logging_str = "[%(asctime)s: %(levelname)s: %(module)s] %(message)s"
logging.basicConfig(level=logging.INFO, format=logging_str)
def main(data, eta, epochs, modelfilename,plotfilename):
df = pd.DataFrame(data)
logging.info(f"The dataframe is : {df}")
X,y = prepare_data(df)
model = Perceptron(eta=eta, epochs=epochs)
model.fit(X, y)
_ = model.total_loss()
save_model(model, filename=modelfilename)
save_plot(df, file_name=plotfilename, model=model)
if __name__=="__main__": # << entry point <<
OR = {
"x1": [0,0,1,1],
"x2": [0,1,0,1],
"y": [0,1,1,1],
}
ETA = 0.3 # 0 and 1
EPOCHS = 10
try:
logging.info(">>>>> starting training >>>>>")
main(data=OR, eta=ETA, epochs=EPOCHS, modelfilename="or.model", plotfilename="or.png")
logging.info("<<<<< training done successfully<<<<<\n")
except Exception as e:
logging.exception(e)
raise e
```
# Packages required-
1. matplotlib
2. numpy
3. pandas
4. joblib
5. tqdm
# Limitation
Using one Neuron Perceptron, We cant make decision boundary for XOR GATe, In summary XOR Gate classification is not possible using one Neuron Perceptron
# Reference -
[official python docs](https://packaging.python.org/tutorials/packaging-projects/)
[github docs for github actions](https://docs.github.com/en/actions/guides/building-and-testing-python#publishing-to-package-registries)
[Read me editor](https://readme.so/editor)
# more details can be found
[1Neuron Perceptron](https://github.com/mdnazmulislam0087/1NeuronPerceptron)
|
1NeuronPerceptron-Pypi-mdnazmulislam0087
|
/1NeuronPerceptron_Pypi-mdnazmulislam0087-0.0.4.tar.gz/1NeuronPerceptron_Pypi-mdnazmulislam0087-0.0.4/README.md
|
README.md
|
import setuptools
with open("README.md", "r", encoding="utf-8") as fh:
long_description = fh.read()
PROJECT_NAME = "1NeuronPerceptron_Pypi"
USER_NAME = "mdnazmulislam0087"
setuptools.setup(
name=f"{PROJECT_NAME}-{USER_NAME}",
version="0.0.4",
author=USER_NAME,
author_email="[email protected]",
description="its an implimentation of Perceptron",
long_description=long_description,
long_description_content_type="text/markdown",
url=f"https://github.com/{USER_NAME}/{PROJECT_NAME}",
project_urls={
"Bug Tracker": f"https://github.com/{USER_NAME}/{PROJECT_NAME}/issues",
},
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
package_dir={"": "src"},
packages=setuptools.find_packages(where="src"),
python_requires=">=3.7",
install_requires=[
"numpy",
"tqdm",
"matplotlib",
"numpy",
"pandas",
"joblib"
]
)
|
1NeuronPerceptron-Pypi-mdnazmulislam0087
|
/1NeuronPerceptron_Pypi-mdnazmulislam0087-0.0.4.tar.gz/1NeuronPerceptron_Pypi-mdnazmulislam0087-0.0.4/setup.py
|
setup.py
|
"""
author: Nazmul
email: [email protected]
"""
import matplotlib.pyplot as plt
import numpy as np
import pandas as pd
import joblib # FOR SAVING MY MODEL AS A BINARY FILE
from matplotlib.colors import ListedColormap
import os
import logging
plt.style.use("fivethirtyeight") # THIS IS STYLE OF GRAPHS
# prepare data
def prepare_data(df):
""" This is used to separate the dependent and independent columns/features
Args:
df (pd.DataFrame): input is the pandas DataFrame
Returns:
tuple: This returns the dependent and independent columns/features
"""
logging.info("Preparing the data by segregating the independent and dependent variables")
X = df.drop("y", axis=1)
y = df["y"]
return X, y
# save model
def save_model(model, filename):
""" This is used to save the model in binary format.
Args:
model (python object): Trained Model
filename (filename): File name of the model that to be saved
"""
logging.info("saving the trained model")
model_dir = "models"
os.makedirs(model_dir, exist_ok=True) # ONLY CREATE IF MODEL_DIR DOESN"T EXISTS
filePath = os.path.join(model_dir, filename) # model/filename
joblib.dump(model, filePath)
logging.info(f"saved the trained model {filePath}")
# Save plot
def save_plot(df, file_name, model):
"""This is used to save the plot of the model
Args:
df (Pandas Dataframe): This is the dataframe
file_name (object): Name of the file to be saved
model (object): model name that is Trained
"""
logging.info("saving the Plot and Decision boudary")
def _create_base_plot(df):
logging.info("creating the base plot")
df.plot(kind="scatter", x="x1", y="x2", c="y", s=100, cmap="winter")
plt.axhline(y=0, color="black", linestyle="--", linewidth=1)
plt.axvline(x=0, color="black", linestyle="--", linewidth=1)
figure = plt.gcf() # get current figure
figure.set_size_inches(10, 8)
def _plot_decision_regions(X, y, classfier, resolution=0.02):
logging.info("plotting the decision regions")
colors = ("red", "blue", "lightgreen", "gray", "cyan")
cmap = ListedColormap(colors[: len(np.unique(y))])
X = X.values # as a array
x1 = X[:, 0]
x2 = X[:, 1]
x1_min, x1_max = x1.min() -1 , x1.max() + 1
x2_min, x2_max = x2.min() -1 , x2.max() + 1
xx1, xx2 = np.meshgrid(np.arange(x1_min, x1_max, resolution),
np.arange(x2_min, x2_max, resolution))
logging.info(xx1)
logging.info(xx1.ravel())
Z = classfier.predict(np.array([xx1.ravel(), xx2.ravel()]).T)
Z = Z.reshape(xx1.shape)
plt.contourf(xx1, xx2, Z, alpha=0.2, cmap=cmap)
plt.xlim(xx1.min(), xx1.max())
plt.ylim(xx2.min(), xx2.max())
plt.plot()
X, y = prepare_data(df)
_create_base_plot(df)
_plot_decision_regions(X, y, model)
plot_dir = "plots"
os.makedirs(plot_dir, exist_ok=True) # ONLY CREATE IF MODEL_DIR DOESN"T EXISTS
plotPath = os.path.join(plot_dir, file_name) # model/filename
plt.savefig(plotPath)
logging.info(f"saved the plot in {plotPath}")
|
1NeuronPerceptron-Pypi-mdnazmulislam0087
|
/1NeuronPerceptron_Pypi-mdnazmulislam0087-0.0.4.tar.gz/1NeuronPerceptron_Pypi-mdnazmulislam0087-0.0.4/src/oneNeuronPerceptron/all_utils.py
|
all_utils.py
|
"""
author: Nazmul
email: [email protected]
"""
import numpy as np
import logging
from tqdm import tqdm
class Perceptron:
def __init__(self, eta, epochs):
self.weights = np.random.randn(3) * 1e-4 # SMALL WEIGHT INIT
logging.info(f"initial weights before training: \n{self.weights}")
self.eta = eta # LEARNING RATE
self.epochs = epochs
def activationFunction(self, inputs, weights):
z = np.dot(inputs, weights) # z = W * X
return np.where(z > 0, 1, 0) # CONDITION, IF TRUE, ELSE
def fit(self, X, y):
self.X = X
self.y = y
X_with_bias = np.c_[self.X, -np.ones((len(self.X), 1))] # CONCATINATION
logging.info(f"X with bias: \n{X_with_bias}")
for epoch in tqdm(range(self.epochs), total=self.epochs, desc="training the model"):
#for epoch in range(self.epochs):
logging.info("--"*10)
logging.info(f"for epoch: {epoch}")
logging.info("--"*10)
y_hat = self.activationFunction(X_with_bias, self.weights) # foward propagation
logging.info(f"predicted value after forward pass: \n{y_hat}")
self.error = self.y - y_hat
logging.info(f"error: \n{self.error}")
self.weights = self.weights + self.eta * np.dot(X_with_bias.T, self.error) # backward propagation
logging.info(f"updated weights after epoch:\n{epoch}/{self.epochs} : \n{self.weights}")
logging.info("#####"*10)
def predict(self, X): # SAME AS FORWARD PROPAGATION
X_with_bias = np.c_[X, -np.ones((len(X), 1))]
return self.activationFunction(X_with_bias, self.weights)
def total_loss(self):
total_loss = np.sum(self.error)
logging.info(f"total loss: {total_loss}")
return total_loss
|
1NeuronPerceptron-Pypi-mdnazmulislam0087
|
/1NeuronPerceptron_Pypi-mdnazmulislam0087-0.0.4.tar.gz/1NeuronPerceptron_Pypi-mdnazmulislam0087-0.0.4/src/oneNeuronPerceptron/perceptron.py
|
perceptron.py
|
from setuptools import setup
setup(name = '1OS',
version = '0.1',
description = '1OS',
url = 'https://github.com/1deos/1OS',
author = 'Drew DeSantis',
author_email = '[email protected]',
license = 'OpenBSV',
packages = ['1OS'],
zip_safe = False)
|
1OS
|
/1OS-0.1.tar.gz/1OS-0.1/setup.py
|
setup.py
|
如需要使用所有插件功能需要注册收费版
|
1Q847
|
/1Q847-1.1.8.tar.gz/1Q847-1.1.8/README.md
|
README.md
|
from setuptools import setup
setup(name='1Q847',
version='1.1.8',
description='模拟操作',
url='https://github.com/qxt514657/',
author='1Q847',
author_email='[email protected]',
license='MIT',
packages=['Dll'], # 包名
package_data={'Dll': ['dm.dll', 'DmReg.dll']},
install_requires=[
'pywin32', 'comtypes'
],
python_requires='>=3.7',
)
|
1Q847
|
/1Q847-1.1.8.tar.gz/1Q847-1.1.8/setup.py
|
setup.py
|
import ctypes
import os,time
from subprocess import Popen, PIPE
from comtypes.client import CreateObject
class RegDm:
@classmethod
def reg(cls):
path = os.path.dirname(__file__)
reg_dm = ctypes.windll.LoadLibrary(path + r'\DmReg.dll')
reg_dm.SetDllPathW(path + r'\dm.dll', 0)
return CreateObject(r'dm.dmsoft')
@classmethod
def create_dm(cls):
return CreateObject(r'dm.dmsoft')
class LDCmd:
def __init__(self, path: str):
os.putenv('Path', path)
@staticmethod
def read_message(cmd):
res = Popen(cmd, stdout=PIPE, shell=True)
res = res.stdout.read().decode(encoding='GBK')
return res
def lunch(self, order: str):
self.read_message('ldconsole.exe launch --index ' + order)
def quit(self, order: str):
self.read_message(cmd='ldconsole.exe quit --index ' + order)
def get_message(self):
return self.read_message('ldconsole.exe list2')
# 索引，标题，顶层窗口句柄，绑定窗口句柄，是否进入android，进程PID，VBox进程PID
def add(self, name: str):
self.read_message('ldconsole.exe add --name ' + name)
def remove(self, order: str):
self.read_message('ldconsole.exe remove --index ' + order)
def copy(self, name: str, order: str):
self.read_message('ldconsole.exe copy --name ' + name + ' --from ' + order)
def start_app(self, order: str, packagename: str):
self.read_message('ldconsole.exe runapp --index ' + order + ' --packagename ' + packagename)
def close_app(self, order: str, packagename: str):
self.read_message('ldconsole.exe killapp --index ' + order + ' --packagename ' + packagename)
def get_list_package(self, order: str):
return self.read_message(cmd='ld.exe -s ' + order + ' pm list packages')
def install_app(self, order: str, path: str):
self.read_message('ldconsole.exe installapp --index ' + order + ' --filename ' + path)
def sort_wnd(self):
self.read_message('ldconsole.exe sortWnd')
def reboot(self, order: str):
self.read_message('ldconsole.exe reboot --index ' + order)
def get_appoint_message(self, order: str,index:int):
my_list = self.get_message()
items = my_list.splitlines()
return items[int(order)].split(',')[index]
class Memory:
def __init__(self, dx, hwd):
self.__dx = dx
self.hwd = hwd
def get_call_address(self, s, model, off):
# 返回16进制字符串地址
module_size = self.__dx.GetModuleSize(self.hwd, model)
base_address = self.__dx.GetModuleBaseAddr(self.hwd, model)
end_address = module_size + base_address
call_address = self.__dx.FindData(self.hwd, hex(base_address)[2:] + '-' + hex(end_address)[2:], s)
return hex(int(call_address, 16) + int(off, 16))[2:]
def x64_get_base_address(self, s, model, off):
address = self.get_call_address(s, model, off)
address_2 = self.__dx.readint(self.hwd, address, 4)
return hex(int(address, 16) + address_2 + 4)[2:]
def x32_get_base_address(self, s, model, off):
address = self.get_call_address(s, model, off)
address = self.__dx.readint(self.hwd, address, 4)
return hex(address)[2:]
class Auto_Dm:
def __init__(self,my_dx):
self.dx=my_dx
self.ret = None
self.tup=None
def reg(self,code,md)->int:
return self.dx.reg(code,md)
def BindWindowEx(self,hwnd,display,mouse,keypad,public,mode)->int:
return self.dx.BindWindowEx(hwnd,display,mouse,keypad,public,mode)
def EnumWindowByProcess(self,process_name,title,class_name,filter)->str:
return self.dx.EnumWindowByProcess(process_name,title,class_name,filter)
def set_path(self, s)->int:
return self.dx.setpath(s)
def FindPic(self,pic_name,t=100,x1=0, y1=0, x2=960, y2=540):
t1 = time.time()
while time.time() - t1 < t:
self.ret = self.dx.FindPic(x1, y1, x2, y2, pic_name, '050505', 0.9, 0)
if self.ret[2] != -1:
print(f'find {pic_name}')
return self
def click_point(self,x,y,t=1):
self.dx.MoveTo(x,y)
for i in range(0, t):
self.dx.LeftClick()
time.sleep(0.1)
return self
def click(self,t=1):
self.dx.MoveTo(self.ret[0],self.ret[1])
for i in range(0, t):
self.dx.LeftClick()
time.sleep(0.1)
return self
def sleep(self, t):
time.sleep(t)
return self
if __name__ == '__main__':
dm=RegDm.reg()
auto_dm = Auto_Dm(dm)
|
1Q847
|
/1Q847-1.1.8.tar.gz/1Q847-1.1.8/Dll/Reg.py
|
Reg.py
|
print('1q847模块当前版本:1.17', 'qq交流群：763500501')
|
1Q847
|
/1Q847-1.1.8.tar.gz/1Q847-1.1.8/Dll/__init__.py
|
__init__.py
|
__version__ = "1.0.0"
|
1a23-telemetry
|
/1a23_telemetry-1.0.0-py3-none-any.whl/telemetry_1a23/__version__.py
|
__version__.py
|
import logging
import uuid
import requests
import collections
import json
import time
from pathlib import Path
from typing import Dict, Any, Optional, Callable
import sentry_sdk
from sentry_sdk.integrations.logging import LoggingIntegration, ignore_logger
import logzio.handler
from logdna import LogDNAHandler
# sentry_sdk.init("https://[email protected]/1382546")
BASE_URL = "https://labs.1a23.com/telemetry_config/"
device_id: Optional[str] = None
instances: Dict[str, Any] = {}
class JSONEncoder(json.JSONEncoder):
def default(self, o):
return repr(o)
class TelemetryProvider:
def set_metadata(data: Dict[str, any]):
pass
class SentryErrorReporting(TelemetryProvider):
def __init__(self, options: Dict[str, Any]):
del options['provider']
if 'enable' in options:
del options['enable']
if 'available' in options:
del options['available']
token = options.pop('token')
integrations = []
if not options.get('capture_logs'):
integrations.append(LoggingIntegration(level=logging.ERROR))
if 'capture_logs' in options:
del options['capture_logs']
if 'ignored_loggers' in options:
for logger in options['ignored_loggers']:
ignore_logger(logger)
del options['ignored_loggers']
sentry_sdk.init(dsn=token, integrations=integrations,
**options)
with sentry_sdk.configure_scope() as scope:
scope.user = {'id': get_device_id()}
def set_metadata(self, data: Dict[str, any]):
with sentry_sdk.configure_scope() as scope:
for key, value in data.items():
scope.set_tag(key, str(value))
class LogzLogAnalysis(TelemetryProvider):
def __init__(self, options: Dict[str, Any], instance: str):
token = options['token']
server = options['server']
self.hdlr: logzio.handler.LogzioHandler = \
logzio.handler.LogzioHandler(
token, logzio_type=instance, url=server
)
# self.hdlr.format_message = \
# self.wrap_format_message(self.hdlr.format_message)
logging.getLogger('').addHandler(self.hdlr)
self.metadata = {'device_id': get_device_id()}
self.hdlr.setFormatter(logging.Formatter(json.dumps(self.metadata)))
def set_metadata(self, data: Dict[str, any]):
self.metadata.update(data)
self.hdlr.setFormatter(logging.Formatter(json.dumps(self.metadata)))
def wrap_format_message(self, fn: Callable):
def format_message(message: logging.LogRecord):
d = fn(message)
args = self.json_obj_escape(message.args)
if not isinstance(args, list):
args = [args]
for idx, i in enumerate(args):
i_type = type(i).__name__
d['arg_%s_%s' % (idx, i_type)] = i
if not isinstance(message.msg, str):
obj = self.json_obj_escape(message.msg)
obj_type = type(obj).__name__
d['msg_' + obj_type] = obj
return d
return format_message
def json_obj_escape(self, obj):
if isinstance(obj, tuple):
obj = list(obj)
if isinstance(obj, (str, bool, float, int, type(None))):
return obj
elif isinstance(obj, list):
return list(map(self.json_obj_escape, obj))
elif isinstance(obj, dict):
return {self.json_obj_escape(k): self.json_obj_escape(v) for k, v in obj.items()}
else:
return repr(obj)
class LogglyLogAnalysis(LogzLogAnalysis):
def __init__(self, options: Dict[str, Any], instance: str):
token = "token"
server = options['url'] + instance + "/"
self.hdlr: logzio.handler.LogzioHandler = \
logzio.handler.LogzioHandler(
token, logzio_type=instance, url=server
)
self.hdlr.format_message = \
self.wrap_format_message(self.hdlr.format_message)
self.patch_get_message(self.hdlr.logzio_sender)
self.hdlr.logzio_sender.url = server
logging.getLogger('').addHandler(self.hdlr)
self.metadata = {'device_id': get_device_id()}
self.hdlr.setFormatter(logging.Formatter(json.dumps(self.metadata)))
@staticmethod
def patch_get_message(sender: logzio.sender.LogzioSender):
def patched_get_msg():
if not sender.queue.empty():
return [sender.queue.get()]
return []
sender._get_messages_up_to_max_allowed_size = patched_get_msg
def sanitize_key(self, key: str):
return key.replace(' ', '_').replace('.', '_')
def set_metadata(self, data: Dict[str, any]):
data = {self.sanitize_key(key): value for key, value in data.items()}
self.metadata.update(data)
self.hdlr.setFormatter(logging.Formatter(json.dumps(self.metadata)))
class LogDNALogAnalysis(TelemetryProvider):
def __init__(self, options: Dict[str, Any], instance: str):
key = options['token']
options = {"app": instance, "hostname": get_device_id(),
"include_standard_meta": True}
self.hdlr = LogDNAHandler(key, options)
self.meta = {}
self.patch_emit(self.hdlr)
logging.getLogger('').addHandler(self.hdlr)
def set_metadata(self, data: Dict[str, any]):
self.meta.update(data)
def patch_emit(provider, self):
def emit(record):
msg = self.format(record)
record = record.__dict__
opts = {}
if 'args' in record:
opts = record['args']
if self.include_standard_meta:
if isinstance(opts, tuple):
opts = {}
if 'meta' not in opts:
opts['meta'] = {}
for key in ['name', 'pathname', 'lineno']:
opts['meta'][key] = record[key]
opts['meta'].update(provider.meta)
if isinstance(record['args'], tuple):
opts['meta'].update(
{("arg_%s" % idx): i for idx,
i in enumerate(record['args'])}
)
message = {
'hostname': self.hostname,
'timestamp': int(time.time() * 1000),
'line': msg,
'level': record['levelname'] or self.level,
'app': self.app or record['module'],
'env': self.env
}
if not isinstance(opts, tuple):
if 'level' in opts:
message['level'] = opts['level']
if 'app' in opts:
message['app'] = opts['app']
if 'hostname' in opts:
message['hostname'] = opts['hostname']
if 'env' in opts:
message['env'] = opts['env']
if 'timestamp' in opts:
message['timestamp'] = opts['timestamp']
if 'meta' in opts:
if self.index_meta:
message['meta'] = self.sanitizeMeta(opts['meta'])
else:
message['meta'] = json.dumps(
opts['meta'], cls=JSONEncoder)
self.bufferLog(message)
self.emit = emit
def init(instance: str, patch: Dict[str, Any]={}):
resp = requests.get(BASE_URL + instance + ".json")
if resp.status_code != 200:
resp.raise_for_status()
config: Dict[str, Any] = resp.json()
config = update(config, patch)
if not isinstance(config, dict):
raise ValueError()
for key, val in config.items():
if not val.get('enable', False) or not val.get('available', False):
continue
instances[key] = setup_instance(val, instance)
def update(d, u):
for k, v in u.items():
if isinstance(v, collections.Mapping):
d[k] = update(d.get(k, {}), v)
else:
d[k] = v
return d
def setup_instance(config: Dict[str, Any], instance: str) -> TelemetryProvider:
provider = config.get('provider', None)
if provider == 'sentry':
return SentryErrorReporting(config)
elif provider == 'logz':
return LogzLogAnalysis(config, instance)
elif provider == 'loggly':
return LogglyLogAnalysis(config, instance)
elif provider == 'logdna':
return LogDNALogAnalysis(config, instance)
else:
return TelemetryProvider()
def get_device_id() -> str:
global device_id
# if no machine ID file saved, generate one, and save it
# otherwise, get the ID from the file.
if device_id:
return device_id
path: Path = Path.home() / '.1a23_telemetry_device_id'
if path.exists():
device_id = path.read_text()
return device_id
device_id = str(uuid.uuid4())
path.write_text(device_id)
return device_id
def set_metadata(data: Dict[str, any]):
for i in instances.values():
i.set_metadata(data)
|
1a23-telemetry
|
/1a23_telemetry-1.0.0-py3-none-any.whl/telemetry_1a23/__init__.py
|
__init__.py
|
Copyright 2019 Eana Hufwe
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
|
1a23-telemetry
|
/1a23_telemetry-1.0.0-py3-none-any.whl/1a23_telemetry-1.0.0.dist-info/LICENSE.rst
|
LICENSE.rst
|
import os
from distutils.core import setup
setup(
name = "1and1",
packages = ['oneandone'],
version = "1.8.0",
author = "Tyler Burkhardt (stackpoint.io)",
author_email = "[email protected]",
description = ("1&1 API Client Library for Python"),
license = "Apache 2.0",
keywords = "oneandone 1&1 1and1 api client cloud server",
url = "https://github.com/1and1/oneandone-cloudserver-sdk-python",
download_url = "https://github.com/1and1/oneandone-cloudserver-sdk-python/tarball/1.6.0",
install_requires = ['requests>=2.0.0'],
classifiers = [
'Development Status :: 5 - Production/Stable',
'Natural Language :: English',
'Environment :: Web Environment',
'Intended Audience :: Developers',
'License :: OSI Approved :: Apache Software License',
'Operating System :: POSIX',
'Programming Language :: Python',
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 3',
'Topic :: Software Development :: Libraries :: Python Modules',
'Topic :: Software Development :: Libraries :: Application Frameworks',
'Topic :: Internet :: WWW/HTTP'
]
)
|
1and1
|
/1and1-1.8.0.tar.gz/1and1-1.8.0/setup.py
|
setup.py
|
import time
import logging
import httplib as http_client
import requests
from requests.adapters import HTTPAdapter
from requests.packages.urllib3.poolmanager import PoolManager
from requests.packages.urllib3.util.retry import Retry
import ssl
import base64
try:
from cStringIO import StringIO
except BaseException:
from StringIO import StringIO
import zipfile
class MyAdapter(HTTPAdapter):
def init_poolmanager(self, connections, maxsize, block=False):
self.poolmanager = PoolManager(num_pools=connections,
maxsize=maxsize,
block=block,
ssl_version=getattr(ssl, 'PROTOCOL_TLSv1_2', ssl.PROTOCOL_TLSv1))
# Retry logic if the API fails to responde
def requests_retry_session(
retries=5,
backoff_factor=0.5,
status_forcelist=(500, 502, 504, 495, 496, 525, 526),
session=None,
):
session = session or requests.Session()
retry = Retry(
total=retries,
read=retries,
connect=retries,
backoff_factor=backoff_factor,
status_forcelist=status_forcelist,
)
adapter = MyAdapter(max_retries=retry)
session.mount('http://', adapter)
session.mount('https://', adapter)
return session
# 1and1 Object Classes
class OneAndOneService(object):
# Init Function
def __init__(
self,
api_token,
api_url='https://cloudpanel-api.1and1.com/v1',
enable_logs=False):
if api_url == '' or api_url == 'default':
api_url = 'https://cloudpanel-api.1and1.com/v1'
self.api_token = api_token
self.base_url = api_url
self.header = {'X-TOKEN': self.api_token}
self.success_codes = (200, 201, 202)
if enable_logs:
http_client.HTTPConnection.debuglevel = 1
logging.basicConfig()
logging.getLogger().setLevel(logging.DEBUG)
requests_log = logging.getLogger("requests.packages.urllib3")
requests_log.setLevel(logging.ERROR)
requests_log.propagate = True
def __repr__(self):
return 'OneAndOneService: api_token=%s, base_url=%s' % (self.api_token,
self.base_url)
# Server Functions
# 'GET' methods
def list_servers(self, page=None, per_page=None, sort=None, q=None,
fields=None):
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields
}
url = '%s/servers' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def fixed_server_flavors(self):
# Perform Request
url = '%s/servers/fixed_instance_sizes' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_fixed_server(self, fixed_server_id=None):
# Error Handling
if(fixed_server_id is None):
raise ValueError('fixed_server_id is a required parameter')
# Perform Request
url = ('%s/servers/fixed_instance_sizes/%s' %
(self.base_url, fixed_server_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_server(self, server_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
# Perform Request
url = '%s/servers/%s' % (self.base_url, server_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_server_hardware(self, server_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
# Perform Request
url = '%s/servers/%s/hardware' % (self.base_url, server_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def list_server_hdds(self, server_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
# Perform Request
url = '%s/servers/%s/hardware/hdds' % (self.base_url, server_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_server_hdd(self, server_id=None, hdd_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(hdd_id is None):
raise ValueError('hdd_id is a required parameter')
# Perform Request
url = ('%s/servers/%s/hardware/hdds/%s' %
(self.base_url, server_id, hdd_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_server_image(self, server_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
# Perform Request
url = '%s/servers/%s/image' % (self.base_url, server_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def list_server_ips(self, server_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
# Perform Request
url = '%s/servers/%s/ips' % (self.base_url, server_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_server_ip(self, server_id=None, ip_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(ip_id is None):
raise ValueError('ip_id is a required parameter')
# Perform Request
url = '%s/servers/%s/ips/%s' % (self.base_url, server_id, ip_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def list_ip_firewall_policy(self, server_id=None, ip_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(ip_id is None):
raise ValueError('ip_id is a required parameter')
# Perform Request
url = ('%s/servers/%s/ips/%s/firewall_policy' %
(self.base_url, server_id, ip_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def list_ip_load_balancers(self, server_id=None, ip_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(ip_id is None):
raise ValueError('ip_id is a required parameter')
# Perform Request
url = ('%s/servers/%s/ips/%s/load_balancers' %
(self.base_url, server_id, ip_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_server_status(self, server_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
# Perform Request
url = '%s/servers/%s/status' % (self.base_url, server_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_server_dvd(self, server_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
# Perform Request
url = '%s/servers/%s/dvd' % (self.base_url, server_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def list_server_private_networks(self, server_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
# Perform Request
url = '%s/servers/%s/private_networks' % (self.base_url, server_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def private_network_info(self, server_id=None, private_network_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(private_network_id is None):
raise ValueError('private_network_id is a required parameter')
# Perform Request
url = ('%s/servers/%s/private_networks/%s' %
(self.base_url, server_id, private_network_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def list_server_snapshots(self, server_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
# Perform Request
url = '%s/servers/%s/snapshots' % (self.base_url, server_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def list_baremetal_models(
self,
page=None,
per_page=None,
sort=None,
q=None,
fields=None):
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields
}
url = '%s/servers/baremetal_models' % self.base_url
r = requests.get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def get_baremetal_model(self, model_id=None):
# Error Handling
if (model_id is None):
raise ValueError('model_id is a required parameter')
# Perform Request
url = '%s/servers/baremetal_models/%s' % (self.base_url, model_id)
r = requests.get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
# 'PUT' methods
def modify_server(self, server_id=None, name=None, description=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(name is None):
raise ValueError('name is a required parameter')
# Perform Request
data = {
'name': name,
'description': description
}
url = '%s/servers/%s' % (self.base_url, server_id)
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def modify_server_hardware(
self,
server_id=None,
fixed_instance_size_id=None,
vcore=None,
cores_per_processor=None,
ram=None,
test=False):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
# Use 'test' flag to skip this block when running unit test
if(test == False):
# Prevent hot decreasing of server hardware, allow cold decreasing.
server_specs = self.get_server_hardware(server_id=server_id)
server_status = self.get_server_status(server_id=server_id)
if(server_status['state'] == 'POWERED_ON'):
if(vcore is not None):
if(server_specs['vcore'] > vcore):
raise ValueError(('Cannot perform a hot decrease of '
'server CPU. The new value must be '
'greater than current value.'))
if(ram is not None):
if(server_specs['ram'] > ram):
raise ValueError(('Cannot perform a hot decrease of '
'server RAM. The new value must be '
'greater than current value.'))
# Perform Request
data = {
'fixed_instance_size_id': fixed_instance_size_id,
'vcore': vcore,
'cores_per_processor': cores_per_processor,
'ram': ram
}
url = '%s/servers/%s/hardware' % (self.base_url, server_id)
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def modify_hdd(self, server_id=None, hdd_id=None, size=None, test=False):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(hdd_id is None):
raise ValueError('hdd_id is a required parameter')
# Use 'test' flag to skip this block when running unit test
if(test == False):
# Make sure size argument is valid. HDD size can't be decreased.
old_hdd = self.get_server_hdd(server_id=server_id, hdd_id=hdd_id)
if(size is not None):
if(old_hdd['size'] > size):
raise ValueError('HDD size can never be decreased. '
'Must be greater than or equal to the '
'current HDD size.')
# Perform Request
data = {'size': size}
url = ('%s/servers/%s/hardware/hdds/%s' %
(self.base_url, server_id, hdd_id))
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def add_firewall_policy(
self,
server_id=None,
ip_id=None,
firewall_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(ip_id is None):
raise ValueError('ip_id is a required parameter')
if(firewall_id is None):
raise ValueError('firewall_id is a required parameter')
# Perform Request
data = {'id': firewall_id}
url = ('%s/servers/%s/ips/%s/firewall_policy' %
(self.base_url, server_id, ip_id))
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def modify_server_status(
self,
server_id=None,
action=None,
method='SOFTWARE',
recovery_mode=False,
recovery_image_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(action is None):
raise ValueError('action is a required parameter')
# Make sure user is passing in correct arguments
if(action != 'POWER_ON' and action != 'POWER_OFF' and
action != 'REBOOT'):
raise ValueError(('action must be set to "POWER_ON",'
'"POWER_OFF", or "REBOOT".'))
if method != 'HARDWARE' and method != 'SOFTWARE':
raise ValueError(('method must be set to either '
'"HARDWARE" or "SOFTWARE".'))
if recovery_mode and recovery_image_id is None:
raise ValueError(
('If you want to reboot in recovery mode you must specify an image id recovery_image_id'))
# Perform Request
if recovery_mode:
data = {
'action': action,
'method': method,
'recovery_mode': True,
'recovery_image_id': recovery_image_id
}
else:
data = {
'action': action,
'method': method,
}
url = '%s/servers/%s/status/action' % (self.base_url, server_id)
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def stop_server(self, server_id=None, method='SOFTWARE'):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
# Make sure user is passing in correct arguments
if(method != 'HARDWARE' and method != 'SOFTWARE'):
raise ValueError(('method must be set to either '
'"HARDWARE" or "SOFTWARE".'))
# Perform Request
data = {
'action': 'POWER_OFF',
'method': method
}
url = '%s/servers/%s/status/action' % (self.base_url, server_id)
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def start_server(self, server_id=None, method='SOFTWARE'):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
# Make sure user is passing in correct arguments
if(method != 'HARDWARE' and method != 'SOFTWARE'):
raise ValueError(('method must be set to either '
'"HARDWARE" or "SOFTWARE".'))
# Perform Request
data = {
'action': 'POWER_ON',
'method': method
}
url = '%s/servers/%s/status/action' % (self.base_url, server_id)
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def load_dvd(self, server_id=None, dvd_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(dvd_id is None):
raise ValueError('dvd_id is a required parameter')
# Perform Request
data = {'id': dvd_id}
url = '%s/servers/%s/dvd' % (self.base_url, server_id)
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def restore_snapshot(self, server_id=None, snapshot_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(snapshot_id is None):
raise ValueError('snapshot_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = ('%s/servers/%s/snapshots/%s' %
(self.base_url, server_id, snapshot_id))
try:
r = requests_retry_session().put(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def reinstall_image(self, server_id=None, image_id=None, password=None,
firewall_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(image_id is None):
raise ValueError('image_id is a required parameter')
# Create firewall object, if necessary
firewall_policy = {'id': firewall_id}
# Perform Request
data = {
'id': image_id,
'password': password,
'firewall_policy': firewall_policy
}
url = '%s/servers/%s/image' % (self.base_url, server_id)
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'DELETE' methods
def delete_server(self, server_id=None, keep_ips=None, keep_hdds=True):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
parameters = {'keep_ips': keep_ips, 'keep_hdds': keep_hdds}
url = '%s/servers/%s' % (self.base_url, server_id)
try:
r = requests_retry_session().delete(
url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def remove_hdd(self, server_id=None, hdd_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(hdd_id is None):
raise ValueError('hdd_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = ('%s/servers/%s/hardware/hdds/%s' %
(self.base_url, server_id, hdd_id))
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def remove_ip(self, server_id=None, ip_id=None, keep_ip=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(ip_id is None):
raise ValueError('ip_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
parameters = {'keep_ip': keep_ip}
url = '%s/servers/%s/ips/%s' % (self.base_url, server_id, ip_id)
try:
r = requests_retry_session().delete(
url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def remove_load_balancer(self, server_id=None, ip_id=None,
load_balancer_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(ip_id is None):
raise ValueError('ip_id is a required parameter')
if(load_balancer_id is None):
raise ValueError('load_balancer_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = ('%s/servers/%s/ips/%s/load_balancers/%s' %
(self.base_url, server_id, ip_id, load_balancer_id))
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def remove_private_network(self, server_id=None, private_network_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(private_network_id is None):
raise ValueError('private_network_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = ('%s/servers/%s/private_networks/%s' %
(self.base_url, server_id, private_network_id))
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def eject_dvd(self, server_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = '%s/servers/%s/dvd' % (self.base_url, server_id)
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def delete_snapshot(self, server_id=None, snapshot_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(snapshot_id is None):
raise ValueError('snapshot_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = ('%s/servers/%s/snapshots/%s' %
(self.base_url, server_id, snapshot_id))
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'POST' methods
def add_new_ip(self, server_id=None, ip_type=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(ip_type is not None) and (ip_type != 'IPV4'):
raise ValueError(("ip_type. Only type 'IPV4' is currently "
"supported."))
# Perform Request
data = {'type': ip_type}
url = '%s/servers/%s/ips' % (self.base_url, server_id)
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def add_load_balancer(self, server_id=None, ip_id=None,
load_balancer_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(ip_id is None):
raise ValueError('ip_id is a required parameter')
if(load_balancer_id is None):
raise ValueError('load_balancer_id is a required parameter')
# Perform Request
data = {'load_balancer_id': load_balancer_id}
url = ('%s/servers/%s/ips/%s/load_balancers' %
(self.base_url, server_id, ip_id))
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def assign_private_network(self, server_id=None, private_network_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(private_network_id is None):
raise ValueError('private_network_id is a required parameter')
# Perform Request
data = {'id': private_network_id}
url = '%s/servers/%s/private_networks' % (self.base_url, server_id)
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def create_snapshot(self, server_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = '%s/servers/%s/snapshots' % (self.base_url, server_id)
try:
r = requests_retry_session().post(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def clone_server(self, server_id=None, name=None, datacenter_id=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(name is None):
raise ValueError('name is a required parameter')
# Perform Request
data = {
'name': name,
'datacenter_id': datacenter_id
}
url = '%s/servers/%s/clone' % (self.base_url, server_id)
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def create_server(self, server=None, hdds=None):
# Error Handling
if(server is None):
raise ValueError(('server is a required parameter. Make '
'sure you pass a Server object.'))
# Unpack hdds
if hdds:
hdd = []
for value in hdds:
hdd.append(value.specs)
# Add hdds to server object
server.specs['hardware']['hdds'] = hdd
# Clean dictionary
keys = [k for k, v in server.specs['hardware'].items() if
v is None]
for x in keys:
del server.specs['hardware'][x]
# Build URL and perform request
url = '%s/servers' % self.base_url
try:
r = requests_retry_session().post(url, headers=self.header, json=server.specs)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
# Assign new server_id back to calling Server object
response = r.json()
server.specs.update(server_id=response['id'])
server.specs.update(api_token=self.header)
server.first_password = response['first_password']
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def add_hdd(self, server_id=None, hdds=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(hdds is None):
raise ValueError(('hdds is a required parameter. Make '
'sure you pass a list with at least '
'one Hdd object.'))
# Unpack hdds
hdd = []
for value in hdds:
hdd.append(value.specs)
# Perform Request
data = {'hdds': hdd}
url = '%s/servers/%s/hardware/hdds' % (self.base_url, server_id)
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# Image Functions
# 'GET' Methods
def list_images(self, page=None, per_page=None, sort=None, q=None,
fields=None):
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields
}
url = '%s/images' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_image(self, image_id=None):
# Error Handling
if(image_id is None):
raise ValueError('image_id is a required parameter')
# Perform Request
url = '%s/images/%s' % (self.base_url, image_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'POST' Methods
def create_image(self, image=None):
# Error Handling
if(image.server_id is None):
raise ValueError('server_id is a required parameter')
if(image.name is None):
raise ValueError('name is a required parameter')
if(image.frequency is None):
raise ValueError('frequency is a required parameter')
if(image.num_images is None):
raise ValueError('num_images is a required parameter')
# Perform Request
data = {
'server_id': image.server_id,
'name': image.name,
'frequency': image.frequency,
'num_images': image.num_images,
'description': image.description,
'source': image.source,
'url': image.url,
'os_id': image.os_id,
'type': image.type
}
url = '%s/images' % self.base_url
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
# Assign new image_id back to calling Image object
response = r.json()
image.specs.update(image_id=response['id'])
image.specs.update(api_token=self.header)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'DELETE' Methods
def delete_image(self, image_id=None):
# Error Handling
if(image_id is None):
raise ValueError('image_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = '%s/images/%s' % (self.base_url, image_id)
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'PUT' Methods
def modify_image(self, image_id=None, name=None, description=None,
frequency=None):
# Error Handling
if(image_id is None):
raise ValueError('image_id is a required parameter')
# Perform Request
data = {
'name': name,
'frequency': frequency,
'description': description
}
url = '%s/images/%s' % (self.base_url, image_id)
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# Shared Storage Functions
# 'GET' Methods
def list_shared_storages(self, page=None, per_page=None, sort=None,
q=None, fields=None):
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields
}
url = '%s/shared_storages' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_shared_storage(self, shared_storage_id=None):
# Error Handling
if(shared_storage_id is None):
raise ValueError('shared_storage_id is a required parameter')
# Perform Request
url = '%s/shared_storages/%s' % (self.base_url, shared_storage_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def list_servers_attached_storage(self, shared_storage_id=None):
# Error Handling
if(shared_storage_id is None):
raise ValueError('shared_storage_id is a required parameter')
# Perform Request
url = ('%s/shared_storages/%s/servers' %
(self.base_url, shared_storage_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_shared_storage_server(
self,
shared_storage_id=None,
server_id=None):
# Error Handling
if(shared_storage_id is None):
raise ValueError('shared_storage_id parameter is required')
if(server_id is None):
raise ValueError('server_id parameter is required')
# Perform Request
url = ('%s/shared_storages/%s/servers/%s' %
(self.base_url, shared_storage_id, server_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_credentials(self):
# Perform Request
url = '%s/shared_storages/access' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'POST' Methods
def create_shared_storage(self, shared_storage=None):
# Error Handling
if(shared_storage.name is None):
raise ValueError('name is a required parameter')
if(shared_storage.size is None):
raise ValueError('size is a required parameter')
# Perform Request
data = {
'name': shared_storage.name,
'description': shared_storage.description,
'size': shared_storage.size,
'datacenter_id': shared_storage.datacenter_id
}
url = '%s/shared_storages' % self.base_url
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
# Assign new shared_storage_id back to calling SharedStorage object
response = r.json()
shared_storage.specs.update(shared_storage_id=response['id'])
shared_storage.specs.update(api_token=self.header)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def attach_server_shared_storage(self, shared_storage_id=None,
server_ids=None):
# Error Handling
if(shared_storage_id is None):
raise ValueError('shared_storage_id is a required parameter')
if(server_ids is None):
raise ValueError(('server_ids is a required parameter. '
'Must attach at least one server'))
# Unpack servers
servers = []
for value in server_ids:
servers.append({'id': value.server_id, 'rights': value.rights})
# Perform Request
data = {'servers': servers}
url = ('%s/shared_storages/%s/servers' %
(self.base_url, shared_storage_id))
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'PUT' Methods
def modify_shared_storage(self, shared_storage_id=None, name=None,
description=None, size=None):
# Error Handling
if(shared_storage_id is None):
raise ValueError('shared_storage_id is a required parameter')
# Perform Request
data = {
'name': name,
'description': description,
'size': size
}
url = '%s/shared_storages/%s' % (self.base_url, shared_storage_id)
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def change_password(self, password=None):
# Error Handlong
if(password is None):
raise ValueError(('password is a required parameter. '
'password must contain at least 8 characters.'))
# Perform Request
data = {'password': password}
url = '%s/shared_storages/access' % self.base_url
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'DELETE' Methods
def delete_shared_storage(self, shared_storage_id=None):
# Error Handling
if(shared_storage_id is None):
raise ValueError('shared_storage_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = '%s/shared_storages/%s' % (self.base_url, shared_storage_id)
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def detach_server_shared_storage(self, shared_storage_id=None,
server_id=None):
# Error Handling
if(shared_storage_id is None):
raise ValueError('shared_storage_id is a required parameter')
if(server_id is None):
raise ValueError('server_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = ('%s/shared_storages/%s/servers/%s' %
(self.base_url, shared_storage_id, server_id))
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# Firewall Policy Functions
# 'GET' Methods
def list_firewall_policies(self, page=None, per_page=None, sort=None,
q=None, fields=None):
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields
}
url = '%s/firewall_policies' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_firewall(self, firewall_id=None):
# Error Handling
if(firewall_id is None):
raise ValueError('firewall_id is a required parameter')
# Perform Request
url = '%s/firewall_policies/%s' % (self.base_url, firewall_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def list_firewall_servers(self, firewall_id=None):
# Error Handling
if(firewall_id is None):
raise ValueError('firewall_id is a required parameter')
# Perform Request
url = ('%s/firewall_policies/%s/server_ips' %
(self.base_url, firewall_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_firewall_server(self, firewall_id=None, server_ip_id=None):
# Error Handling
if(firewall_id is None):
raise ValueError('firewall_id is a required parameter')
if(server_ip_id is None):
raise ValueError('server_ip_id is a required parameter')
# Perform Request
url = ('%s/firewall_policies/%s/server_ips/%s' %
(self.base_url, firewall_id, server_ip_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def list_firewall_policy_rules(self, firewall_id=None):
# Error Handling
if(firewall_id is None):
raise ValueError('firewall_id is a required parameter')
# Perform Request
url = '%s/firewall_policies/%s/rules' % (self.base_url, firewall_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_firewall_policy_rule(self, firewall_id=None, rule_id=None):
# Error Handling
if(firewall_id is None):
raise ValueError('firewall_id is a required parameter')
if(rule_id is None):
raise ValueError('rule_id is a required parameter')
# Perform Request
url = ('%s/firewall_policies/%s/rules/%s' %
(self.base_url, firewall_id, rule_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'PUT' Methods
def modify_firewall(self, firewall_id=None, name=None, description=None):
# Error Handling
if(firewall_id is None):
raise ValueError('firewall_id is a required parameter')
# Perform Request
data = {
'name': name,
'description': description
}
url = '%s/firewall_policies/%s' % (self.base_url, firewall_id)
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'POST' Methods
def create_firewall_policy(self, firewall_policy=None,
firewall_policy_rules=None):
# Error Handling
if(firewall_policy.specs['name'] is None):
raise ValueError(('Policy name is required. Make sure your '
'FirewallPolicy object was initialized with '
'a name parameter'))
if(firewall_policy_rules is None):
raise ValueError(('firewall_policy_rules is required. Make sure '
'you pass a list with at least one '
'FirewallPolicyRule object.'))
# Unpack Rules
rules = []
for value in firewall_policy_rules:
rules.append(value.rule_set)
# Attach rules and Perform Request
firewall_policy.specs['rules'] = rules
url = '%s/firewall_policies' % self.base_url
try:
r = requests_retry_session().post(
url, headers=self.header, json=firewall_policy.specs)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
# Assign new firewall_id back to calling FirewallPolicy object
response = r.json()
firewall_policy.specs.update(firewall_id=response['id'])
firewall_policy.specs.update(api_token=self.header)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def add_firewall_policy_rule(self, firewall_id=None,
firewall_policy_rules=None):
# Error Handling
if(firewall_id is None):
raise ValueError('firewall_id is a required parameter')
if(firewall_policy_rules is None):
raise ValueError(('firewall_policy_rules is required. Make '
'sure you pass a list with at least one '
'FirewallPolicyRule object'))
# Unpack rules
rules = []
for value in firewall_policy_rules:
rules.append(value.rule_set)
# Perform Request
data = {'rules': rules}
url = '%s/firewall_policies/%s/rules' % (self.base_url, firewall_id)
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def attach_server_firewall_policy(self, firewall_id=None, server_ips=None):
# Error Handling
if(firewall_id is None):
raise ValueError('firewall_id is a required parameter')
if(server_ips is None):
raise ValueError(('server_ips is required. Make sure you pass '
'a list with at least one AttachServer object'))
# Unpack servers
servers = []
for value in server_ips:
servers.append(value.server_ip_id)
# Perform Request
data = {'server_ips': servers}
url = ('%s/firewall_policies/%s/server_ips' %
(self.base_url, firewall_id))
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'DELETE' Methods
def delete_firewall(self, firewall_id=None):
# Error Handling
if(firewall_id is None):
raise ValueError('firewall_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = '%s/firewall_policies/%s' % (self.base_url, firewall_id)
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def remove_firewall_rule(self, firewall_id=None, rule_id=None):
# Error Handling
if(firewall_id is None):
raise ValueError('firewall_id is a required parameter')
if(rule_id is None):
raise ValueError('rule_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = ('%s/firewall_policies/%s/rules/%s' %
(self.base_url, firewall_id, rule_id))
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# Load Balancer Functions
# 'GET' Methods
def list_load_balancers(self, page=None, per_page=None, sort=None, q=None,
fields=None):
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields
}
url = '%s/load_balancers' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_load_balancer(self, load_balancer_id=None):
# Error Handling
if(load_balancer_id is None):
raise ValueError('load_balancer_id is a required parameter')
# Perform Request
url = '%s/load_balancers/%s' % (self.base_url, load_balancer_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def list_load_balancer_servers(self, load_balancer_id=None):
# Error Handling
if(load_balancer_id is None):
raise ValueError('load_balancer_id is a required parameter')
# Perform Request
url = ('%s/load_balancers/%s/server_ips' %
(self.base_url, load_balancer_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_load_balancer_server(self, load_balancer_id=None,
server_ip_id=None):
# Error Handling
if(load_balancer_id is None):
raise ValueError('load_balancer_id is a required parameter')
if(server_ip_id is None):
raise ValueError('server_ip_id is a required parameter')
# Perform Request
url = ('%s/load_balancers/%s/server_ips/%s' %
(self.base_url, load_balancer_id, server_ip_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def load_balancer_rules(self, load_balancer_id=None):
# Error Handling
if(load_balancer_id is None):
raise ValueError('load_balancer_id is a required parameter')
# Perform Request
url = '%s/load_balancers/%s/rules' % (self.base_url, load_balancer_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_load_balancer_rule(self, load_balancer_id=None, rule_id=None):
# Error Handling
if(load_balancer_id is None):
raise ValueError('load_balancer_id is a required parameter')
if(rule_id is None):
raise ValueError('rule_id is a required parameter')
# Perform Request
url = ('%s/load_balancers/%s/rules/%s' %
(self.base_url, load_balancer_id, rule_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'PUT' Methods
def modify_load_balancer(
self,
load_balancer_id=None,
name=None,
description=None,
health_check_test=None,
health_check_interval=None,
health_check_path=None,
health_check_parse=None,
persistence=None,
persistence_time=None,
method=None):
# Error Handling
if(load_balancer_id is None):
raise ValueError('load_balancer_id is a required parameter')
if(method is not None and method != 'ROUND_ROBIN' and
method != 'LEAST_CONNECTIONS'):
raise ValueError(('method must be set to either "ROUND_ROBIN" '
'or "LEAST_CONNECTIONS".'))
if(health_check_test is not None and health_check_test != 'TCP'):
raise ValueError(('health_check_test must be set to "TCP". '
'"HTTP" is not currently supported.'))
if(health_check_interval is not None and health_check_interval < 5 and health_check_interval > 300):
raise ValueError(('health_check_interval must be an integer '
'between 5 and 300.'))
if(persistence_time is not None and persistence_time < 30 and persistence_time > 1200):
raise ValueError(('persistence_time must be an integer '
'between 30 and 1200.'))
# Perform Request
data = {
'name': name,
'description': description,
'health_check_test': health_check_test,
'health_check_interval': health_check_interval,
'health_check_path': health_check_path,
'health_check_parse': health_check_parse,
'persistence': persistence,
'persistence_time': persistence_time,
'method': method
}
url = '%s/load_balancers/%s' % (self.base_url, load_balancer_id)
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'POST' Methods
def create_load_balancer(self, load_balancer=None,
load_balancer_rules=None):
# Error Handling
if(load_balancer is None):
raise ValueError(('load_balancer parameter is required. Must '
'pass a LoadBalancer object.'))
if(load_balancer_rules is None):
raise ValueError(('load_balancer_rules parameter is required. '
'Must pass a list with at least one '
'LoadBalancerRule object.'))
if(load_balancer.specs['method'] is not None and
load_balancer.specs['method'] != 'ROUND_ROBIN' and
load_balancer.specs['method'] != 'LEAST_CONNECTIONS'):
raise ValueError(('method must be set to either "ROUND_ROBIN" '
'or "LEAST_CONNECTIONS".'))
# Unpack rules
rules = []
for value in load_balancer_rules:
rules.append(value.rule_set)
# Perform Request
load_balancer.specs['rules'] = rules
url = '%s/load_balancers' % self.base_url
try:
r = requests_retry_session().post(
url, headers=self.header, json=load_balancer.specs)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
# Assign new load_balancer_id back to calling LoadBalancer object
response = r.json()
load_balancer.specs.update(load_balancer_id=response['id'])
load_balancer.specs.update(api_token=self.header)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def attach_load_balancer_server(self, load_balancer_id=None,
server_ips=None):
# Error Handling
if(load_balancer_id is None):
raise ValueError('load_balancer_id is a required parameter.')
if(server_ips is None):
raise ValueError(('server_ips is a required parameter. Must '
'pass a list with at least one AttachServer '
'object'))
# Unpack servers
servers = []
for value in server_ips:
servers.append(value.server_ip_id)
# Perform Request
data = {'server_ips': servers}
url = ('%s/load_balancers/%s/server_ips' %
(self.base_url, load_balancer_id))
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def add_load_balancer_rule(self, load_balancer_id=None,
load_balancer_rules=None):
# Error Handling
if(load_balancer_id is None):
raise ValueError('load_balancer_id is a required parameter.')
if(load_balancer_rules is None):
raise ValueError(('load_balancer_rules is a required '
'parameter. Must pass a list with at least one '
'LoadBalancerRule object'))
# Unpack rules
rules = []
for value in load_balancer_rules:
rules.append(value.rule_set)
# Perform Request
data = {'rules': rules}
url = ('%s/load_balancers/%s/rules' %
(self.base_url, load_balancer_id))
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'DELETE' Methods
def delete_load_balancer(self, load_balancer_id=None):
# Error Handling
if(load_balancer_id is None):
raise ValueError('load_balancer_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = '%s/load_balancers/%s' % (self.base_url, load_balancer_id)
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def remove_load_balancer_server(self, load_balancer_id=None,
server_ip_id=None):
# Error Handling
if(load_balancer_id is None):
raise ValueError('load_balancer_id is a required parameter.')
if(server_ip_id is None):
raise ValueError('server_ip_id is a required parameter.')
# Perform Request
self.header['content-type'] = 'application/json'
url = ('%s/load_balancers/%s/server_ips/%s' %
(self.base_url, load_balancer_id, server_ip_id))
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def remove_load_balancer_rule(self, load_balancer_id=None, rule_id=None):
# Error Handling
if(load_balancer_id is None):
raise ValueError('load_balancer_id is a required parameter.')
if(rule_id is None):
raise ValueError('rule_id is a required parameter.')
# Perform Request
self.header['content-type'] = 'application/json'
url = ('%s/load_balancers/%s/rules/%s' %
(self.base_url, load_balancer_id, rule_id))
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# Public IP Functions
# 'GET' Methods
def list_public_ips(self, page=None, per_page=None, sort=None, q=None,
fields=None):
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields
}
url = '%s/public_ips' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_public_ip(self, ip_id=None):
# Error Handling
if(ip_id is None):
raise ValueError('ip_id is a required parameter')
# Perform Request
url = '%s/public_ips/%s' % (self.base_url, ip_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'POST' Methods
def create_public_ip(self, reverse_dns=None, ip_type=None,
datacenter_id=None):
# Error Handling
if(ip_type != 'IPV4' and ip_type is not None):
raise ValueError('ip_type must be set to "IPV4".')
# Perform Request
data = {
'reverse_dns': reverse_dns,
'type': ip_type,
'datacenter_id': datacenter_id
}
url = '%s/public_ips' % self.base_url
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'PUT' Methods
def modify_public_ip(self, ip_id=None, reverse_dns=None):
# Error Handling
if(ip_id is None):
raise ValueError('ip_id is a required parameter')
# Perform Request
data = {'reverse_dns': reverse_dns}
url = '%s/public_ips/%s' % (self.base_url, ip_id)
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'DELETE' Methods
def delete_public_ip(self, ip_id=None):
# Error Handling
if(ip_id is None):
raise ValueError('ip_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = '%s/public_ips/%s' % (self.base_url, ip_id)
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# Private Network Functions
# 'GET' Methods
def list_private_networks(self, page=None, per_page=None, sort=None,
q=None, fields=None):
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields
}
url = '%s/private_networks' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_private_network(self, private_network_id):
# Error Handling
if(private_network_id is None):
raise ValueError('private_network_id is a required parameter')
# Perform Request
url = '%s/private_networks/%s' % (self.base_url, private_network_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def list_private_network_servers(self, private_network_id=None):
# Error Handling
if(private_network_id is None):
raise ValueError('private_network_id is a required parameter')
# Perform Request
url = ('%s/private_networks/%s/servers' %
(self.base_url, private_network_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_private_network_server(self, private_network_id=None,
server_id=None):
# Error Handling
if(private_network_id is None):
raise ValueError('private_network_id is a required parameter')
if(server_id is None):
raise ValueError('server_id is a required parameter')
# Perform Request
url = ('%s/private_networks/%s/servers/%s' %
(self.base_url, private_network_id, server_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'POST' Methods
def create_private_network(self, private_network=None):
# Error Handling
if(private_network.name is None):
raise ValueError('name is a required parameter')
# Perform Request
data = {
'name': private_network.name,
'description': private_network.description,
'network_address': private_network.network_address,
'subnet_mask': private_network.subnet_mask,
'datacenter_id': private_network.datacenter_id
}
url = '%s/private_networks' % self.base_url
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
# Assign new private_network_id back to calling PrivateNetwork
# object
response = r.json()
private_network.specs.update(private_network_id=response['id'])
private_network.specs.update(api_token=self.header)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def attach_private_network_servers(self, private_network_id=None,
server_ids=None):
# Error Handling
if(private_network_id is None):
raise ValueError('private_network_id is a required parameter')
if(server_ids is None):
raise ValueError(('server_ids is a required parameter. Make '
'sure you pass a list with at least one '
'server_id string'))
# Unpack servers
servers = []
for value in server_ids:
servers.append(value.server_id)
# Perform Request
data = {'servers': servers}
url = ('%s/private_networks/%s/servers' %
(self.base_url, private_network_id))
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'PUT' Methods
def modify_private_network(
self,
private_network_id=None,
name=None,
description=None,
network_address=None,
subnet_mask=None):
# Perform Request
data = {
'name': name,
'description': description,
'network_address': network_address,
'subnet_mask': subnet_mask
}
url = '%s/private_networks/%s' % (self.base_url, private_network_id)
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'DELETE' Methods
def delete_private_network(self, private_network_id=None):
# Error Handling
if(private_network_id is None):
raise ValueError('private_network_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = '%s/private_networks/%s' % (self.base_url, private_network_id)
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def remove_private_network_server(self, private_network_id=None,
server_id=None):
# Error Handling
if(private_network_id is None):
raise ValueError('private_network_id is a required parameter')
if(server_id is None):
raise ValueError('server_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = ('%s/private_networks/%s/servers/%s' %
(self.base_url, private_network_id, server_id))
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# Monitoring Center Functions
# 'GET' Methods
def list_server_usages(self, page=None, per_page=None, sort=None,
q=None, fields=None):
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields
}
url = '%s/monitoring_center' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_usage(self, server_id=None, period='LAST_24H',
start_date=None, end_date=None):
# Error Handling
if(server_id is None):
raise ValueError('server_id is a required parameter')
if(period == 'CUSTOM'):
if(start_date is None):
raise ValueError(('start_date parameter is required when '
'using CUSTOM period'))
if(end_date is None):
raise ValueError(('end_date parameter is required when '
'using CUSTOM period'))
# Perform Request
parameters = {
'period': period,
'start_date': start_date,
'end_date': end_date
}
url = '%s/monitoring_center/%s' % (self.base_url, server_id)
try:
r = requests_retry_session().get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# Monitoring Policy Functions
# 'GET' Methods
def list_monitoring_policies(self, page=None, per_page=None,
sort=None, q=None, fields=None):
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields
}
url = '%s/monitoring_policies' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_monitoring_policy(self, monitoring_policy_id=None):
# Error Handling
if(monitoring_policy_id is None):
raise ValueError('monitoring_policy_id is a required parameter')
# Perform Request
url = ('%s/monitoring_policies/%s' %
(self.base_url, monitoring_policy_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def list_monitoring_policy_ports(self, monitoring_policy_id=None):
# Error Handling
if(monitoring_policy_id is None):
raise ValueError('monitoring_policy_id is a required parameter')
# Perform Request
url = ('%s/monitoring_policies/%s/ports' %
(self.base_url, monitoring_policy_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_monitoring_policy_port(self, monitoring_policy_id=None,
port_id=None):
# Error Handling
if(monitoring_policy_id is None):
raise ValueError('monitoring_policy_id is a required parameter')
if(port_id is None):
raise ValueError('port_id is a required parameter')
# Perform Request
url = ('%s/monitoring_policies/%s/ports/%s' %
(self.base_url, monitoring_policy_id, port_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def list_monitoring_policy_processes(self, monitoring_policy_id=None):
# Error Handling
if(monitoring_policy_id is None):
raise ValueError('monitoring_policy_id is a required parameter')
# Perform Request
url = ('%s/monitoring_policies/%s/processes' %
(self.base_url, monitoring_policy_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_monitoring_policy_process(self, monitoring_policy_id=None,
process_id=None):
# Error Handling
if(monitoring_policy_id is None):
raise ValueError('monitoring_policy_id is a required parameter')
if(process_id is None):
raise ValueError('process_id is a required parameter')
# Perform Request
url = ('%s/monitoring_policies/%s/processes/%s' %
(self.base_url, monitoring_policy_id, process_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def list_monitoring_policy_servers(self, monitoring_policy_id=None):
# Error Handling
if(monitoring_policy_id is None):
raise ValueError('monitoring_policy_id is a required parameter')
# Perform Request
url = ('%s/monitoring_policies/%s/servers' %
(self.base_url, monitoring_policy_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_monitoring_policy_server(self, monitoring_policy_id=None,
server_id=None):
# Error Handling
if(monitoring_policy_id is None):
raise ValueError('monitoring_policy_id is a required parameter')
if(server_id is None):
raise ValueError('server_id is a required parameter')
# Perform Request
url = ('%s/monitoring_policies/%s/servers/%s' %
(self.base_url, monitoring_policy_id, server_id))
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'DELETE' Methods
def delete_monitoring_policy(self, monitoring_policy_id=None):
# Error Handling
if(monitoring_policy_id is None):
raise ValueError('monitoring_policy_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = ('%s/monitoring_policies/%s' %
(self.base_url, monitoring_policy_id))
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def delete_monitoring_policy_port(self, monitoring_policy_id=None,
port_id=None):
# Error Handling
if(monitoring_policy_id is None):
raise ValueError('monitoring_policy_id is a required parameter')
if(port_id is None):
raise ValueError('port_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = ('%s/monitoring_policies/%s/ports/%s' %
(self.base_url, monitoring_policy_id, port_id))
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def delete_monitoring_policy_process(self, monitoring_policy_id=None,
process_id=None):
# Error Handling
if(monitoring_policy_id is None):
raise ValueError('monitoring_policy_id is a required parameter')
if(process_id is None):
raise ValueError('process_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = ('%s/monitoring_policies/%s/processes/%s' %
(self.base_url, monitoring_policy_id, process_id))
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def detach_monitoring_policy_server(self, monitoring_policy_id=None,
server_id=None):
# Error Handling
if(monitoring_policy_id is None):
raise ValueError('monitoring_policy_id is a required parameter')
if(server_id is None):
raise ValueError('server_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = ('%s/monitoring_policies/%s/servers/%s' %
(self.base_url, monitoring_policy_id, server_id))
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'POST' Methods
def create_monitoring_policy(self, monitoring_policy=None,
thresholds=None, ports=None, processes=None):
# Error Handling
if(monitoring_policy is None):
raise ValueError(('monitoring_policy is a required parameter. '
'Make sure you pass a MonitoringPolicy object.'))
if(thresholds is None):
raise ValueError(('thresholds is a required parameter. Make '
'sure you pass a list with all 5 Threshold '
'objects(cpu, ram, disk, transfer, '
'internal_ping).'))
if(ports is None):
raise ValueError(
('ports is a required parameter. Make sure '
'you pass a list with at least one Port object.'))
if(processes is None):
raise ValueError(('processes is a required parameter. Make '
'sure you pass a list with at least one '
'Process object.'))
# Unpack Thresholds
new_thresholds = {}
for value in thresholds:
new_thresholds[value.entity] = {
'warning': {
'value': value.warning_value,
'alert': value.warning_alert
},
'critical': {
'value': value.critical_value,
'alert': value.critical_alert
}
}
# Unpack Ports
new_ports = []
for value in ports:
new_ports.append(value.specs)
# Unpack Processes
new_processes = []
for value in processes:
new_processes.append(value.process_set)
# Add Ports, Processes, and Thresholds to Monitoring Policy object
monitoring_policy.specs['thresholds'] = new_thresholds
monitoring_policy.specs['ports'] = new_ports
monitoring_policy.specs['processes'] = new_processes
# Perform Request
url = '%s/monitoring_policies' % self.base_url
try:
r = requests_retry_session().post(url, headers=self.header,
json=monitoring_policy.specs)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
# Assign new monitoring_policy_id back to calling MonitoringPolicy
# object
response = r.json()
monitoring_policy.specs.update(monitoring_policy_id=response['id'])
monitoring_policy.specs.update(api_token=self.header)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def add_port(self, monitoring_policy_id=None, ports=None):
# Error Handling
if(monitoring_policy_id is None):
raise ValueError('monitoring_policy_id is a required parameter')
if(ports is None):
raise ValueError(('ports is a required parameter. Make sure you '
'send in a list with at least one Port object'))
# Unpack ports
new_ports = []
for value in ports:
new_ports.append(value.specs)
# Perform Request
data = {'ports': new_ports}
url = ('%s/monitoring_policies/%s/ports' %
(self.base_url, monitoring_policy_id))
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def add_process(self, monitoring_policy_id=None, processes=None):
# Error Handling
if(monitoring_policy_id is None):
raise ValueError('monitoring_policy_id is a required parameter')
if(processes is None):
raise ValueError(('processes is a required parameter. Make '
'sure you send in a list with at least one '
'Process object'))
# Unpack processes
new_processes = []
for value in processes:
new_processes.append(value.process_set)
# Perform Request
data = {'processes': new_processes}
url = ('%s/monitoring_policies/%s/processes' %
(self.base_url, monitoring_policy_id))
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def attach_monitoring_policy_server(self, monitoring_policy_id=None,
servers=None):
# Error Handling
if(monitoring_policy_id is None):
raise ValueError('monitoring_policy_id is a required parameter')
if(servers is None):
raise ValueError(('servers is a required parameter. Make sure '
'you send in a list with at least one '
'AttachServer object'))
# Unpack servers
add_servers = []
for value in servers:
add_servers.append(value.server_id)
# Perform Request
data = {'servers': add_servers}
url = ('%s/monitoring_policies/%s/servers' %
(self.base_url, monitoring_policy_id))
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'PUT' Methods
def modify_monitoring_policy(
self,
monitoring_policy_id=None,
monitoring_policy=None,
thresholds=None,
test=False):
try:
# Error Handling
if(monitoring_policy_id is None):
raise ValueError(
'monitoring_policy_id is a required parameter')
# Use flag to skip this live API call when running unit test
if(test == False):
# Make request for existing monitoring policy object
json = self.get_monitoring_policy(
monitoring_policy_id=monitoring_policy_id)
# Update policy specs with new values, if necessary.
if(monitoring_policy):
if(json['name'] != monitoring_policy.specs['name']):
if(monitoring_policy.specs['name'] is not None):
json['name'] = monitoring_policy.specs['name']
if(json['description'] !=
monitoring_policy.specs['description']):
if(monitoring_policy.specs['description'] is not None):
json['description'] = monitoring_policy.specs['description']
if(json['email'] != monitoring_policy.specs['email']):
if(monitoring_policy.specs['email'] is not None):
json['email'] = monitoring_policy.specs['email']
# Unpack thresholds
if(thresholds):
new_thresholds = {}
for value in thresholds:
new_thresholds[value.entity] = {
'warning': {
'value': value.warning_value,
'alert': value.warning_alert
},
'critical': {
'value': value.critical_value,
'alert': value.critical_alert
}
}
# Compare all threshold values and update, if necessary.
threshold_entities = ['cpu', 'ram', 'disk', 'transfer',
'internal_ping']
for value in threshold_entities:
if(value in new_thresholds.keys()):
if(json['thresholds'][value]['warning']['value'] !=
new_thresholds[value]['warning']['value']):
json['thresholds'][value]['warning']['value'] = new_thresholds[value]['warning']['value']
if(json['thresholds'][value]['warning']['alert'] !=
new_thresholds[value]['warning']['alert']):
json['thresholds'][value]['warning']['alert'] = new_thresholds[value]['warning']['alert']
if(json['thresholds'][value]['critical']['value'] !=
new_thresholds[value]['critical']['value']):
json['thresholds'][value]['critical']['value'] = new_thresholds[value]['critical']['value']
if(json['thresholds'][value]['critical']['alert'] !=
new_thresholds[value]['critical']['alert']):
json['thresholds'][value]['critical']['alert'] = new_thresholds[value]['critical']['alert']
# Perform Request
data = {
'name': json['name'],
'description': json['description'],
'email': json['email'],
'thresholds': json['thresholds']
}
url = ('%s/monitoring_policies/%s' %
(self.base_url, monitoring_policy_id))
r = requests_retry_session().put(url, headers=self.header, json=data)
else:
# Mock Request for Unit Testing
r = requests_retry_session().put(
self.base_url + '/monitoring_policies/%s' %
(monitoring_policy_id), headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def modify_port(self, monitoring_policy_id=None, port_id=None, port=None,
test=False):
try:
# Error Handling
if(monitoring_policy_id is None):
raise ValueError(
'monitoring_policy_id is a required parameter')
if(port_id is None):
raise ValueError('port_id is a required parameter')
# Use flag to skip this live API call when running unit test
if(test == False):
# Make request for existing port object
json = self.get_monitoring_policy_port(
monitoring_policy_id=monitoring_policy_id, port_id=port_id)
del json['id']
# Update port object with new values, if necessary.
if(json['alert_if'] != port.specs['alert_if']):
if(port.specs['alert_if'] is not None):
json['alert_if'] = port.specs['alert_if']
if(json['email_notification'] != port.specs['email_notification']):
if(port.specs['email_notification'] is not None):
json['email_notification'] = port.specs['email_notification']
# Perform Request
data = {'ports': json}
url = ('%s/monitoring_policies/%s/ports/%s' %
(self.base_url, monitoring_policy_id, port_id))
r = requests_retry_session().put(url, headers=self.header, json=data)
else:
# Mock Request for Unit Testing
r = requests_retry_session().put(
self.base_url + '/monitoring_policies/%s/ports/%s' %
(monitoring_policy_id, port_id), headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def modify_process(self, monitoring_policy_id=None, process_id=None,
process=None, test=False):
try:
# Error Handling
if(monitoring_policy_id is None):
raise ValueError(
'monitoring_policy_id is a required parameter')
if(process_id is None):
raise ValueError('process_id is a required parameter')
# Use flag to skip this live API call when running unit test
if(test == False):
# Make request for existing process object
json = self.get_monitoring_policy_process(
monitoring_policy_id=monitoring_policy_id,
process_id=process_id)
del json['id']
# Update process object with new values, if necessary.
if(json['alert_if'] != process.process_set['alert_if']):
if(process.process_set['alert_if'] is not None):
json['alert_if'] = process.process_set['alert_if']
if(json['email_notification'] !=
process.process_set['email_notification']):
if(process.process_set['email_notification'] is not None):
json['email_notification'] = process.process_set['email_notification']
# Perform Request
data = {'processes': json}
url = ('%s/monitoring_policies/%s/processes/%s' %
(self.base_url, monitoring_policy_id, process_id))
r = requests_retry_session().put(url, headers=self.header, json=data)
else:
# Mock Request for Unit Testing
r = requests_retry_session().put(
self.base_url + '/monitoring_policies/%s/processes/%s' %
(monitoring_policy_id, process_id), headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# Log Functions
# 'GET' Methods
def list_logs(
self,
page=None,
per_page=None,
sort=None,
q=None,
fields=None,
period='LAST_24H',
start_date=None,
end_date=None):
# Error Handling
if(period == 'CUSTOM'):
if(start_date is None):
raise ValueError(('start_date parameter is required when '
'using CUSTOM period'))
if(end_date is None):
raise ValueError(('end_date parameter is required when '
'using CUSTOM period'))
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields,
'period': period,
'start_date': start_date,
'end_date': end_date
}
url = '%s/logs' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_log(self, log_id=None):
# Error Handling
if(log_id is None):
raise ValueError('log_id parameter is required')
# Perform Request
url = '%s/logs/%s' % (self.base_url, log_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# User Functions
# 'GET' Methods
def list_users(self, page=None, per_page=None, sort=None, q=None,
fields=None):
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields
}
url = '%s/users' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_user(self, user_id=None):
# Error Handling
if(user_id is None):
raise ValueError('user_id is a required parameter')
# Perform Request
url = '%s/users/%s' % (self.base_url, user_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def api_info(self, user_id=None):
# Error Handling
if(user_id is None):
raise ValueError('user_id is a required parameter')
# Perform Request
url = '%s/users/%s/api' % (self.base_url, user_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def show_api_key(self, user_id=None):
# Error Handling
if(user_id is None):
raise ValueError('user_id is a required parameter')
# Perform Request
url = '%s/users/%s/api/key' % (self.base_url, user_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def show_user_permissions(self):
# Perform Request
url = '%s/users/current_user_permissions' % (self.base_url)
r = requests.get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def ips_api_access_allowed(self, user_id=None):
# Error Handling
if(user_id is None):
raise ValueError('user_id is a required parameter')
# Perform Request
url = '%s/users/%s/api/ips' % (self.base_url, user_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'POST' Methods
def create_user(self, name=None, password=None, email=None,
description=None):
# Error Handling
if(name is None):
raise ValueError('name is a required parameter')
if(password is None):
raise ValueError('password is a required parameter')
# Perform Request
data = {
'name': name,
'password': password,
'email': email,
'description': description
}
url = '%s/users' % self.base_url
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def add_user_ip(self, user_id=None, user_ips=None):
# Error Handling
if(user_id is None):
raise ValueError('user_id is a required parameter')
if(user_ips is None):
raise ValueError(('user_ips is a required parameter. Make '
'sure you pass a list with at least '
'one IP string.'))
# Unpack IPs
ips = []
for value in user_ips:
ips.append(value)
# Perform Request
data = {'ips': ips}
url = '%s/users/%s/api/ips' % (self.base_url, user_id)
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'PUT' Methods
def modify_user(self, user_id=None, description=None, email=None,
password=None, state=None):
# Error Handling
if(user_id is None):
raise ValueError('user_id is a required parameter')
if(password is not None) and (len(password) < 8):
raise ValueError('password must be at least 8 characters long')
if(state is not None) and (state != 'ACTIVE') and (state != 'DISABLE'):
raise ValueError('state should be set to "ACTIVE" or "DISABLE".')
# Perform Request
data = {
'description': description,
'email': email,
'password': password,
'state': state
}
url = '%s/users/%s' % (self.base_url, user_id)
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def modify_user_api(self, user_id=None, active=None):
# Error Handling
if(user_id is None):
raise ValueError('user_id is a required parameter')
if(active is not None) and (active != True) and (active != False):
raise ValueError('active parameter only accepts a boolean value')
# Perform Request
data = {'active': active}
url = '%s/users/%s/api' % (self.base_url, user_id)
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def change_api_key(self, user_id=None):
# Error Handling
if(user_id is None):
raise ValueError('user_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = '%s/users/%s/api/key' % (self.base_url, user_id)
try:
r = requests_retry_session().put(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'DELETE' Methods
def delete_user(self, user_id=None):
# Error Handling
if(user_id is None):
raise ValueError('user_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = '%s/users/%s' % (self.base_url, user_id)
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def remove_user_ip(self, user_id=None, ip=None):
# Error Handling
if(user_id is None):
raise ValueError('user_id is a required parameter')
if(ip is None):
raise ValueError('ip is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = '%s/users/%s/api/ips/%s' % (self.base_url, user_id, ip)
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# Usage Functions
# 'GET' Methods
def list_usages(
self,
page=None,
per_page=None,
sort=None,
q=None,
fields=None,
period='LAST_24H',
start_date=None,
end_date=None):
# Error Handling
if(period == 'CUSTOM'):
if(start_date is None):
raise ValueError(('start_date parameter is required when '
'using CUSTOM period'))
if(end_date is None):
raise ValueError(('end_date parameter is required when '
'using CUSTOM period'))
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields,
'period': period,
'start_date': start_date,
'end_date': end_date
}
url = '%s/usages' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_pricing(self):
# Perform Request
url = '%s/pricing' % (self.base_url)
r = requests.get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
# Recovery images
# 'GET' Methods
def list_recovery_images(self, page=None, per_page=None, sort=None,
q=None, fields=None):
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields
}
url = '%s/recovery_appliances' % self.base_url
r = requests.get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def get_recovery_image(self, image_id=None):
# Error Handling
if(image_id is None):
raise ValueError('appliance_id is a required parameter')
# Perform Request
url = '%s/recovery_appliances/%s' % (self.base_url, image_id)
r = requests.get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
# Server Appliance Functions
# 'GET' Methods
def list_appliances(self, page=None, per_page=None, sort=None,
q=None, fields=None):
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields
}
url = '%s/server_appliances' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_appliance(self, appliance_id=None):
# Error Handling
if(appliance_id is None):
raise ValueError('appliance_id is a required parameter')
# Perform Request
url = '%s/server_appliances/%s' % (self.base_url, appliance_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# DVD Functions
# 'GET' Methods
def list_dvds(self, page=None, per_page=None, sort=None,
q=None, fields=None):
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields
}
url = '%s/dvd_isos' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_dvd(self, iso_id=None):
# Error Handling
if(iso_id is None):
raise ValueError('iso_id parameter is required')
# Perform Request
url = '%s/dvd_isos/%s' % (self.base_url, iso_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# Datacenter Functions
# 'GET' Methods
def list_datacenters(self, page=None, per_page=None, sort=None,
q=None, fields=None):
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields
}
url = '%s/datacenters' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_datacenter(self, datacenter_id=None):
# Error Handling
if(datacenter_id is None):
raise ValueError('datacenter_id parameter is required')
# Perform Request
url = '%s/datacenters/%s' % (self.base_url, datacenter_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# Pricing Functions
# 'GET' Methods
def pricing(self):
# Perform Request
url = '%s/pricing' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# Ping Functions
# 'GET' Methods
def ping(self):
# Perform Request
url = '%s/ping' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# Ping Auth Functions
# 'GET' Methods
def ping_auth(self):
# Perform Request
url = '%s/ping_auth' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# VPN Functions
# 'GET' Methods
def list_vpns(self, page=None, per_page=None, sort=None, q=None,
fields=None):
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields
}
url = '%s/vpns' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_vpn(self, vpn_id=None):
# Error Handling
if(vpn_id is None):
raise ValueError('vpn_id is a required parameter')
# Perform Request
url = '%s/vpns/%s' % (self.base_url, vpn_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def download_config(self, vpn_id=None, file_path=None):
# Error Handling
if(vpn_id is None):
raise ValueError('vpn_id is a required parameter')
# Perform Request
url = '%s/vpns/%s/configuration_file' % (self.base_url, vpn_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
body = r.json()
filestring = base64.b64decode(body["config_zip_file"])
zipPath = file_path + '.zip'
with open(zipPath, 'wb') as zipFile:
zipFile.write(filestring)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'POST' Methods
def create_vpn(self, vpn=None):
# Perform Request
data = {
'name': vpn.name,
'description': vpn.description,
'datacenter_id': vpn.datacenter_id
}
url = '%s/vpns' % self.base_url
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
# Assign new image_id back to calling Image object
response = r.json()
vpn.specs.update(vpn_id=response['id'])
vpn.specs.update(api_token=self.header)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'DELETE' Methods
def delete_vpn(self, vpn_id=None):
# Error Handling
if(vpn_id is None):
raise ValueError('vpn_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = '%s/vpns/%s' % (self.base_url, vpn_id)
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'PUT' Methods
def modify_vpn(self, vpn_id=None, name=None, description=None):
# Error Handling
if(vpn_id is None):
raise ValueError('vpn_id is a required parameter')
# Perform Request
data = {
'name': name,
'description': description
}
url = '%s/vpns/%s' % (self.base_url, vpn_id)
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# Role Functions
# 'GET' Methods
def list_roles(self, page=None, per_page=None, sort=None, q=None,
fields=None):
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields
}
url = '%s/roles' % self.base_url
try:
r = requests_retry_session().get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_role(self, role_id=None):
# Error Handling
if(role_id is None):
raise ValueError('role_id is a required parameter')
# Perform Request
url = '%s/roles/%s' % (self.base_url, role_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def permissions(self, role_id=None):
# Error Handling
if(role_id is None):
raise ValueError('role_id is a required parameter')
# Perform Request
url = '%s/roles/%s/permissions' % (self.base_url, role_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def current_user_permissions(self):
# Perform Request
url = '%s/users/current_user_permissions' % (self.base_url)
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def role_users(self, role_id=None):
# Error Handling
if(role_id is None):
raise ValueError('role_id is a required parameter')
# Perform Request
url = '%s/roles/%s/users' % (self.base_url, role_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def get_role_user(self, role_id=None, user_id=None):
# Error Handling
if(role_id is None):
raise ValueError('role_id is a required parameter')
# Perform Request
url = '%s/roles/%s/users/%s' % (self.base_url, role_id, user_id)
try:
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'POST' Methods
def create_role(self, name=None):
# Perform Request
data = {
'name': name
}
url = '%s/roles' % self.base_url
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def add_users(self, role_id=None, users=None):
# Error Handling
if(role_id is None):
raise ValueError('role_id is a required parameter')
# Perform Request
data = {
'users': users
}
url = '%s/roles/%s/users' % (self.base_url, role_id)
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def clone_role(self, role_id=None, name=None):
# Error Handling
if(role_id is None):
raise ValueError('role_id is a required parameter')
# Perform Request
data = {
'name': name
}
url = '%s/roles/%s/clone' % (self.base_url, role_id)
try:
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'DELETE' Methods
def delete_role(self, role_id=None):
# Error Handling
if(role_id is None):
raise ValueError('role_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = '%s/roles/%s' % (self.base_url, role_id)
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def remove_user(self, role_id=None, user_id=None):
# Error Handling
if(role_id is None):
raise ValueError('role_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = '%s/roles/%s/users/%s' % (self.base_url, role_id, user_id)
try:
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# 'PUT' Methods
def modify_role(self, role_id=None, name=None, description=None,
state=None):
# Error Handling
if(role_id is None):
raise ValueError('role_id is a required parameter')
# Perform Request
data = {
'name': name,
'description': description,
'state': state
}
url = '%s/roles/%s' % (self.base_url, role_id)
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
def modify_permissions(
self,
role_id=None,
servers=None,
images=None,
shared_storages=None,
firewalls=None,
load_balancers=None,
ips=None,
private_networks=None,
vpns=None,
monitoring_centers=None,
monitoring_policies=None,
backups=None,
logs=None,
users=None,
roles=None,
usages=None,
interactive_invoices=None):
# Error Handling
if(role_id is None):
raise ValueError('role_id is a required parameter')
# Perform Request
data = {
'servers': servers,
'images': images,
'sharedstorages': shared_storages,
'firewalls': firewalls,
'loadbalancers': load_balancers,
'ips': ips,
'privatenetwork': private_networks,
'vpn': vpns,
'monitoringcenter': monitoring_centers,
'monitoringpolicies': monitoring_policies,
'backups': backups,
'logs': logs,
'users': users,
'roles': roles,
'usages': usages,
'interactiveinvoice': interactive_invoices
}
url = '%s/roles/%s/permissions' % (self.base_url, role_id)
try:
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
except http_client.HTTPException:
if r is not None:
error_message = (
'Error Code: %s. Error Message: %s. Response Headers :%s' %
(r.status_code, r.text, r.headers))
raise Exception(error_message)
else:
raise
# Block Storage Functions
# 'GET' Methods
def list_block_storages(self, page=None, per_page=None, sort=None,
q=None, fields=None):
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields
}
url = '%s/block_storages' % self.base_url
r = requests_retry_session().get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def get_block_storage(self, block_storage_id=None):
# Error Handling
if(block_storage_id is None):
raise ValueError('block_storage_id is a required parameter')
# Perform Request
url = '%s/block_storages/%s' % (self.base_url, block_storage_id)
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
# 'POST' Methods
def create_block_storage(self, block_storage=None):
# Perform Request
data = {
'name': block_storage.name,
'description': block_storage.description,
'size': block_storage.size,
'server': block_storage.server_id,
'datacenter_id': block_storage.datacenter_id,
'execution_group': block_storage.execution_group
}
url = '%s/block_storages' % self.base_url
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
# Assign new block_storage_id back to calling BlockStorage object
response = r.json()
block_storage.specs.update(block_storage_id=response['id'])
block_storage.specs.update(api_token=self.header)
return r.json()
def attach_block_storage(self, block_storage_id=None,
server_id=None):
# Error Handling
if(block_storage_id is None):
raise ValueError('block_storage_id is a required parameter')
if(server_id is None):
raise ValueError('server_id is a required parameter.')
# Perform Request
data = {'server': server_id}
url = ('%s/block_storages/%s/server' %
(self.base_url, block_storage_id))
r = requests_retry_session().post(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
# 'PUT' Methods
def modify_block_storage(self, block_storage_id=None, name=None,
description=None, size=None):
# Error Handling
if(block_storage_id is None):
raise ValueError('block_storage_id is a required parameter')
# Perform Request
data = {
'name': name,
'description': description,
'size': size
}
url = '%s/block_storages/%s' % (self.base_url, block_storage_id)
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
# 'DELETE' Methods
def delete_block_storage(self, block_storage_id=None):
# Error Handling
if(block_storage_id is None):
raise ValueError('block_storage_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = '%s/block_storages/%s' % (self.base_url, block_storage_id)
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def detach_block_storage(self, block_storage_id=None):
# Error Handling
if(block_storage_id is None):
raise ValueError('block_storage_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = ('%s/block_storages/%s/server' %
(self.base_url, block_storage_id))
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
# Ssh Key Functions
# 'GET' Methods
def list_ssh_keys(self, page=None, per_page=None, sort=None, q=None,
fields=None):
# Perform Request
parameters = {
'page': page,
'per_page': per_page,
'sort': sort,
'q': q,
'fields': fields
}
url = '%s/ssh_keys' % self.base_url
r = requests_retry_session().get(url, headers=self.header, params=parameters)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def get_ssh_key(self, ssh_key_id=None):
# Error Handling
if(ssh_key_id is None):
raise ValueError('ssh_key_id is a required parameter')
# Perform Request
url = '%s/ssh_keys/%s' % (self.base_url, ssh_key_id)
r = requests_retry_session().get(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
# 'POST' Methods
def create_ssh_key(self, ssh_key=None):
# Perform Request
url = '%s/ssh_keys' % self.base_url
r = requests_retry_session().post(url, headers=self.header, json=ssh_key.specs)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
# Assign new ssh_key_id back to calling SshKey object
response = r.json()
ssh_key.specs.update(ssh_key_id=response['id'])
ssh_key.specs.update(api_token=self.header)
return r.json()
# 'DELETE' Methods
def delete_ssh_key(self, ssh_key_id=None):
# Error Handling
if(ssh_key_id is None):
raise ValueError('ssh_key_id is a required parameter')
# Perform Request
self.header['content-type'] = 'application/json'
url = '%s/ssh_keys/%s' % (self.base_url, ssh_key_id)
r = requests_retry_session().delete(url, headers=self.header)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
# 'PUT' Methods
def modify_ssh_key(self, ssh_key_id=None, name=None, description=None):
# Error Handling
if(ssh_key_id is None):
raise ValueError('ssh_key_id is a required parameter')
# Perform Request
data = {
'name': name,
'description': description
}
url = '%s/ssh_keys/%s' % (self.base_url, ssh_key_id)
r = requests_retry_session().put(url, headers=self.header, json=data)
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
# Utility Classes
class Server(object):
# Init Function
def __init__(
self,
name=None,
description=None,
fixed_instance_size_id=None,
vcore=None,
cores_per_processor=None,
ram=None,
appliance_id=None,
password=None,
power_on=None,
firewall_policy_id=None,
ip_id=None,
load_balancer_id=None,
monitoring_policy_id=None,
datacenter_id=None,
rsa_key=None,
private_network_id=None,
server_type=None,
public_key=None,
baremetal_model_id=None,
ipv6_range=None,
hostname=None,
execution_group=None):
self.first_password = None
self.first_ip = None
self.specs = {
'name': name,
'description': description,
'hardware': {
'fixed_instance_size_id': fixed_instance_size_id,
'vcore': vcore,
'cores_per_processor': cores_per_processor,
'ram': ram,
'baremetal_model_id': baremetal_model_id
},
'appliance_id': appliance_id,
'password': password,
'power_on': power_on,
'firewall_policy_id': firewall_policy_id,
'ip_id': ip_id,
'load_balancer_id': load_balancer_id,
'monitoring_policy_id': monitoring_policy_id,
'datacenter_id': datacenter_id,
'rsa_key': rsa_key,
'private_network_id': private_network_id,
'server_type': server_type,
'public_key': public_key,
'ipv6_range': ipv6_range,
'hostname': hostname,
'execution_group': execution_group
}
self.base_url = 'https://cloudpanel-api.1and1.com/v1'
self.success_codes = (200, 201, 202)
self.good_states = (
'ACTIVE',
'ENABLED',
'POWERED_ON',
'POWERED_OFF',
'ON RECOVERY')
def __repr__(self):
return (
'Server: name=%s, description=%s, fixed_instance_size_id=%s, '
'vcore=%s, cores_per_processor=%s, ram=%s, baremetal_model_id=%s, appliance_id=%s, '
'password=%s, power_on=%s, firewall_policy_id=%s, ip_id=%s, '
'load_balancer_id=%s, monitoring_policy_id=%s, '
'rsa_key=%s, datacenter_id=%s, first_password=%s, '
'first_ip=%s, public_key=%s, server_type=%s, ipv6_range=%s, execution_group=%s, hostname=%s' %
(self.specs['name'],
self.specs['description'],
self.specs['hardware']['fixed_instance_size_id'],
self.specs['hardware']['vcore'],
self.specs['hardware']['cores_per_processor'],
self.specs['hardware']['ram'],
self.specs['hardware']['baremetal_model_id'],
self.specs['appliance_id'],
self.specs['password'],
self.specs['power_on'],
self.specs['firewall_policy_id'],
self.specs['ip_id'],
self.specs['load_balancer_id'],
self.specs['monitoring_policy_id'],
self.specs['rsa_key'],
self.specs['datacenter_id'],
self.first_password,
self.first_ip,
self.specs['server_type'],
self.specs['ipv6_range'],
self.specs['execution_group'],
self.specs['hostname'],
))
def get(self):
# Perform Request
url = ('%s/servers/%s' %
(self.base_url, self.specs['server_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def hardware(self):
# Perform Request
url = ('%s/servers/%s/hardware' %
(self.base_url, self.specs['server_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def hdds(self):
# Perform Request
url = ('%s/servers/%s/hardware/hdds' %
(self.base_url, self.specs['server_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def image(self):
# Perform Request
url = ('%s/servers/%s/image' %
(self.base_url, self.specs['server_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def ips(self):
# Perform Request
url = ('%s/servers/%s/ips' %
(self.base_url, self.specs['server_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def status(self):
# Perform Request
url = ('%s/servers/%s/status' %
(self.base_url, self.specs['server_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def dvd(self):
# Perform Request
url = ('%s/servers/%s/dvd' %
(self.base_url, self.specs['server_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def private_networks(self):
# Perform Request
url = ('%s/servers/%s/private_networks' %
(self.base_url, self.specs['server_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def snapshots(self):
# Perform Request
url = ('%s/servers/%s/snapshots' %
(self.base_url, self.specs['server_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def wait_for(self, timeout=25, interval=15):
# Capture start time
start = time.time()
duration = 0
# Check initial server status
url = '%s/servers/%s' % (self.base_url, self.specs['server_id'])
r = requests_retry_session().get(url, headers=self.specs['api_token'])
response = r.json()
# Store initial server state and percent values
server_state = response['status']['state']
percent = response['status']['percent']
# Keep polling the server's status until good
while (server_state not in self.good_states) or (percent is not None):
# Wait 15 seconds before polling again
time.sleep(interval)
# Check server status again
r = requests_retry_session().get(
url, headers=self.specs['api_token'])
response = r.json()
# Update server state and percent values
server_state = response['status']['state']
percent = response['status']['percent']
# Check for timeout
seconds = (time.time() - start)
duration = seconds / 60
if duration > timeout:
print('The operation timed out after %s minutes.' % timeout)
return
# Parse for first IP address
if len(response['ips']) == 1:
self.first_ip = response['ips'][0]
return {'duration': duration}
def wait_deleted(self, timeout=25, interval=15):
# Capture start time
start = time.time()
duration = 0
# Check initial server status
url = '%s/servers/%s' % (self.base_url, self.specs['server_id'])
r = requests_retry_session().get(url, headers=self.specs['api_token'])
response = r.json()
# Keep polling the server's status until got 404
while r.status_code != 404 :
# Wait 15 seconds before polling again
time.sleep(interval)
# Check server status again
r = requests_retry_session().get(
url, headers=self.specs['api_token'])
# Check for timeout
seconds = (time.time() - start)
duration = seconds / 60
if duration > timeout:
print('The operation timed out after %s minutes.' % timeout)
return
return {'duration': duration}
class Hdd(object):
# Init Function
def __init__(self, size=None, is_main=None):
self.specs = {
'size': size,
'is_main': is_main
}
def __repr__(self):
return ('HDD: size=%s, is_main=%s' %
(self.specs['size'], self.specs['is_main']))
class AttachServer(object):
# Init Function
def __init__(self, server_id=None, rights=None, server_ip_id=None):
self.server_id = server_id
self.rights = rights
self.server_ip_id = server_ip_id
def __repr__(self):
return ('AttachServer: server_id=%s, rights=%s, server_ip_id=%s' %
(self.server_id, self.rights, self.server_ip_id))
class Image(object):
# Init Function
def __init__(
self,
server_id=None,
name=None,
description=None,
frequency=None,
num_images=None,
source='server',
url=None,
os_id=None,
isotype=None,
type=None):
self.server_id = server_id
self.name = name
self.description = description
self.frequency = frequency
self.num_images = num_images
self.source = source
self.url = url
self.os_id = os_id
self.type = isotype
self.specs = {}
self.base_url = 'https://cloudpanel-api.1and1.com/v1'
self.success_codes = (200, 201, 202)
self.good_states = ('ACTIVE', 'ENABLED', 'POWERED_ON', 'POWERED_OFF')
def __repr__(self):
return (
'Image: server_id=%s, name=%s, description=%s, '
'frequency=%s, num_images=%s, source=%s, url=%s'
'os_id=%s, type=%s' %
(self.server_id,
self.name,
self.description,
self.frequency,
self.num_images,
self.source,
self.url,
self.os_id,
self.type))
def get(self):
# Perform Request
url = ('%s/images/%s' %
(self.base_url, self.specs['image_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def wait_for(self, timeout=25, interval=15):
# Capture start time
start = time.time()
duration = 0
# Check initial image status
url = '%s/images/%s' % (self.base_url, self.specs['image_id'])
r = requests_retry_session().get(url, headers=self.specs['api_token'])
response = r.json()
# Store initial server state and percent values
image_state = response['state']
# Keep polling the server's status until good
while image_state not in self.good_states:
# Wait 15 seconds before polling again
time.sleep(interval)
# Check server status again
r = requests_retry_session().get(
url, headers=self.specs['api_token'])
response = r.json()
# Update server state and percent values
image_state = response['state']
# Check for timeout
seconds = (time.time() - start)
duration = seconds / 60
if duration > timeout:
print('The operation timed out after %s minutes.' % timeout)
return
return {'duration': duration}
class SharedStorage(object):
# Init Function
def __init__(self, name=None, description=None, size=None,
datacenter_id=None):
self.name = name
self.description = description
self.size = size
self.datacenter_id = datacenter_id
self.specs = {}
self.base_url = 'https://cloudpanel-api.1and1.com/v1'
self.success_codes = (200, 201, 202)
self.good_states = ('ACTIVE', 'ENABLED', 'POWERED_ON', 'POWERED_OFF')
def __repr__(self):
return ('Shared Storage: name=%s, description=%s, size=%s' %
(self.name, self.description, self.size, self.datacenter_id))
def get(self):
# Perform Request
url = ('%s/shared_storages/%s' %
(self.base_url, self.specs['shared_storage_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def servers(self):
# Perform Request
url = ('%s/shared_storages/%s/servers' %
(self.base_url, self.specs['shared_storage_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def wait_for(self, timeout=25, interval=5):
# Capture start time
start = time.time()
duration = 0
# Check initial image status
url = '%s/shared_storages/%s' % (self.base_url,
self.specs['shared_storage_id'])
r = requests_retry_session().get(url, headers=self.specs['api_token'])
response = r.json()
# Store initial server state and percent values
shared_storage_state = response['state']
# Keep polling the server's status until good
while shared_storage_state not in self.good_states:
# Wait 15 seconds before polling again
time.sleep(interval)
# Check server status again
r = requests_retry_session().get(
url, headers=self.specs['api_token'])
response = r.json()
# Update server state and percent values
shared_storage_state = response['state']
# Check for timeout
seconds = (time.time() - start)
duration = seconds / 60
if duration > timeout:
print('The operation timed out after %s minutes.' % timeout)
return
return {'duration': duration}
class FirewallPolicyRule(object):
# Init Function
def __init__(self, protocol=None, port_from=None, port_to=None,
source=None, action=None, description=None, port=None):
self.rule_set = {
'protocol': protocol,
'port_from': port_from,
'port_to': port_to,
'source': source,
'action': action,
'description': description,
'port': port
}
def __repr__(self):
return ('FirewallPolicyRule: protocol=%s, port_from=%s, '
'port_to=%s, source=%s, action=%s, description=%s, port=%s' %
(self.rule_set['protocol'], self.rule_set['port_from'],
self.rule_set['port_to'], self.rule_set['source'], self.rule_set['action'], self.rule_set['description'], self.rule_set['port']))
class FirewallPolicy(object):
# Init Function
def __init__(self, name=None, description=None):
self.specs = {
'name': name,
'description': description
}
self.base_url = 'https://cloudpanel-api.1and1.com/v1'
self.success_codes = (200, 201, 202)
self.good_states = ('ACTIVE', 'ENABLED', 'POWERED_ON', 'POWERED_OFF')
def __repr__(self):
return ('FirewallPolicy: name=%s, description=%s' %
(self.specs['name'], self.specs['description']))
def get(self):
# Perform Request
url = ('%s/firewall_policies/%s' %
(self.base_url, self.specs['firewall_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def ips(self):
# Perform Request
url = ('%s/firewall_policies/%s/server_ips' %
(self.base_url, self.specs['firewall_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def rules(self):
# Perform Request
url = ('%s/firewall_policies/%s/rules' %
(self.base_url, self.specs['firewall_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def wait_for(self, timeout=25, interval=5):
# Capture start time
start = time.time()
duration = 0
# Check initial image status
url = '%s/firewall_policies/%s' % (self.base_url,
self.specs['firewall_id'])
r = requests_retry_session().get(url, headers=self.specs['api_token'])
response = r.json()
# Store initial server state and percent values
firewall_state = response['state']
# Keep polling the server's status until good
while firewall_state not in self.good_states:
# Wait 15 seconds before polling again
time.sleep(interval)
# Check server status again
r = requests_retry_session().get(
url, headers=self.specs['api_token'])
response = r.json()
# Update server state and percent values
firewall_state = response['state']
# Check for timeout
seconds = (time.time() - start)
duration = seconds / 60
if duration > timeout:
print('The operation timed out after %s minutes.' % timeout)
return
return {'duration': duration}
class LoadBalancerRule(object):
# Init Function
def __init__(self, protocol=None, port_balancer=None, port_server=None,
source=None):
self.rule_set = {
'protocol': protocol,
'port_balancer': port_balancer,
'port_server': port_server,
'source': source
}
def __repr__(self):
return (
'LoadBalancerRule: protocol=%s, port_balancer=%s, '
'port_server=%s, source=%s' %
(self.rule_set['protocol'],
self.rule_set['port_balancer'],
self.rule_set['port_server'],
self.rule_set['source']))
class LoadBalancer(object):
# Init Function
def __init__(self, health_check_path=None, health_check_parse=None,
name=None, description=None, health_check_test=None,
health_check_interval=None, persistence=None,
persistence_time=None, method=None, datacenter_id=None):
self.specs = {
'health_check_path': health_check_path,
'health_check_parse': health_check_parse,
'name': name,
'description': description,
'health_check_test': health_check_test,
'health_check_interval': health_check_interval,
'persistence': persistence,
'persistence_time': persistence_time,
'method': method,
'datacenter_id': datacenter_id
}
self.base_url = 'https://cloudpanel-api.1and1.com/v1'
self.success_codes = (200, 201, 202)
self.good_states = ('ACTIVE', 'ENABLED', 'POWERED_ON', 'POWERED_OFF')
def __repr__(self):
return ('LoadBalancer: health_check_path=%s, health_check_parse=%s, '
'name=%s, description=%s, health_check_test=%s, '
'health_check_interval=%s, persistence=%s, '
'persistence_time=%s, method=%s, datacenter_id=%s' %
(self.specs['health_check_path'],
self.specs['health_check_parse'], self.specs['name'],
self.specs['description'], self.specs['health_check_test'],
self.specs['health_check_interval'],
self.specs['persistence'], self.specs['persistence_time'],
self.specs['method'], self.datacenter_id))
def get(self):
# Perform Request
url = ('%s/load_balancers/%s' %
(self.base_url, self.specs['load_balancer_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def ips(self):
# Perform Request
url = ('%s/load_balancers/%s/server_ips' %
(self.base_url, self.specs['load_balancer_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def rules(self):
# Perform Request
url = ('%s/load_balancers/%s/rules' %
(self.base_url, self.specs['load_balancer_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def wait_for(self, timeout=25, interval=5):
# Capture start time
start = time.time()
duration = 0
# Check initial image status
url = '%s/load_balancers/%s' % (self.base_url,
self.specs['load_balancer_id'])
r = requests_retry_session().get(url, headers=self.specs['api_token'])
response = r.json()
# Store initial server state and percent values
load_balancer_state = response['state']
# Keep polling the server's status until good
while load_balancer_state not in self.good_states:
# Wait 15 seconds before polling again
time.sleep(interval)
# Check server status again
r = requests_retry_session().get(
url, headers=self.specs['api_token'])
response = r.json()
# Update server state and percent values
load_balancer_state = response['state']
# Check for timeout
seconds = (time.time() - start)
duration = seconds / 60
if duration > timeout:
print('The operation timed out after %s minutes.' % timeout)
return
return {'duration': duration}
class PrivateNetwork(object):
# Init Function
def __init__(self, name=None, description=None, network_address=None,
subnet_mask=None, datacenter_id=None):
self.name = name
self.description = description
self.network_address = network_address
self.subnet_mask = subnet_mask
self.datacenter_id = datacenter_id
self.specs = {}
self.base_url = 'https://cloudpanel-api.1and1.com/v1'
self.success_codes = (200, 201, 202)
self.good_states = ('ACTIVE', 'ENABLED', 'POWERED_ON', 'POWERED_OFF')
def __repr__(self):
return (
'Private Network: name=%s, description=%s, network_address=%s, '
'subnet_mask=%s' %
(self.name, self.description, self.network_address, self.subnet_mask))
def get(self):
# Perform Request
url = ('%s/private_networks/%s' %
(self.base_url, self.specs['private_network_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def servers(self):
# Perform Request
url = ('%s/private_networks/%s/servers' %
(self.base_url, self.specs['private_network_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def wait_for(self, timeout=25, interval=5):
# Capture start time
start = time.time()
duration = 0
# Check initial image status
url = '%s/private_networks/%s' % (self.base_url,
self.specs['private_network_id'])
r = requests_retry_session().get(url, headers=self.specs['api_token'])
response = r.json()
# Store initial server state and percent values
private_network_state = response['state']
# Keep polling the server's status until good
while private_network_state not in self.good_states:
# Wait 15 seconds before polling again
time.sleep(interval)
# Check server status again
r = requests_retry_session().get(
url, headers=self.specs['api_token'])
response = r.json()
# Update server state and percent values
private_network_state = response['state']
# Check for timeout
seconds = (time.time() - start)
duration = seconds / 60
if duration > timeout:
print('The operation timed out after %s minutes.' % timeout)
return
return {'duration': duration}
class MonitoringPolicy(object):
# Init Function
def __init__(self, name=None, description=None, email=None, agent=None):
self.specs = {
'name': name,
'description': description,
'email': email,
'agent': agent
}
self.base_url = 'https://cloudpanel-api.1and1.com/v1'
self.success_codes = (200, 201, 202)
self.good_states = ('ACTIVE', 'ENABLED', 'POWERED_ON', 'POWERED_OFF')
def __repr__(self):
return ('MonitoringPolicy: name=%s, description=%s, email=%s, '
'agent=%s' %
(self.specs['name'], self.specs['description'],
self.specs['email'], self.specs['agent']))
def get(self):
# Perform Request
url = ('%s/monitoring_policies/%s' %
(self.base_url, self.specs['monitoring_policy_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def ports(self):
# Perform Request
url = ('%s/monitoring_policies/%s/ports' %
(self.base_url, self.specs['monitoring_policy_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def processes(self):
# Perform Request
url = ('%s/monitoring_policies/%s/processes' %
(self.base_url, self.specs['monitoring_policy_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def servers(self):
# Perform Request
url = ('%s/monitoring_policies/%s/servers' %
(self.base_url, self.specs['monitoring_policy_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def wait_for(self, timeout=25, interval=5):
# Capture start time
start = time.time()
duration = 0
# Check initial image status
url = '%s/monitoring_policies/%s' % (self.base_url,
self.specs['monitoring_policy_id'])
r = requests_retry_session().get(url, headers=self.specs['api_token'])
response = r.json()
# Store initial server state and percent values
mp_state = response['state']
# Keep polling the server's status until good
while mp_state not in self.good_states:
# Wait 15 seconds before polling again
time.sleep(interval)
# Check server status again
r = requests_retry_session().get(
url, headers=self.specs['api_token'])
response = r.json()
# Update server state and percent values
mp_state = response['state']
# Check for timeout
seconds = (time.time() - start)
duration = seconds / 60
if duration > timeout:
print('The operation timed out after %s minutes.' % timeout)
return
return {'duration': duration}
class Threshold(object):
# Init Function
def __init__(self, entity=None, warning_value=None, warning_alert=None,
critical_value=None, critical_alert=None):
self.entity = entity
self.warning_value = warning_value
self.warning_alert = warning_alert
self.critical_value = critical_value
self.critical_alert = critical_alert
def __repr__(self):
return (
'Threshold: entity=%s, warning_value=%s, warning_alert=%s, '
'critical_value=%s, critical_alert=%s' %
(self.entity,
self.warning_value,
self.warning_alert,
self.critical_value,
self.critical_alert))
class Port(object):
# Init Function
def __init__(self, protocol=None, port=None, alert_if=None,
email_notification=None):
self.specs = {
'protocol': protocol,
'port': port,
'alert_if': alert_if,
'email_notification': email_notification
}
def __repr__(self):
return (
'Port: protocol=%s, port=%s, alert_if=%s, '
'email_notification=%s' %
(self.specs['protocol'],
self.specs['port'],
self.specs['alert_if'],
self.specs['email_notification']))
class Process(object):
# Init Function
def __init__(self, process=None, alert_if=None, email_notification=None):
self.process_set = {
'process': process,
'alert_if': alert_if,
'email_notification': email_notification
}
def __repr__(self):
return ('Process: process=%s, alert_if=%s, email_notification=%s' %
(self.process_set['process'], self.process_set['alert_if'],
self.process_set['email_notification']))
class Vpn(object):
# Init Function
def __init__(self, name=None, description=None, datacenter_id=None):
self.name = name
self.description = description
self.datacenter_id = datacenter_id
self.specs = {}
self.base_url = 'https://cloudpanel-api.1and1.com/v1'
self.success_codes = (200, 201, 202)
self.good_states = ('ACTIVE', 'ENABLED', 'POWERED_ON', 'POWERED_OFF')
def __repr__(self):
return ('Vpn: name=%s, description=%s, datacenter_id=%s' %
(self.name, self.description, self.datacenter_id))
def get(self):
# Perform Request
url = ('%s/vpns/%s' %
(self.base_url, self.specs['vpn_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def wait_for(self, timeout=25, interval=15):
# Capture start time
start = time.time()
duration = 0
# Check initial image status
url = '%s/vpns/%s' % (self.base_url, self.specs['vpn_id'])
r = requests_retry_session().get(url, headers=self.specs['api_token'])
response = r.json()
# Store initial server state and percent values
vpn_state = response['state']
# Keep polling the server's status until good
while vpn_state not in self.good_states:
# Wait 15 seconds before polling again
time.sleep(interval)
# Check server status again
r = requests_retry_session().get(
url, headers=self.specs['api_token'])
response = r.json()
# Update server state and percent values
vpn_state = response['state']
# Check for timeout
seconds = (time.time() - start)
duration = seconds / 60
if duration > timeout:
print('The operation timed out after %s minutes.' % timeout)
return
return {'duration': duration}
class BlockStorage(object):
# Init Function
def __init__(self, name=None, description=None, size=None,
datacenter_id=None, server_id=None, execution_group=None):
self.name = name
self.description = description
self.size = size
self.datacenter_id = datacenter_id
self.server_id = server_id
self.execution_group = execution_group
self.specs = {}
self.base_url = 'https://cloudpanel-api.1and1.com/v1'
self.success_codes = (200, 201, 202)
self.good_states = ('ACTIVE', 'ENABLED', 'POWERED_ON', 'POWERED_OFF')
def __repr__(self):
return ('Block Storage: name=%s, description=%s, size=%s, execution_group=%s, server_id=%s' % (
self.name, self.description, self.size, self.datacenter_id, self.execution_group, self.server_id))
def get(self):
# Perform Request
url = ('%s/block_storages/%s' %
(self.base_url, self.specs['block_storage_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def server(self):
# Perform Request
url = ('%s/block_storages/%s/server' %
(self.base_url, self.specs['block_storage_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def wait_for(self, timeout=25, interval=5):
# Capture start time
start = time.time()
duration = 0
# Check initial block storage status
url = '%s/block_storages/%s' % (self.base_url,
self.specs['block_storage_id'])
r = requests_retry_session().get(url, headers=self.specs['api_token'])
response = r.json()
# Store initial block storage state and percent values
block_storage_state = response['state']
# Keep polling the block storage's status until good
while block_storage_state not in self.good_states:
# Wait 15 seconds before polling again
time.sleep(interval)
# Check block storage status again
r = requests_retry_session().get(
url, headers=self.specs['api_token'])
response = r.json()
# Update block storage state and percent values
block_storage_state = response['state']
# Check for timeout
seconds = (time.time() - start)
duration = seconds / 60
if duration > timeout:
print('The operation timed out after %s minutes.' % timeout)
return
return {'duration': duration}
class SshKey(object):
# Init Function
def __init__(self, name=None, description=None,
state=None, servers=None, md5=None,
public_key=None, creation_date=None):
self.specs = {
'name': name,
'description': description,
'state': state,
'servers': servers,
'md5': md5,
'public_key': public_key,
'creation_date': creation_date
}
self.base_url = 'https://cloudpanel-api.1and1.com/v1'
self.success_codes = (200, 201, 202)
self.good_states = ('ACTIVE', 'ENABLED', 'POWERED_ON', 'POWERED_OFF')
def __repr__(self):
return ('SshKey: name=%s, description=%s, '
'state=%s, servers=%s, md5=%s, '
'public_key=%s, creation_date=%s, ' %
(self.specs['name'], self.specs['description'],
self.specs['state'], self.specs['servers'],
self.specs['md5'], self.specs['public_key'],
self.specs['creation_date']))
def get(self):
# Perform Request
url = ('%s/ssh_keys/%s' %
(self.base_url, self.specs['ssh_key_id']))
r = requests_retry_session().get(url, headers=self.specs['api_token'])
# Handle Potential Response Errors
if r.status_code not in self.success_codes:
error_message = ('Error Code: %s. Error Message: %s.' %
(r.status_code, r.text))
raise Exception(error_message)
return r.json()
def wait_for(self, timeout=25, interval=5):
# Capture start time
start = time.time()
duration = 0
# Check initial ssh_key status
url = '%s/ssh_keys/%s' % (self.base_url,
self.specs['ssh_key_id'])
r = requests_retry_session().get(url, headers=self.specs['api_token'])
response = r.json()
# Store initial ssh_key state and percent values
ssh_key_state = response['state']
# Keep polling the ssh_key's status until good
while ssh_key_state not in self.good_states:
# Wait 15 seconds before polling again
time.sleep(interval)
# Check ssh_key status again
r = requests_retry_session().get(
url, headers=self.specs['api_token'])
response = r.json()
# Update ssh_key state and percent values
ssh_key_state = response['state']
# Check for timeout
seconds = (time.time() - start)
duration = seconds / 60
if duration > timeout:
print('The operation timed out after %s minutes.' % timeout)
return
return {'duration': duration}
|
1and1
|
/1and1-1.8.0.tar.gz/1and1-1.8.0/oneandone/client.py
|
client.py
|
Hello, ONE
----------
Usage
-----
`pip install 1app`
Then, simply use the command periodically:
`1app --params...`
This will save data to:
`settings.BASE_DIR/data/1app:default/Item`
N-Spacing
---------
If you want to seprate different sessions and sources, just use name param:
`1app --params... --name Username`
This will save to:
`settings.BASE_DIR/data/1app:Name/Type`
The `--name` value can be arbitray filesystem-compatible filename sub-string, so, you can use it to separate data by accounts, languages, or other features.
**NOTE**: Corresponding auth and session data will be stored in `settings.BASE_DIR/sessions` folder.
Saving to specific DIR
----------------------
Saving to custom folder simply pass `--path` parameter, like:
`1app --params --name Name --path /home/mindey/Desktop/mydata`
|
1app
|
/1app-0.0.2.tar.gz/1app-0.0.2/README.md
|
README.md
|
from setuptools import find_packages, setup
with open('README.md', 'r', encoding='utf-8') as f:
long_description = f.read()
setup(
name='1app',
version='0.0.2',
description='Simple data saver for App.',
long_description=long_description,
long_description_content_type='text/markdown',
url='https://github.com/0oio/1app',
author='Mindey',
author_email='[email protected]',
license='MIT',
packages = find_packages(exclude=['docs', 'tests*']),
install_requires=[
'metaform',
'metatype',
'typer',
],
extras_require = {
'test': ['coverage', 'pytest', 'pytest-cov'],
},
zip_safe=False,
entry_points = {
'console_scripts': [
'1app=1app.main:app'
],
}
)
|
1app
|
/1app-0.0.2.tar.gz/1app-0.0.2/setup.py
|
setup.py
|
from setuptools import setup
setup(
name="1assl",
version="0.0.0",
author='Thibaud Castaing',
author_email='[email protected]'
)
|
1assl
|
/1assl-0.0.0.tar.gz/1assl-0.0.0/empty_setup.py
|
empty_setup.py
|
#!/usr/bin/env python
import json
import jsonpath
import ruamel.yaml as yaml
with open('blueprint.json') as blueprint_file:
content = yaml.load(blueprint_file, Loader=yaml.Loader)
# print(json.dumps(content, indent=4))
node_selector_jsonpath = "?($.spec.template.spec.nodeSelector=={})"
# (@.type=='compute')
# "{'type': 'compute'}"
jsonpath_value = """$.spec.template.spec.volumes[?(@.name=='gmcdata')]'"""
# print(jsonpath.jsonpath(content, jsonpath_value))
# print()
print(jsonpath.jsonpath(content, node_selector_jsonpath))
|
1assl
|
/1assl-0.0.0.tar.gz/1assl-0.0.0/test/test_jsonpath.py
|
test_jsonpath.py
|
import pytest
from web.core import app
@pytest.fixture
async def client(aiohttp_client):
return await aiohttp_client(app)
|
1bead.org
|
/1bead.org-0.0.11.tar.gz/1bead.org-0.0.11/conftest.py
|
conftest.py
|
#!/usr/bin/env bash
wst test
set -ex
wst publish
ssh -T one-bead <<EOF
set -e
sudo su -
echo [ Show what\'s running ]
ps -eaf | grep web-app | grep -v grep
echo [ Updating 1bead.org ]
app update --wait 1bead.org
echo [ Stop apps ]
killall web-app
echo [ Wait a second to make sure apps are down ]
sleep 1
echo [ Show what\'s running ]
ps -eaf | grep web-app | grep -v grep
echo [ Start apps ]
web-app --port 80 &>/tmp/web-app.out &
echo [ Wait a second to make sure apps stay up ]
sleep 1
echo [ Show what\'s running ]
ps -eaf | grep web-app | grep -v grep
EOF
|
1bead.org
|
/1bead.org-0.0.11.tar.gz/1bead.org-0.0.11/publish-and-deploy.sh
|
publish-and-deploy.sh
|
aiohttp-devtools runserver web/core.py --host 0.0.0.0 --port 5000
|
1bead.org
|
/1bead.org-0.0.11.tar.gz/1bead.org-0.0.11/run-dev.sh
|
run-dev.sh
|
# 1bead.org
Web application for http://1bead.org
|
1bead.org
|
/1bead.org-0.0.11.tar.gz/1bead.org-0.0.11/README.md
|
README.md
|
import setuptools
setuptools.setup(
name='1bead.org',
version='0.0.11',
author='Max Zheng',
author_email='[email protected]',
description='Web application for 1bead.org',
long_description=open('README.md').read(),
url='https://github.com/maxzheng/1bead.org',
install_requires=open('requirements.txt').read(),
license='MIT',
packages=['web', 'static'],
include_package_data=True,
python_requires='>=3.6',
setup_requires=['setuptools-git', 'wheel'],
entry_points={
'console_scripts': [
'web-app = web.cli:main',
],
},
# Standard classifiers at https://pypi.org/classifiers/
classifiers=[
'Development Status :: 5 - Production/Stable',
'Intended Audience :: End Users/Desktop',
'Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Content Management System',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.6',
],
keywords='web appplication for 1bead.org to nurture the greatness of life',
)
|
1bead.org
|
/1bead.org-0.0.11.tar.gz/1bead.org-0.0.11/setup.py
|
setup.py
|
Version 0.0.11
================================================================================
* Fix screen scale for mobile
Version 0.0.10
--------------------------------------------------------------------------------
* Update title
Version 0.0.9
--------------------------------------------------------------------------------
* Use correct link for copyright
Version 0.0.8
--------------------------------------------------------------------------------
* Change name to 1 BEAD
Version 0.0.7
--------------------------------------------------------------------------------
* Add logo from Kate
Version 0.0.6
--------------------------------------------------------------------------------
* Switch to use React and Material-UI
* Run test before publishing
Version 0.0.5
--------------------------------------------------------------------------------
* Temporarily remove static as we do not have any
Version 0.0.4
--------------------------------------------------------------------------------
* Switch to use Jinja templates
* Add wait option when updating so it actually update
Non-tty does not update without an update frequency set or within frequency.
Version 0.0.3
--------------------------------------------------------------------------------
* Remove goal info
Version 0.0.2
--------------------------------------------------------------------------------
* Add first goal
Version 0.0.1
--------------------------------------------------------------------------------
* Add mission
* Initial setup
* Initial commit
|
1bead.org
|
/1bead.org-0.0.11.tar.gz/1bead.org-0.0.11/docs/CHANGELOG.rst
|
CHANGELOG.rst
|
async def test_index(client):
resp = await client.get('/')
assert resp.status == 200
text = await resp.text()
assert 'Greatness' in text
|
1bead.org
|
/1bead.org-0.0.11.tar.gz/1bead.org-0.0.11/tests/test_webapp.py
|
test_webapp.py
|
from aiohttp import web
from web.views import index
def setup_routes(app):
# app.router.add_static('/static', path=PROJECT_ROOT / 'static', name='static')
app.add_routes([web.get('/', index)])
|
1bead.org
|
/1bead.org-0.0.11.tar.gz/1bead.org-0.0.11/web/routes.py
|
routes.py
|
from pathlib import Path
PROJECT_ROOT = Path(__file__).parent.parent
|
1bead.org
|
/1bead.org-0.0.11.tar.gz/1bead.org-0.0.11/web/constants.py
|
constants.py
|
from aiohttp import web
import aiohttp_jinja2
import jinja2
from web.routes import setup_routes
from web.constants import PROJECT_ROOT
app = web.Application()
aiohttp_jinja2.setup(app, loader=jinja2.FileSystemLoader(str(PROJECT_ROOT / 'web' / 'templates')))
setup_routes(app)
|
1bead.org
|
/1bead.org-0.0.11.tar.gz/1bead.org-0.0.11/web/core.py
|
core.py
|
import aiohttp_jinja2
@aiohttp_jinja2.template('index.html')
async def index(request):
return {}
|
1bead.org
|
/1bead.org-0.0.11.tar.gz/1bead.org-0.0.11/web/views.py
|
views.py
|
from aiohttp import web
import click
from web.core import app
@click.command()
@click.option('--port', type=int, default=5000, help='Port to run app on')
def main(port):
web.run_app(app, port=port)
|
1bead.org
|
/1bead.org-0.0.11.tar.gz/1bead.org-0.0.11/web/cli.py
|
cli.py
|
<h1 align="center">
<br>
<a href="https://github.com/gopinath-langote/1build">
<img src="https://github.com/gopinath-langote/1build/blob/master/docs/assets/1build-logo.png?raw=true" alt="1build" width="500"></a>
<br>
</h1>
<br>
<p align="center">
<a href="https://pypi.org/project/1build/">
<img src="https://img.shields.io/pypi/v/1build.svg" alt="PyPi Version">
</a>
<a href="https://pypi.org/project/1build/">
<img src="https://img.shields.io/pypi/pyversions/1build.svg" alt="Supported Python Versions">
</a>
<a href="https://travis-ci.org/gopinath-langote/1build">
<img src="https://travis-ci.org/gopinath-langote/1build.svg?branch=master" alt="Build Status">
</a>
<a href="https://codecov.io/gh/gopinath-langote/1build">
<img src="https://img.shields.io/codecov/c/gh/gopinath-langote/1build.svg" alt="Code Coverage">
</a>
<a href="https://requires.io/github/gopinath-langote/1build/requirements/?branch=master">
<img src="https://requires.io/github/gopinath-langote/1build/requirements.svg?branch=master" alt="Requirements Status">
</a>
<a href="https://pypi.org/project/1build">
<img src="https://img.shields.io/pypi/dm/1build.svg" alt="Downloads">
</a>
</p>
<br>
1build is an automation tool that arms you with the convenience to configure project-local command line aliases – and then
run the commands quickly and easily. It is particularly helpful when you deal with multiple projects and switch between
them all the time. It is often the fact that different projects use different build tools and have different environment
requirements – and then switching from one project to another is becoming increasingly cumbersome. That is where 1build comes
into play.
With 1build you can create simple and easily memorable command aliases for commonly used project commands such as build,
test, run or anything else. These aliases will have a project-local scope which means that they will be accessible only
within the project directory. This way you can unify all your projects to build with the same simple command disregarding
of what build tool they use. It will remove the hassle of remembering all those commands improving the mental focus for
the things that actually matter.
## Install
```bash
pip install 1build
```
or
```bash
pip3 install 1build
```
## Usage
### Configuration
- create project configuration file in the project folder with name `1build.yaml`
- Example of `1build.yaml` for JVM maven project:
```yaml
project: Sample JVM Project Name
commands:
- build: mvn clean package
- lint: mvn antrun:run@ktlint-format
- test: mvn clean test
```
### Running 1build for the above sample project:
- building the project
```console
1build build
```
- fix the coding guidelinges lint and run tests (executing more than one commands at once)
```console
1build lint test
```
### Using `before` and `after` commands
Consider that your project `X` requires `Java 11` and the other project requires `Java 8`. It is a headache to always
remember to switch the java version. What you want is to switch to `Java 11` automatically when you build the project
`X` and switch it back to `Java 8` when the build is complete. Another example – a project requires `Docker` to be up
and running or you need to clean up the database after running a test harness.
This is where `before` & `after` commands are useful. These commands are both optional –
you can use one of them, both or neither.
#### Examples:
1. Switching to `Java 11` and then back to `Java 8`
```yaml
project: Sample JVM Project Name
before: ./switch_to_java_11.sh
after: ./switch_to_java_8.sh
commands:
- build: mvn clean package
```
2. Ensure that `Docker` is up and running
```yaml
project: Containerized Project
before: ./docker_run.sh
commands:
- build: ./gradlew clean
```
3. Clean up database after some commands
```yaml
project: Containerized Project
after: ./clean_database.sh
commands:
- build: ./gradlew clean
```
### Command usage
```text
usage: 1build [-h] [-l] [-v] [command]
positional arguments:
command Command to run - from `1build.yaml` file
optional arguments:
-h, --help Print this help message
-l, --list Show all available commands - from `1build.yaml` file
-v, --version Show version of 1build and exit
-i, --init Create default `1build.yaml` configuration file
```
## Contributing
Please read [CONTRIBUTING.md](https://github.com/gopinath-langote/1build/blob/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [Semantic Versioning](http://semver.org/) for all our releases. For the versions available, see the [tags on this repository](https://github.com/gopinath-langote/1build/tags).
## Changelog
All notable changes to this project in each release will be documented in [CHANGELOG.md](https://github.com/gopinath-langote/1build/blob/master/docs/CHANGELOG.md).
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
## Authors
* **Gopinath Langote** - *Initial work & Maintainer* – [Github](https://github.com/gopinath-langote/) –[Twitter](https://twitter.com/GopinathLangote)
* **Alexander Lukianchuk** - *Maintainer* – [Github](https://github.com/landpro) – [Twitter](https://twitter.com/landpro)
See also the list of [contributors](https://github.com/gopinath-langote/1build/contributors) who participated in this project.
|
1build
|
/1build-1.1.1.tar.gz/1build-1.1.1/README.md
|
README.md
|
import onebuild
import setuptools
VERSION = onebuild.__version__
with open("README.md", "r") as fh:
long_description = fh.read()
setuptools.setup(
name='1build',
version=VERSION,
scripts=['1build'],
license="MIT License",
author="Gopinath Langote",
install_requires=[
'ruamel.yaml>=0.15.97'
],
author_email="[email protected]",
description="Frictionless way of managing project-specific commands.",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/gopinath-langote/1build",
packages=['onebuild'],
classifiers=[
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"License :: OSI Approved :: MIT License",
"Topic :: Software Development :: Build Tools",
"Intended Audience :: Developers",
"Operating System :: OS Independent",
],
)
|
1build
|
/1build-1.1.1.tar.gz/1build-1.1.1/setup.py
|
setup.py
|
#!/usr/bin/env python
import sys
from .main import main
if __name__ == '__main__':
sys.exit(main())
|
1build
|
/1build-1.1.1.tar.gz/1build-1.1.1/onebuild/__main__.py
|
__main__.py
|
class PredefinedActions:
VERSION = "ONEBUILD_VERSION"
HELP = "ONEBUILD_HELP"
LIST = "ONEBUILD_LIST"
INIT = "ONEBUILD_INIT"
PERFORM = "ONEBUILD_PERFROM"
|
1build
|
/1build-1.1.1.tar.gz/1build-1.1.1/onebuild/predefined_actions.py
|
predefined_actions.py
|
import abc as abstract_class
class Command(metaclass=abstract_class.ABCMeta):
@abstract_class.abstractmethod
def execute(self, arg_parser, arguments, build_file_name, command_name):
pass
|
1build
|
/1build-1.1.1.tar.gz/1build-1.1.1/onebuild/command.py
|
command.py
|
#!/usr/bin/env python
import sys
from onebuild.action_to_command_lookup import ActionToCommandLookup
from .input_parser import command_to_run, argument_parser
BUILD_FILE_NAME = "1build.yaml"
def run(build_file_name, arguments):
try:
arg_parser = argument_parser()
command_name = command_to_run(arg_parser, arguments)
ActionToCommandLookup() \
.get_command_for_action(command_name) \
.execute(arg_parser, arguments, build_file_name, command_name)
except ValueError as error:
print(error)
def main():
run(BUILD_FILE_NAME, sys.argv[1:])
|
1build
|
/1build-1.1.1.tar.gz/1build-1.1.1/onebuild/main.py
|
main.py
|
from onebuild.predefined_actions import PredefinedActions
from onebuild.help_command import HelpCommand
from onebuild.init_command import InitCommand
from onebuild.list_command import ListCommand
from onebuild.perform_command import PerformCommand
from onebuild.version_command import VersionCommand
class ActionToCommandLookup:
def __init__(self):
self._command_to_action_dictionary = dict({
PredefinedActions.HELP: HelpCommand(),
PredefinedActions.INIT: InitCommand(),
PredefinedActions.LIST: ListCommand(),
PredefinedActions.VERSION: VersionCommand(),
PredefinedActions.PERFORM: PerformCommand()
})
def get_command_for_action(self, action):
return self._command_to_action_dictionary.get(action, PerformCommand())
|
1build
|
/1build-1.1.1.tar.gz/1build-1.1.1/onebuild/action_to_command_lookup.py
|
action_to_command_lookup.py
|
def write(file_name, mode, content):
with open(file_name, mode) as h:
h.write(content)
h.close()
|
1build
|
/1build-1.1.1.tar.gz/1build-1.1.1/onebuild/file_writer.py
|
file_writer.py
|
from onebuild.command import Command
from onebuild.config_parser import parse_project_config
from onebuild.utils import config_string
class ListCommand(Command):
def execute(self, arg_parser, arguments, build_file_name, command_name):
project = parse_project_config(build_file_name)
print(config_string(project))
|
1build
|
/1build-1.1.1.tar.gz/1build-1.1.1/onebuild/list_command.py
|
list_command.py
|
# !/usr/bin/env python
DASH = '-' * 50
NEWLINE = "\n"
def sample_yaml_file():
return "project: Sample Project" + "\n" + \
"commands:" + "\n" + \
" - build: ./gradlew clean build" + "\n" + \
" - lint: ./gradlew spotlessApply"
def config_string(project):
return "" + DASH + NEWLINE + project.__str__() + NEWLINE + DASH
|
1build
|
/1build-1.1.1.tar.gz/1build-1.1.1/onebuild/utils.py
|
utils.py
|
#!/usr/bin/env python
import os
from ruamel.yaml import YAML
from .project import Command, Project
from .utils import DASH, sample_yaml_file
def parse_project_config(build_file_name):
if os.path.exists(build_file_name):
with open(build_file_name, 'r') as stream:
try:
yaml = YAML(typ="safe")
content = yaml.load(stream)
before = content.get("before", None)
after = content.get("after", None)
return Project(
name=(content["project"]),
before=before,
after=after,
commands=__command_list__(content["commands"])
)
except Exception:
raise ValueError(__parsing_error_message__(build_file_name))
else:
raise ValueError(__file_not_found_error_message__(build_file_name))
def __command_list__(raw_string):
commands = []
for cmd in raw_string:
for key, val in cmd.items():
commands.append(Command(name=key, cmd=val))
return commands
def __file_not_found_error_message__(build_file_name):
return "No '" + build_file_name + "' file found in current directory."
def __parsing_error_message__(build_file_name):
return "Error in parsing '" + build_file_name + "' config file." + \
" Make sure file is in correct format." + \
"\nSample format is:\n\n" + DASH + "\n" + sample_yaml_file() + \
"\n" + DASH + "\n"
|
1build
|
/1build-1.1.1.tar.gz/1build-1.1.1/onebuild/config_parser.py
|
config_parser.py
|
# !/usr/bin/env python
from .utils import config_string
class Command:
def __init__(self, name, cmd):
self.name = name
self.cmd = cmd
def __str__(self):
return self.name + " | " + self.cmd
class Project:
def __init__(self, name, before, after, commands):
self.name = name
self.before = before
self.after = after
self.commands = commands
def get_command(self, command_name):
if self.__has_command__(command_name):
for cmd in self.commands:
if cmd.name == command_name:
return cmd
else:
raise ValueError(
"No command '" + command_name + "' found in config file" +
"\n\n" + config_string(self)
)
def __has_command__(self, command_name):
for cmd in self.commands:
if cmd.name == command_name:
return True
return False
def available_commands(self):
return "\n".join(map(str, self.commands))
def __str__(self):
return "project: " + self.name + "\ncommands:\n" + \
self.available_commands()
|
1build
|
/1build-1.1.1.tar.gz/1build-1.1.1/onebuild/project.py
|
project.py
|
from onebuild.command import Command
class HelpCommand(Command):
def execute(self, arg_parser, arguments, build_file_name, command_name):
arg_parser.print_help()
|
1build
|
/1build-1.1.1.tar.gz/1build-1.1.1/onebuild/help_command.py
|
help_command.py
|
#!/usr/bin/env python
import argparse
from onebuild.predefined_actions import PredefinedActions
def argument_parser():
parser = argparse.ArgumentParser(prog='1build', add_help=False)
parser.add_argument(
'command',
nargs='*',
help='Command(s) to run - from `1build.yaml` file',
)
parser.add_argument(
'-h', '--help',
action='store_true',
default=False,
help="Print this help message"
)
parser.add_argument(
'-l', '--list',
action='store_true',
default=False,
help="Show all available commands - from `1build.yaml` file"
)
parser.add_argument(
'-v', '--version',
dest='version',
action='store_true',
default=False,
help="Show version of 1build and exit"
)
parser.add_argument(
'-i', '--init',
action='store_true',
default=False,
help="Create default `1build.yaml` configuration file"
)
return parser
def command_to_run(arg_parser, arguments):
args = arg_parser.parse_args(args=arguments)
if args.help:
return PredefinedActions.HELP
if args.version:
return PredefinedActions.VERSION
if args.init:
return PredefinedActions.INIT
if args.list:
return PredefinedActions.LIST
if len(args.command) == 0:
return PredefinedActions.HELP
return PredefinedActions.PERFORM
|
1build
|
/1build-1.1.1.tar.gz/1build-1.1.1/onebuild/input_parser.py
|
input_parser.py
|
"""
1build - Frictionless way of managing project-specific commands.
"""
__author__ = 'Gopinath Langote'
# New release version will be updated here
# e.g. 1)for dev -> __version__ = '1.0.dev0'
# 2)for release -> __version__ = '1.0.1'
# this will automatically update setup.py version to latest release version.
__version__ = '1.1.1'
|
1build
|
/1build-1.1.1.tar.gz/1build-1.1.1/onebuild/__init__.py
|
__init__.py
|
import os
from onebuild.command import Command
from onebuild.file_writer import write
def default_yaml_file(project_name):
return "project: " + project_name + "\n" + \
"commands:" + "\n" + \
" - build: echo 'Running build'"
class InitCommand(Command):
def execute(self, arg_parser, arguments, build_file_name, command_name):
if len(arguments) < 2:
print(__project_name_not_found_error_message__())
elif os.path.isfile("1build.yaml"):
print(__file_already_exists_message__())
else:
write("1build.yaml", "w", default_yaml_file(arguments[1]))
def __project_name_not_found_error_message__():
return "The 'project name' parameter is missing with --init" \
"\n\nusage: 1build --init project_name"
def __file_already_exists_message__():
return "1build.yaml configuration file already exists."
|
1build
|
/1build-1.1.1.tar.gz/1build-1.1.1/onebuild/init_command.py
|
init_command.py
|
from onebuild import __version__
from onebuild.command import Command
class VersionCommand(Command):
def execute(self, arg_parser, arguments, build_file_name, command_name):
version = '1build {version} '.format(version=__version__)
print(version)
|
1build
|
/1build-1.1.1.tar.gz/1build-1.1.1/onebuild/version_command.py
|
version_command.py
|
import os
from onebuild.command import Command
from onebuild.config_parser import parse_project_config
from onebuild.utils import DASH
class PerformCommand(Command):
def execute(self, arg_parser, arguments, build_file_name, command_name):
project = parse_project_config(build_file_name)
args = arg_parser.parse_args(args=arguments)
for cmd in args.command:
self.__execute_command__(project, cmd)
@staticmethod
def __execute_command__(project, command_name):
command = project.get_command(command_name)
cmd = command.cmd
print(DASH + "\nName: " + command.name +
"\nCommand: " + command.cmd)
before = project.before
after = project.after
if before:
print("Before: " + before)
cmd = before + " && " + cmd
if after:
print("After: " + after)
cmd = cmd + " && " + after
print(DASH)
os.system(cmd)
|
1build
|
/1build-1.1.1.tar.gz/1build-1.1.1/onebuild/perform_command.py
|
perform_command.py
|
# 1c_format
Python парсер для банковских выписок в формате 1С.
|
1c-format
|
/1c_format-0.1.tar.gz/1c_format-0.1/README.md
|
README.md
|
from setuptools import setup, find_packages
from os.path import join, dirname
AUTHOR = "Maxim Prokopenko"
AUTHOR_EMAIL = "[email protected]"
NAME = "1c_format"
PACKAGE = '1c_format'
VERSION = '0.1'
URL = 'https://github.com/maximprokopenko/1c_format'
setup(
name=NAME,
packages=[PACKAGE],
version=VERSION,
long_description=open(join(dirname(__file__), 'README.md')).read(),
author=AUTHOR,
author_email=AUTHOR_EMAIL,
url=URL,
install_requires=[]
)
|
1c-format
|
/1c_format-0.1.tar.gz/1c_format-0.1/setup.py
|
setup.py
|
import yaml
def parse(file_path):
trash_string = ('1CClientBankExchange', 'КонецФайла')
content = []
indent_count = 0
with open(file_path) as f:
lines = f.readlines()
for line in lines:
if [t for t in trash_string if t in line]:
continue
line = line.replace('=', ': ')
if 'Секция' in line:
if ':' in line:
name, value = line.split(': ')
line = name + ':\n'
if line not in content:
content.append(' ' * indent_count + line)
line = ' ' * (indent_count) + '- ' + value.replace('\n', ':\n')
else:
line = line.replace('\n', ': \n')
content.append(' ' * indent_count + line)
indent_count += 1
elif 'Конец' in line:
indent_count -= 1
else:
content.append(' ' * indent_count + line)
content_as_str = ''.join(content)
return yaml.load(content_as_str, Loader=yaml.FullLoader)
|
1c-format
|
/1c_format-0.1.tar.gz/1c_format-0.1/1c_format/__init__.py
|
__init__.py
|
1C Utils
=========
**1C Utils** это набор скриптов для управления и обслуживания серверов 1С.
Репозиторий:
https://gitlab.com/onegreyonewhite/1c-utilites
Для вопросов и предложений используйте трекер задач:
https://gitlab.com/onegreyonewhite/1c-utilites/issues
Возможности
--------
На данный момент поддерживается только архивация PostgreSQL и файловых БД 1С.
Quickstart
----------
Поддерживается любая Linux-система с наличием в ней Python 2.7/3.4/3.5
и необходимых утилит обслуживания:
* pg_dump для архивации PostgreSQL баз
* tar для упаковывания файловых баз
Установка:
.. sourcecode:: bash
pip install 1c-utilites
1c-utilites --help
|
1c-utilites
|
/1c-utilites-0.1b0.tar.gz/1c-utilites-0.1b0/README.rst
|
README.rst
|
import os
from setuptools import find_packages, setup
from utilites_1c import __version__ as prog_version
RMF = os.path.join(os.path.dirname(__file__), 'README.rst')
with open(RMF) as readme:
README = readme.read()
def load_requirements(file_name):
with open(os.path.join(os.path.dirname(__file__), file_name)) as req_file:
return req_file.read().strip().split('\n')
REQUIRES = load_requirements('requirements.txt')
setup(
name='1c-utilites',
version=prog_version,
packages=find_packages(),
url='',
license='AGPL+',
author='Sergey Klyukov',
author_email='[email protected]',
description='Utilites for maintenance 1C services',
long_description=README,
classifiers=[
'Operating System :: OS Independent',
'Programming Language :: Python',
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Topic :: Utilities',
],
entry_points={
'console_scripts': ['1c-utilites=utilites_1c.manager:main'],
},
install_requires=[
] + REQUIRES,
)
|
1c-utilites
|
/1c-utilites-0.1b0.tar.gz/1c-utilites-0.1b0/setup.py
|
setup.py
|
from .manager import main
main()
|
1c-utilites
|
/1c-utilites-0.1b0.tar.gz/1c-utilites-0.1b0/utilites_1c/__main__.py
|
__main__.py
|
BACKUP_BACKENDS = {
"Postgres": {
"BACKEND": "utilites_1c.backup.postgres.BackupBackendPostgres"
},
"File": {
"BACKEND": "utilites_1c.backup.file.BackupBackendFile"
}
}
|
1c-utilites
|
/1c-utilites-0.1b0.tar.gz/1c-utilites-0.1b0/utilites_1c/settings.py
|
settings.py
|
def import_class(path):
'''
Get class from string-path
:param path: -- string containing full python-path
:type path: str
:return: -- return class or module in path
:rtype: class, module, object
'''
m_len = path.rfind(".")
class_name = path[m_len + 1:len(path)]
try:
module = __import__(path[0:m_len], globals(), locals(), [class_name])
return getattr(module, class_name)
except SystemExit:
return None # nocv
class BackendLoader(object):
BACKENDS = None
def get_backends_dict(self):
return self.BACKENDS
@property
def backends(self):
return self.get_backends_dict()
def list(self):
return sorted(self.backends.keys())
def get(self, name):
# pylint: disable=unsubscriptable-object
return import_class(self.backends[name]["BACKEND"])
def add_arguments(self, parser):
pass
def run(self, args):
return self.get(args.backend)(args)
|
1c-utilites
|
/1c-utilites-0.1b0.tar.gz/1c-utilites-0.1b0/utilites_1c/utils.py
|
utils.py
|
from argparse import ArgumentParser
from .utils import import_class
from . import __version__
class Main(object):
def __init__(self):
self.parsers = dict()
self.parser = ArgumentParser(
description='1C %(prog)s script.', prog="Utilites"
)
self.subparsers = self.parser.add_subparsers(
help="Help for commands"
)
self._create_command("backup", "Backup/Restore utility")
def _create_command(self, name, help):
loader = self.get_loader(name)
parser = self.subparsers.add_parser(
name, help=help
)
parser.add_argument(
"-b", "--backend", help="Utility-command backend",
choices=loader.list()
)
parser.add_argument(
"-v", "--version", help="1C %(prog)s script version.",
default=False, action="store_true"
)
loader.add_arguments(parser)
parser.set_defaults(command=name)
self.parsers[name] = parser
return parser
def get_loader(self, name):
return import_class("utilites_1c.{}.backends.Loader".format(name))()
def __call__(self):
args = self.parser.parse_args()
if args.version:
print(__version__)
return
try:
command = args.command
return self.get_loader(command).run(args)
except AttributeError:
self.parser.print_help()
main = Main()
|
1c-utilites
|
/1c-utilites-0.1b0.tar.gz/1c-utilites-0.1b0/utilites_1c/manager.py
|
manager.py
|
__version__ = '0.1b'
|
1c-utilites
|
/1c-utilites-0.1b0.tar.gz/1c-utilites-0.1b0/utilites_1c/__init__.py
|
__init__.py
|
# =*= coding: utf-8 =*=
from __future__ import unicode_literals
import os
from .base import BaseBackupBackend
class BackupBackendFile(BaseBackupBackend):
def _check_base(self, base_path):
files_in_base = os.listdir(base_path)
for file in files_in_base:
if ".1CD" in file:
return
raise Exception("Dir without database (*.1CD) file")
def _generate_backup_string(self):
base_path = self.config.get("file", "base_path", fallback="")
self._check_base(base_path)
op_string = "tar -zcvf"
op_string += " " + self.file_name
op_string += " " + base_path
return op_string
|
1c-utilites
|
/1c-utilites-0.1b0.tar.gz/1c-utilites-0.1b0/utilites_1c/backup/file.py
|
file.py
|
# =*= coding: utf-8 =*=
from __future__ import unicode_literals
import os
import sys
import time
import logging
import subprocess
from configparser import ConfigParser
logging.basicConfig(
format='%(asctime)s - %(levelname)s - %(message)s',
datefmt='%m/%d/%Y %H:%M:%S',
level=logging.DEBUG
)
class BaseBackupBackend(object):
DEFAULT_NAME_MASK = '1c-backup'
def __init__(self, args):
self.args = args
self.config = self.get_config(self.args.config)
self.backups_dir = self.config.get(
"main", "backups_dir", fallback="/tmp/"
) + "/"
self.backups_files = self.config.getint("main", "last", fallback=5)
@property
def file_name(self):
file_name = self.backups_dir
file_name += "{}-{}.gz".format(
self.DEFAULT_NAME_MASK, int(time.time())
)
return file_name
def get_config(self, config_name='/etc/1c/backup.ini'):
config = ConfigParser()
logging.debug("Read config " + config_name)
config.read([config_name])
return config
def get_backups_list(self):
return sorted([
f for f in os.listdir(self.backups_dir)
if self.DEFAULT_NAME_MASK in f and f[-3:] == '.gz'
])
def remove_older(self):
counter = 0
for file in reversed(self.get_backups_list()):
if counter >= self.backups_files:
logging.info("Removed: {}".format(self.backups_dir + file))
os.remove(self.backups_dir + file)
counter += 1
def execute(self, execute_string):
return subprocess.check_output(
["bash", "-c", execute_string], stderr=subprocess.STDOUT
)
def backup_operation(self):
execute_string = self._generate_backup_string()
logging.info("Executes: " + execute_string)
self.execute(execute_string)
self.remove_older()
def backup(self):
try:
self.backup_operation()
logging.debug("Current backups = " + str(self.get_backups_list()))
except subprocess.CalledProcessError as err:
logging.error("Code: {} - {}".format(err.returncode, err.output))
sys.exit(-1)
except Exception as err:
logging.critical(err)
sys.exit(-1)
def _generate_backup_string(self):
raise NotImplementedError
|
1c-utilites
|
/1c-utilites-0.1b0.tar.gz/1c-utilites-0.1b0/utilites_1c/backup/base.py
|
base.py
|
# =*= coding: utf-8 =*=
from __future__ import unicode_literals
import gzip
from .base import BaseBackupBackend, os
class BackupBackendPostgres(BaseBackupBackend):
CONFIG_PARAMS = {
"-h": "host",
"-p": "port",
"-d": "db",
"-P": "password",
"-U": "user"
}
def _format_op_sting(self, op_string, key, name):
if self.config.get("postgres", name, fallback=""):
if name == "password":
os.putenv("PGPASSWORD", self.config.get("postgres", name))
elif name == "db":
op_string += ' "{}"'.format(self.config.get("postgres", name))
else:
op_string += " {} {}".format(
key, self.config.get("postgres", name)
)
return op_string
def _generate_backup_string(self):
op_string = "pg_dump"
for param, name in self.CONFIG_PARAMS.items():
op_string = self._format_op_sting(op_string, param, name)
op_string += " -F c -b "
return op_string
def archive_backup(self, output):
with gzip.open(self.file_name, "w") as file:
file.write(output)
def execute(self, execute_string):
output = super(BackupBackendPostgres, self).execute(execute_string)
self.archive_backup(output)
|
1c-utilites
|
/1c-utilites-0.1b0.tar.gz/1c-utilites-0.1b0/utilites_1c/backup/postgres.py
|
postgres.py
|
# =*= coding: utf-8 =*=
from ..settings import BACKUP_BACKENDS
from ..utils import BackendLoader
class Loader(BackendLoader):
BACKENDS = BACKUP_BACKENDS
def add_arguments(self, parser):
super(Loader, self).add_arguments(parser)
parser.add_argument(
'-c', '--config',
help='Config for %(prog)s. Default:[%(default)s]',
type=str,
action="store",
default="/etc/1c/backup.ini",
)
return parser
def run(self, args):
backend = super(Loader, self).run(args)
backend.backup()
|
1c-utilites
|
/1c-utilites-0.1b0.tar.gz/1c-utilites-0.1b0/utilites_1c/backup/backends.py
|
backends.py
|
# 1D3 payment page SDK
This is a set of libraries in the Python language to ease integration of your service
with the 1D3 Payment Page.
Please note that for correct SDK operating you must have at least Python 3.5.
## Payment flow
## Installation
Install with pip
```bash
pip install 1d3-sdk
```
### Get URL for payment
```python
from payment_page_sdk.gate import Gate
from payment_page_sdk.payment import Payment
gate = Gate('secret')
payment = Payment('402')
payment.payment_id = 'some payment id'
payment.payment_amount = 1001
payment.payment_currency = 'USD'
payment_url = gate.get_purchase_payment_page_url(payment)
```
`payment_url` here is the signed URL.
### Handle callback from 1D3
You'll need to autoload this code in order to handle notifications:
```python
from payment_page_sdk.gate import Gate
gate = Gate('secret')
callback = gate.handle_callback(data)
```
`data` is the JSON data received from payment system;
`callback` is the Callback object describing properties received from payment system;
`callback` implements these methods:
1. `callback.get_payment_status()`
Get payment status.
2. `callback.get_payment()`
Get all payment data.
3. `callback.get_payment_id()`
Get payment ID in your system.
|
1d3-sdk
|
/1d3-sdk-1.0.3.tar.gz/1d3-sdk-1.0.3/README.md
|
README.md
|
import pathlib
from setuptools import setup, find_packages
HERE = pathlib.Path(__file__).parent
README = (HERE / "README.md").read_text()
setup(
name='1d3-sdk',
version='1.0.3',
url='https://github.com/dev1d3/paymentpage-sdk-python',
license='MIT',
long_description=README,
long_description_content_type="text/markdown",
packages=find_packages(exclude=['tests', 'tests.*']),
classifiers=[
'Development Status :: 3 - Alpha',
'Intended Audience :: Developers',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Topic :: Software Development :: Libraries :: Python Modules',
],
)
|
1d3-sdk
|
/1d3-sdk-1.0.3.tar.gz/1d3-sdk-1.0.3/setup.py
|
setup.py
|
class ProcessException(Exception):
"""Payment process exception"""
|
1d3-sdk
|
/1d3-sdk-1.0.3.tar.gz/1d3-sdk-1.0.3/payment_page_sdk/process_exception.py
|
process_exception.py
|
import urllib.parse
from payment_page_sdk.signature_handler import SignatureHandler
from payment_page_sdk.payment import Payment
class PaymentPage(object):
"""Class PaymentPage for URL building
Attributes:
__baseUrl - Base URL for payment
__signatureHandler - Signature Handler (check, sign)
"""
__baseUrl = 'https://checkout.1d3.com/payment'
__signatureHandler = None
def __init__(self, signature_handler: SignatureHandler, base_url: str = ''):
"""
PaymentPage constructor
:param signature_handler:
:param base_url:
"""
self.__signatureHandler = signature_handler
if base_url:
self.__baseUrl = base_url
def get_url(self, payment: Payment) -> str:
"""
Get full URL for payment
:param Payment payment:
:return:
"""
return self.__baseUrl + '?' \
+ urllib.parse.urlencode(payment.get_params()) \
+ '&signature=' + urllib.parse.quote_plus(self.__signatureHandler.sign(payment.get_params()))
|
1d3-sdk
|
/1d3-sdk-1.0.3.tar.gz/1d3-sdk-1.0.3/payment_page_sdk/payment_page.py
|
payment_page.py
|
from payment_page_sdk.signature_handler import SignatureHandler
from payment_page_sdk.payment_page import PaymentPage
from payment_page_sdk.callback import Callback
from payment_page_sdk.payment import Payment
class Gate(object):
"""Class Gate
Attributes:
CURRENCY_RUB - Currency RUB
CURRENCY_USD - Currency USD
CURRENCY_EUR - Currency EUR
__paymentPageUrlBuilder - Builder for Payment page
__signatureHandler - Signature Handler (check, sign)
"""
CURRENCY_RUB = 'RUB'
CURRENCY_USD = 'USD'
CURRENCY_EUR = 'EUR'
__paymentPageUrlBuilder = None
__signatureHandler = None
def __init__(self, secret: str, base_url: str = ''):
"""
Gate constructor
:param str secret: Secret key
"""
self.__signatureHandler = SignatureHandler(secret)
self.__paymentPageUrlBuilder = PaymentPage(self.__signatureHandler, base_url)
def get_purchase_payment_page_url(self, payment: Payment) -> str:
"""
Get URL for purchase payment page
:param Payment payment:
:return:
"""
return self.__paymentPageUrlBuilder.get_url(payment)
def handle_callback(self, data):
"""
Callback handler
:param data:
:return:
"""
return Callback(data, self.__signatureHandler)
|
1d3-sdk
|
/1d3-sdk-1.0.3.tar.gz/1d3-sdk-1.0.3/payment_page_sdk/gate.py
|
gate.py
|
from payment_page_sdk.signature_handler import SignatureHandler
from payment_page_sdk.process_exception import ProcessException
import json
import copy
class Callback(object):
"""Class for processing gate callback
Attributes:
SUCCESS_STATUS - Status of successful payment
DECLINE_STATUS - Status of rejected payment
AW_3DS_STATUS - Status of awaiting a request with the result of a 3-D Secure Verification
AW_RED_STATUS - Status of awaiting customer return after redirecting the customer to an external provider system
AW_CUS_STATUS - Status of awaiting customer actions, if the customer may perform additional attempts to make a
payment
AW_CLA_STATUS - Status of awaiting additional parameters
AW_CAP_STATUS - Status of awaiting request for withdrawal of funds (capture) or cancellation of payment (cancel)
from your project
CANCELLED_STATUS - Status of holding of funds (produced on authorization request) is cancelled
REFUNDED_STATUS - Status of successfully completed the full refund after a successful payment
PART_REFUNDED_STATUS - Status of completed partial refund after a successful payment
PROCESSING_STATUS - Status of payment processing at Gate
ERROR_STATUS - Status of an error occurred while reviewing data for payment processing
REVERSED_STATUS - Status of refund after a successful payment before closing of the business day
__data - Callback data as dict
__signatureHandler - SignatureHandler instance
"""
SUCCESS_STATUS = 'success'
DECLINE_STATUS = 'decline'
AW_3DS_STATUS = 'awaiting 3ds result'
AW_RED_STATUS = 'awaiting redirect result'
AW_CUS_STATUS = 'awaiting customer'
AW_CLA_STATUS = 'awaiting clarification'
AW_CAP_STATUS = 'awaiting capture'
CANCELLED_STATUS = 'cancelled'
REFUNDED_STATUS = 'refunded'
PART_REFUNDED_STATUS = 'partially refunded'
PROCESSING_STATUS = 'processing'
ERROR_STATUS = 'error'
REVERSED_STATUS = 'reversed'
__data = None
__signatureHandler = None
def __init__(self, data: str, signature_handler: SignatureHandler):
"""
Callback constructor
:param dict data:
:param SignatureHandler signature_handler:
"""
self.__data = self.decode_response(data)
self.__signatureHandler = signature_handler
if self.check_signature() == 0:
raise ProcessException('Signature ' + self.get_signature() + ' is invalid')
def get_payment(self):
"""
Get payment info
:return: mixed
"""
return self.get_value('payment')
def get_payment_status(self) -> str:
"""
Get payment status
:return: str
"""
return self.get_value('payment.status')
def get_payment_id(self) -> str:
"""
Get payment ID
:return: str
"""
return self.get_value('payment.id')
def get_signature(self) -> str:
"""
Get signature
:return: str
"""
sign_paths = ['signature', 'general.signature']
for sign_path in sign_paths:
sign = self.get_value(sign_path)
if sign is not None:
return sign
raise ProcessException('Signature undefined')
def decode_response(self, raw_data: str) -> dict:
"""
Cast raw data to array
:param str raw_data:
:return: dict
:raise: ProcessException
"""
try:
data = json.loads(raw_data)
except ValueError:
raise ProcessException('Error on response decoding')
return data
def check_signature(self) -> bool:
"""
Check signature
:return: bool
"""
data = copy.deepcopy(self.__data)
signature = self.get_signature()
self.__remove_param('signature', data)
return self.__signatureHandler.check(data, signature)
def get_value(self, pathname: str):
"""
Get value by pathname
:param str pathname:
:return: mixed
"""
keys = pathname.split('.')
cb_data = self.__data
for key in keys:
if key in cb_data and not isinstance(cb_data, str):
cb_data = cb_data[key]
else:
return None
return cb_data
def __remove_param(self, name: str, data: dict):
"""
Unset param at callback data
:param str name:
:param dict data:
:return: void
"""
if name in data:
del data[name]
for key in data:
if isinstance(data[key], dict):
self.__remove_param(name, data[key])
|
1d3-sdk
|
/1d3-sdk-1.0.3.tar.gz/1d3-sdk-1.0.3/payment_page_sdk/callback.py
|
callback.py
|
import base64
import hmac
from collections import OrderedDict
class SignatureHandler(object):
"""Class SignatureHandler
Attributes:
ITEMS_DELIMITER - signature concatenation delimiter
IGNORE_KEYS - ignore keys in signature
__secretKey - Secret key
"""
ITEMS_DELIMITER = ';'
IGNORE_KEYS = ['frame_mode']
__secretKey = None
def __init__(self, secret_key: str):
"""
SignatureHandler constructor
:param str secret_key:
"""
self.__secretKey = secret_key
def check(self, params: dict, signature):
"""
Check signature
:param dict params:
:param signature:
:return:
"""
return self.sign(params) == signature
def sign(self, params: dict) -> str:
"""
Return signature
:param params:
:return:
"""
secret_key = self.__secretKey.encode('utf-8')
params_to_sign = self.__get_params_to_sign(params, self.IGNORE_KEYS)
params_to_sign_list = list(OrderedDict(sorted(params_to_sign.items(), key=lambda t: t[0])).values())
string_to_sign = self.ITEMS_DELIMITER.join(params_to_sign_list).encode('utf-8')
return base64.b64encode(hmac.new(secret_key, string_to_sign, hmac._hashlib.sha512).digest()).decode()
def __get_params_to_sign(self, params: dict, ignore=None, prefix='', sort=True) -> dict:
"""
Get parameters to sign
:param params:
:param ignore:
:param prefix:
:param sort:
:return:
"""
if ignore is None:
ignore = []
params_to_sign = {}
for key in params:
if key in ignore:
continue
param_key = prefix + (':' if prefix else '') + key
value = params[key]
if isinstance(value, list):
value = {str(key): value for key, value in enumerate(value)}
if isinstance(value, dict):
sub_array = self.__get_params_to_sign(value, ignore, param_key, False)
params_to_sign.update(sub_array)
else:
if isinstance(value, bool):
value = '1' if value else '0'
elif value is None:
value = ''
else:
value = str(value)
params_to_sign[param_key] = param_key + ':' + value
if sort:
sorted(params_to_sign.items(), key=lambda item: item[0])
return params_to_sign
|
1d3-sdk
|
/1d3-sdk-1.0.3.tar.gz/1d3-sdk-1.0.3/payment_page_sdk/signature_handler.py
|
signature_handler.py
|
from collections.abc import Iterable
import json
class Payment(object):
"""Class Payment
Attributes:
str account_token: The token of the bank card that will be used to perform a payment
str card_operation_type: Type of payment performed via payment card
datetime best_before: Date and time when the payment period expires.
bool close_on_missclick: A parameter that specifies the action of the widget (opened in the modal window) when a customer clicks outside the widget area.
str css_modal_wrap: An additional CSS class for a modal window.
str customer_id: Unique ID of the customer in your project
bool force_acs_new_window: The forced display mode with the ACS page opening in a window despite the settings in Payment Page
str force_payment_method: The ID of the payment provider that is opened to customers by default.
str language_code: The language in which the payment page will be opened to the customer in ISO 639-1 alpha-2 format.
str list_payment_block: The payment block on the list of payment methods.
str merchant_fail_url: The URL of the page in your project to which a customer is returned after a failed payment.
str merchant_success_url: The URL of the page in your project to which a customer is returned after a successful payment.
str mode: Payment Page mode.
int payment_amount: Payment amount specified in minor units of the currency of the payment
str payment_currency: Payment currency in ISO 4217 alpha-3 format
str payment_description: Payment description
str payment_id: Unique ID of the payment in your project
bool recurring_register: Parameter that indicates whether this payment should be registered as recurring
str customer_first_name: Customer first name
str customer_last_name: Customer last name
str customer_phone: Customer phone number. Must have from 4 to 24 digits
str customer_email: Customer e-mail
str customer_country: Country of the customer address, in ISO 3166-1 alpha-2 format
str customer_state: State or region of the customer address
str customer_city: City of the customer address
str customer_day_of_birth: Customer birth date, DD-MM-YYYY
int customer_ssn: The last 4 digits of the social security number of US
str billing_postal: The postal code of the customer billing address
str billing_country: The country of the customer billing address, in ISO 3166-1 alpha-2 format
str billing_region: The region or state of the customer billing address
str billing_city: The city of the customer billing address
str billing_address: The street of the customer billing address
bool redirect: A parameter that enables opening of the generated payment page in a separate tab
str redirect_fail_mode: The mode for customer redirection when the payment failed
str redirect_fail_url: The URL of the page in your project to which the customer is redirected when the payment failed
bool redirect_on_mobile: A parameter that enables opening of the generated payment page in a separate tab on mobile devices only
str redirect_success_mode: The mode for customer redirection after a successful payment.
str redirect_success_url: The URL of the page in your project to which the customer is redirected after a successful payment
str redirect_tokenize_mode: The mode for customer redirection once a token is generated.
str redirect_tokenize_url: The URL of the page in your project to which the customer is redirected after a successful token generation.
str region_code: The region in ISO 3166-1 alpha-2 format. By default the region is determined by the IP address of the customer
str target_element: The element in which the iframe of the payment page is embedded in the web page of your project.
int terminal_id: Unique ID of the Payment Page template which you want to run despite the regional and A/B test settings
str baseurl: Basic Payment Page address that is used in case the Payment Page domain differs from the domain used to connect libraries or if merchant.js is not connected via the <script> tag
str payment_extra_param: Additional parameter to be forwarded to Gate
PURCHASE_TYPE - Payment from customer account
PAYOUT_TYPE - Payment to customer account
RECURRING_TYPE - Recurring payment
"""
PURCHASE_TYPE = 'purchase'
PAYOUT_TYPE = 'payout'
RECURRING_TYPE = 'recurring'
INTERFACE_TYPE = 24
def __init__(self, project_id: str, payment_id: str = ''):
"""
Payment constructor
:param project_id: str
"""
self.__dict__['project_id'] = project_id
self.__dict__['interface_type'] = json.dumps({'id': self.INTERFACE_TYPE})
if payment_id:
self.__dict__['payment_id'] = payment_id
def get_params(self) -> dict:
"""
Get payment parameters
:return: dict
"""
return self.__dict__
def __setattr__(self, name, value):
if name == 'best_before':
value = value.isoformat()
self.__dict__[name] = value
|
1d3-sdk
|
/1d3-sdk-1.0.3.tar.gz/1d3-sdk-1.0.3/payment_page_sdk/payment.py
|
payment.py
|
from setuptools import setup
setup(name='1distro',
version='0.1',
description='Gaussian distributions',
packages=['1distro'],
zip_safe=False)
|
1distro
|
/1distro-0.1.tar.gz/1distro-0.1/setup.py
|
setup.py
|
test_variable = 100
|
1dyfolabs-test-script
|
/1dyfolabs-test-script-0.3.tar.gz/1dyfolabs-test-script-0.3/test_script1.py
|
test_script1.py
|
from setuptools import setup
setup(
name='1dyfolabs-test-script', # This is the name of your PyPI-package.
version='0.3', # Update the version number for new releases
scripts=['test_script1.py'] # The name of your scipt, and also the command you'll be using for calling it
)
|
1dyfolabs-test-script
|
/1dyfolabs-test-script-0.3.tar.gz/1dyfolabs-test-script-0.3/setup.py
|
setup.py
|
#这是"test.py"模块,提供了一个名为print_lol函数，该函数的作用是打印列表,其中也可能包含列表
#或者嵌套列表
def print_lol(the_list):
#这个函数取一个位置参数，名为the_list，这可以是任何test.py的列表
for each_item in the_list:
if isinstance(each_item,list):
print_lol(each_item)
else:
print(each_item)
|
1ee
|
/1ee-1.0.0.zip/1ee-1.0.0/test1.py
|
test1.py
|
from distutils.core import setup
setup(
name = '1ee',
version ='1.0.0',
py_modules=['test1'],
author='bruce',
author_email='[email protected]',
url='http://t.qq.com/Code_Lee',
description='a simple printer of test list',
)
|
1ee
|
/1ee-1.0.0.zip/1ee-1.0.0/setup.py
|
setup.py
|
# 1inch.py
1inch.py is a wrapper around the 1inch API and price Oracle. It has full coverage of the swap API endpoint and All chains support by 1inch are included in the OneInchSwap and OneInchOracle methods.
Package also includes a helper method to ease the submission of transactions to the network. Limited chains currently supported.
## API Documentation
The full 1inch swap API docs can be found at https://docs.1inch.io/
## Installation
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install 1inch.py.
```bash
pip install 1inch.py
```
## Usage
A quick note on decimals. The wrapper is designed for ease of use, and as such accepts amounts in "Ether" or whole units.
If you prefer, you can use decimal=0 and specify amounts in wei. This will also help with any potential floating point errors.
```python
from oneinch_py import OneInchSwap, TransactionHelper, OneInchOracle
rpc_url = "yourRPCURL.com"
binance_rpc = "adifferentRPCurl.com"
public_key = "yourWalletAddress"
private_key = "yourPrivateKey" #remember to protect your private key. Using environmental variables is recommended.
api_key = "" # 1 Inch API key
exchange = OneInchSwap(api_key, public_key)
bsc_exchange = OneInchSwap(api_key, public_key, chain='binance')
helper = TransactionHelper(api_key, rpc_url, public_key, private_key)
bsc_helper = TransactionHelper(api_key, binance_rpc, public_key, private_key, chain='binance')
oracle = OneInchOracle(rpc_url, chain='ethereum')
# See chains currently supported by the helper method:
helper.chains
# {"ethereum": "1", "binance": "56", "polygon": "137", "avalanche": "43114"}
# Straight to business:
# Get a swap and do the swap
result = exchange.get_swap("USDT", "ETH", 10, 0.5) # get the swap transaction
result = helper.build_tx(result) # prepare the transaction for signing, gas price defaults to fast.
result = helper.sign_tx(result) # sign the transaction using your private key
result = helper.broadcast_tx(result) #broadcast the transaction to the network and wait for the receipt.
## If you already have token addresses you can pass those in instead of token names to all OneInchSwap functions that require a token argument
result = exchange.get_swap("0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9", "0x43dfc4159d86f3a37a5a4b3d4580b888ad7d4ddd", 10, 0.5)
#USDT to ETH price on the Oracle. Note that you need to indicate the token decimal if it is anything other than 18.
oracle.get_rate_to_ETH("0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", src_token_decimal=6)
# Get the rate between any two tokens.
oracle.get_rate(src_token="0x6B175474E89094C44Da98b954EedeAC495271d0F", dst_token="0x111111111117dC0aa78b770fA6A738034120C302")
exchange.health_check()
# 'OK'
# Address of the 1inch router that must be trusted to spend funds for the swap
exchange.get_spender()
# Generate data for calling the contract in order to allow the 1inch router to spend funds. Token symbol or address is required. If optional "amount" variable is not supplied (in ether), unlimited allowance is granted.
exchange.get_approve("USDT")
exchange.get_approve("0xdAC17F958D2ee523a2206206994597C13D831ec7", amount=100)
# Get the number of tokens (in Wei) that the router is allowed to spend. Option "send address" variable. If not supplied uses address supplied when Initialization the exchange object.
exchange.get_allowance("USDT")
exchange.get_allowance("0xdAC17F958D2ee523a2206206994597C13D831ec7", send_address="0x12345")
# Token List is stored in memory
exchange.tokens
# {
# '1INCH': {'address': '0x111111111117dc0aa78b770fa6a738034120c302',
# 'decimals': 18,
# 'logoURI': 'https://tokens.1inch.exchange/0x111111111117dc0aa78b770fa6a738034120c302.png',
# 'name': '1INCH Token',
# 'symbol': '1INCH'},
# 'ETH': {'address': '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee',
# 'decimals': 18,
# 'logoURI': 'https://tokens.1inch.exchange/0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee.png',
# 'name': 'Ethereum',
# 'symbol': 'ETH'},
# ......
# }
# Returns the exchange rate of two tokens.
# Tokens can be provided as symbols or addresses
# "amount" is supplied in ether
# NOTE: When using custom tokens, the token decimal is assumed to be 18. If your custom token has a different decimal - please manually pass it to the function (decimal=x)
# Also returns the "price" of more expensive token in the cheaper tokens. Optional variables can be supplied as **kwargs
exchange.get_quote(from_token_symbol='ETH', to_token_symbol='USDT', amount=1)
# (
# {
# "fromToken": {
# "symbol": "ETH",
# "name": "Ethereum",
# "decimals": 18,
# "address": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
# "logoURI": "https://tokens.1inch.io/0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee.png",
# "tags": ["native"],
# },
# "toToken": {
# "symbol": "USDT",
# "name": "Tether USD",
# "address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
# "decimals": 6,
# "logoURI": "https://tokens.1inch.io/0xdac17f958d2ee523a2206206994597c13d831ec7.png",
# "tags": ["tokens"],
# ...
# Decimal("1076.503093"),
# )
# Creates the swap data for two tokens.
# Tokens can be provided as symbols or addresses
# Optional variables can be supplied as **kwargs
# NOTE: When using custom tokens, the token decimal is assumed to be 18. If your custom token has a different decimal - please manually pass it to the function (decimal=x)
exchange.get_swap(from_token_symbol='ETH', to_token_symbol='USDT', amount=1, slippage=0.5)
# {
# "fromToken": {
# "symbol": "ETH",
# "name": "Ethereum",
# "decimals": 18,
# "address": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
# "logoURI": "https://tokens.1inch.io/0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee.png",
# "tags": ["native"],
# },
# "toToken": {
# "symbol": "USDT",
# "name": "Tether USD",
# "address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
# "decimals": 6,
# "logoURI": "https://tokens.1inch.io/0xdac17f958d2ee523a2206206994597c13d831ec7.png",
# "tags": ["tokens"],
#
# ...
#
# ],
# "tx": {
# "from": "0x1d05aD0366ad6dc0a284C5fbda46cd555Fb4da27",
# "to": "0x1111111254fb6c44bac0bed2854e76f90643097d",
# "data": "0xe449022e00000000000000000000000000000000000000000000000006f05b59d3b20000000000000000000000000000000000000000000000000000000000001fed825a0000000000000000000000000000000000000000000000000000000000000060000000000000000000000000000000000000000000000000000000000000000140000000000000000000000011b815efb8f581194ae79006d24e0d814b7697f6cfee7c08",
# "value": "500000000000000000",
# "gas": 178993,
# "gasPrice": "14183370651",
# },
# }
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Thanks to @Makbeta for all of their work in migrating the wrapper to the new 1inch api system.
## License
[MIT](https://choosealicense.com/licenses/mit/)
|
1inch.py
|
/1inch.py-2.0.3.tar.gz/1inch.py-2.0.3/README.md
|
README.md
|
from setuptools import setup, find_packages
import pathlib
here = pathlib.Path(__file__).parent.resolve()
# Get the long description from the README file
long_description = (here / "README.md").read_text(encoding="utf-8")
setup(
name='1inch.py',
version='2.0.3',
url='https://github.com/RichardAtCT/1inch_wrapper',
long_description_content_type="text/markdown",
long_description=long_description,
keywords="1inch, wrapper, aggregator, DEX",
packages=find_packages(include=['oneinch_py', 'oneinch_py.*']),
include_package_data=True,
install_requires=[
'requests>=2.28.1',
'web3>=6.0.0',
'setuptools>=57.0.0'],
python_requires=">=3.7, <4",
license='MIT',
author='RichardAt',
author_email='[email protected]',
description='a Python wrapper for the 1inch API'
)
|
1inch.py
|
/1inch.py-2.0.3.tar.gz/1inch.py-2.0.3/setup.py
|
setup.py
|
import json
import time
import requests
from web3 import Web3
from decimal import *
import importlib.resources as pkg_resources
from web3.middleware import geth_poa_middleware
class UnknownToken(Exception):
pass
class OneInchSwap:
base_url = 'https://api.1inch.dev/swap'
api_key = ''
version = {
"v5.2": "v5.2"
}
chains = {
"ethereum": "1",
"binance": "56",
"polygon": "137",
"optimism": "10",
"arbitrum": "42161",
"gnosis": "100",
"avalanche": "43114",
"fantom": "250",
"klaytn": "8217",
"aurora": "1313161554",
"zksync": "324"
}
def __init__(self, api_key, address, chain='ethereum', version='v5.2'):
self.presets = None
self.tokens = {}
self.tokens_by_address = {}
self.protocols = []
self.address = address
self.api_key = api_key
self.version = version
self.chain_id = self.chains[chain]
self.chain = chain
self.tokens = self.get_tokens()
time.sleep(1)
self.spender = self.get_spender()
time.sleep(1)
def _get(self, url, params=None, headers=None):
""" Implements a get request """
try:
if headers == None:
headers = {"accept": "application/json", "Authorization": f"Bearer {self.api_key}"}
else:
headers["accept"] = "application/json"
headers["Authorization"] = f"Bearer {self.api_key}"
response = requests.get(url, params=params, headers=headers)
response.raise_for_status()
payload = response.json()
except requests.exceptions.ConnectionError as e:
# error_content = json.loads(e.response._content.decode("utf-8"))
print(f"ConnectionError with code {e.response.status_code} when doing a GET request from {format(url)}")
# print(f"{error_content['error']} {error_content['description']}")
payload = None
except requests.exceptions.HTTPError as e:
# error_content = json.loads(e.response._content.decode("utf-8"))
print(f"HTTPError with code {e.response.status_code} for a request {format(url)}")
# print(f"{error_content['error']} {error_content['description']}")
payload = None
return payload
def _token_to_address(self, token: str):
if len(token) == 42:
return Web3.to_checksum_address(token)
else:
try:
address = self.tokens[token]['address']
except:
raise UnknownToken("Token not in 1inch Token List")
return address
def health_check(self):
"""
Calls the Health Check Endpoint
:return: Always returns code 200 if API is stable
"""
url = f'{self.base_url}/{self.version}/{self.chain_id}/healthcheck'
response = self._get(url)
return response['status']
def get_spender(self):
url = f'{self.base_url}/{self.version}/{self.chain_id}/approve/spender'
result = self._get(url)
if not result.__contains__('spender'):
return result
self.spender = result
return self.spender
def get_tokens(self):
"""
Calls the Tokens API endpoint
:return: A dictionary of all the whitelisted tokens.
"""
url = f'https://api.1inch.dev/token/v1.2/{self.chain_id}'
result = self._get(url)
for key in result:
token = result[key]
self.tokens_by_address[key] = token
self.tokens[token['symbol']] = token
return self.tokens
def get_liquidity_sources(self):
url = f'{self.base_url}/{self.version}/{self.chain_id}/liquidity-sources'
result = self._get(url)
if not result.__contains__('liquidity-sources'):
return result
self.protocols = result
return self.protocols
def get_presets(self):
url = f'{self.base_url}/{self.version}/{self.chain_id}/presets'
result = self._get(url)
if not result.__contains__('presets'):
return result
self.presets = result
return self.presets
def get_quote(self, from_token_symbol: str, to_token_symbol: str, amount: float, decimal=None, **kwargs):
"""
Calls the QUOTE API endpoint. NOTE: When using custom tokens, the token decimal is assumed to be 18. If your
custom token has a different decimal - please manually pass it to the function (decimal=x)
"""
from_address = self._token_to_address(from_token_symbol)
to_address = self._token_to_address(to_token_symbol)
if decimal is None:
try:
self.tokens[from_token_symbol]['decimals']
except KeyError:
decimal = 18
else:
decimal = self.tokens[from_token_symbol]['decimals']
else:
pass
if decimal == 0:
amount_in_wei = int(amount)
else:
amount_in_wei = int(amount * 10 ** decimal)
url = f'{self.base_url}/{self.version}/{self.chain_id}/quote'
url = url + f'?fromTokenAddress={from_address}&toTokenAddress={to_address}&amount={amount_in_wei}'
if kwargs is not None:
result = self._get(url, params=kwargs)
else:
result = self._get(url)
# from_base = Decimal(result['fromTokenAmount']) / Decimal(10 ** result['fromToken']['decimals'])
# to_base = Decimal(result['toTokenAmount']) / Decimal(10 ** result['toToken']['decimals'])
# if from_base > to_base:
# rate = from_base / to_base
# else:
# rate = to_base / from_base
return result
def get_swap(self, from_token_symbol: str, to_token_symbol: str,
amount: float, slippage: float, decimal=None, send_address=None, **kwargs):
"""
Calls the SWAP API endpoint. NOTE: When using custom tokens, the token decimal is assumed to be 18. If your
custom token has a different decimal - please manually pass it to the function (decimal=x)
"""
if send_address is None:
send_address = self.address
else:
pass
from_address = self._token_to_address(from_token_symbol)
to_address = self._token_to_address(to_token_symbol)
if decimal is None:
try:
self.tokens[from_token_symbol]['decimals']
except KeyError:
decimal = 18
else:
decimal = self.tokens[from_token_symbol]['decimals']
else:
pass
if decimal == 0:
amount_in_wei = int(amount)
else:
amount_in_wei = int(amount * 10 ** decimal)
url = f'{self.base_url}/{self.version}/{self.chain_id}/swap'
url = url + f'?fromTokenAddress={from_address}&toTokenAddress={to_address}&amount={amount_in_wei}'
url = url + f'&fromAddress={send_address}&slippage={slippage}'
if kwargs is not None:
result = self._get(url, params=kwargs)
else:
result = self._get(url)
return result
def get_allowance(self, from_token_symbol: str, send_address=None):
if send_address is None:
send_address = self.address
from_address = self._token_to_address(from_token_symbol)
url = f'{self.base_url}/{self.version}/{self.chain_id}/approve/allowance'
url = url + f"?tokenAddress={from_address}&walletAddress={send_address}"
result = self._get(url)
return result
def get_approve(self, from_token_symbol: str, amount=None, decimal=None):
from_address = self._token_to_address(from_token_symbol)
if decimal is None:
try:
self.tokens[from_token_symbol]['decimals']
except KeyError:
decimal = 18
else:
decimal = self.tokens[from_token_symbol]['decimals']
else:
pass
url = f'{self.base_url}/{self.version}/{self.chain_id}/approve/transaction'
if amount is None:
url = url + f"?tokenAddress={from_address}"
else:
if decimal == 0:
amount_in_wei = int(amount)
else:
amount_in_wei = int(amount * 10 ** decimal)
url = url + f"?tokenAddress={from_address}&amount={amount_in_wei}"
result = self._get(url)
return result
class TransactionHelper:
gas_oracle = "https://gas-price-api.1inch.io/v1.3/"
chains = {
"ethereum": "1",
"binance": "56",
"polygon": "137",
"optimism": "10",
"arbitrum": "42161",
"gnosis": "100",
"avalanche": "43114",
"fantom": "250",
"klaytn": "8217",
"aurora": "1313161554",
"zksync": "324"
}
abi = json.loads(pkg_resources.read_text(__package__, 'erc20.json'))['result']
abi_aggregator = json.loads(pkg_resources.read_text(__package__, 'aggregatorv5.json'))['result']
def _get(self, url, params=None, headers=None):
""" Implements a get request """
try:
if headers == None:
headers = {"accept": "application/json", "Authorization": f"Bearer {self.api_key}", "Content-Type": "application/json"}
else:
headers["accept"] = "application/json"
headers["Authorization"] = f"Bearer {self.api_key}"
headers["Content-Type"] = "application/json"
response = requests.get(url, params=params, headers=headers)
response.raise_for_status()
payload = response.json()
except requests.exceptions.ConnectionError as e:
# error_content = json.loads(e.response._content.decode("utf-8"))
print("ConnectionError when doing a GET request from {}".format(url))
# print(f"{error_content['error']} {error_content['description']}")
payload = None
except requests.exceptions.HTTPError:
# error_content = json.loads(e.response._content.decode("utf-8"))
print("HTTPError {}".format(url))
# print(f"{error_content['error']} {error_content['description']}")
payload = None
return payload
def __init__(self, api_key, rpc_url, public_key, private_key, chain='ethereum', broadcast_1inch=False):
self.w3 = Web3(Web3.HTTPProvider(rpc_url))
if chain == 'polygon' or chain == 'avalanche':
self.w3.middleware_onion.inject(geth_poa_middleware, layer=0)
else:
pass
self.api_key = api_key
self.public_key = public_key
self.private_key = private_key
self.chain = chain
self.chain_id = self.chains[chain]
self.broadcast_1inch = broadcast_1inch
def build_tx(self, raw_tx, speed='high'):
nonce = self.w3.eth.get_transaction_count(self.public_key)
if raw_tx == None:
return None
if 'tx' in raw_tx:
tx = raw_tx['tx']
else:
tx = raw_tx
if 'from' not in tx:
tx['from'] = self.w3.to_checksum_address(self.public_key)
tx['to'] = self.w3.to_checksum_address(tx['to'])
if 'gas' not in tx:
tx['gas'] = self.w3.eth.estimate_gas(tx)
tx['nonce'] = nonce
tx['chainId'] = int(self.chain_id)
tx['value'] = int(tx['value'])
tx['gas'] = int(tx['gas'] * 1.25)
if self.chain == 'ethereum' or self.chain == 'polygon' or self.chain == 'avalanche' or self.chain == 'gnosis' or self.chain == 'klaytn':
gas = self._get(self.gas_oracle + self.chain_id)
tx['maxPriorityFeePerGas'] = int(gas[speed]['maxPriorityFeePerGas'])
tx['maxFeePerGas'] = int(gas[speed]['maxFeePerGas'])
tx.pop('gasPrice')
else:
tx['gasPrice'] = int(tx['gasPrice'])
return tx
def sign_tx(self, tx):
if tx == None:
return None
signed_tx = self.w3.eth.account.sign_transaction(tx, self.private_key)
return signed_tx
def broadcast_tx(self, signed_tx, timeout=360):
api_base_url = 'https://api.1inch.dev/tx-gateway/v1.1/'
api_headers = {"accept": "application/json", "Authorization": f"Bearer {self.api_key}", "Content-Type": "application/json"}
if signed_tx == None:
return None
if self.broadcast_1inch is True:
tx_json = signed_tx.rawTransaction
tx_json = {"rawTransaction": tx_json.hex()}
payload = requests.post(api_base_url + self.chain_id + "/broadcast", data=self.w3.toJSON(tx_json), headers=api_headers)
tx_hash = json.loads(payload.text)
tx_hash = tx_hash['transactionHash']
receipt = self.w3.eth.wait_for_transaction_receipt(tx_hash, timeout=timeout)
return receipt, tx_hash
else:
tx_hash = self.w3.eth.send_raw_transaction(signed_tx.rawTransaction)
print(tx_hash.hex())
receipt = self.w3.eth.wait_for_transaction_receipt(tx_hash, timeout=timeout)
return receipt, tx_hash.hex()
def get_ERC20_balance(self, contract_address, decimal=None):
contract = self.w3.eth.contract(address=self.w3.to_checksum_address(contract_address), abi=self.abi)
balance_in_wei = contract.functions.balanceOf(self.public_key).call()
if decimal is None:
return self.w3.from_wei(balance_in_wei, 'ether')
elif decimal == 0:
return balance_in_wei
else:
return balance_in_wei / 10 ** decimal
def decode_abi(self, transaction):
contract = self.w3.eth.contract(address=self.w3.to_checksum_address('0x1111111254EEB25477B68fb85Ed929f73A960582'), abi=self.abi_aggregator)
data = transaction['tx']['data']
decoded_data = contract.decode_function_input(data)
return decoded_data
class OneInchOracle:
chains = {
"ethereum": "1",
"binance": "56",
"polygon": "137",
"optimism": "10",
"arbitrum": "42161",
"gnosis": "100",
"avalanche": "43114",
"fantom": "250",
"klaytn": "8217",
"aurora": "1313161554",
"zksync": "324"
}
contracts = {
"ethereum": '0x07D91f5fb9Bf7798734C3f606dB065549F6893bb',
"binance": '0xfbD61B037C325b959c0F6A7e69D8f37770C2c550',
"polygon": "0x7F069df72b7A39bCE9806e3AfaF579E54D8CF2b9",
"optimism": "0x11DEE30E710B8d4a8630392781Cc3c0046365d4c",
"arbitrum": "0x735247fb0a604c0adC6cab38ACE16D0DbA31295F",
"gnosis": "0x142DB045195CEcaBe415161e1dF1CF0337A4d02E",
"avalanche": "0xBd0c7AaF0bF082712EbE919a9dD94b2d978f79A9",
"fantom": "0xE8E598A1041b6fDB13999D275a202847D9b654ca"
}
# multicall_address = "0xDA3C19c6Fe954576707fA24695Efb830D9ccA1CA"
oracle_abi = json.loads(pkg_resources.read_text(__package__, 'oracle.json'))['result']
# multicall_abi = json.loads(pkg_resources.read_text(__package__, 'multicall.json'))['result']
def __init__(self, rpc_url, chain='ethereum'):
self.w3 = Web3(Web3.HTTPProvider(rpc_url))
self.chain = chain
self.chain_id = self.chains[chain]
self.contract_address = self.contracts[chain]
self.oracle_contract = self.w3.eth.contract(address=self.contract_address, abi=self.oracle_abi)
# self.multicall_contract = self.w3.eth.contract(address=self.multicall_address, abi=self.multicall_abi)
def get_rate(self, src_token, dst_token, wrap=False, src_token_decimal: int = 18, dst_token_decimal: int = 18):
rate = self.oracle_contract.functions.getRate(self.w3.to_checksum_address(src_token),
self.w3.to_checksum_address(dst_token), wrap).call()
if src_token_decimal == 18 and dst_token_decimal < 18:
rate = rate / 10 ** dst_token_decimal
elif dst_token_decimal == 18 and src_token_decimal < 18:
rate = rate / 10 ** ((18 - src_token_decimal) + 18)
elif dst_token_decimal < 18 and src_token_decimal < 18:
rate = rate / 10 ** ((18 - src_token_decimal) + (18 - dst_token_decimal))
else:
rate = rate / 10 ** 18
return rate
def get_rate_to_ETH(self, src_token, wrap=False, src_token_decimal=18):
rate = self.oracle_contract.functions.getRateToEth(self.w3.to_checksum_address(src_token), wrap).call()
if src_token_decimal == 18:
rate = rate / 10 ** 18
elif src_token_decimal < 18:
rate = rate / 10 ** ((18 - src_token_decimal) + 18)
return rate
# TODO Figure this all out at some point
# def get_multicall(self, token_list):
# for address in token_list:
# call_data = {
# "to": "0x07D91f5fb9Bf7798734C3f606dB065549F6893bb",
# "data": f"{self.oracle_contract.functions.getRateToEth(address,True)}"
# }
#
# print(call_data)
# # mapped = map(lambda , token_list, wrap_list)
# # mapped = list(mapped)
# # rate = self.multicall_contract.functions.multicall(mapped).call()
# return
if __name__ == '__main__':
pass
|
1inch.py
|
/1inch.py-2.0.3.tar.gz/1inch.py-2.0.3/oneinch_py/main.py
|
main.py
|
from oneinch_py.main import OneInchSwap, TransactionHelper, OneInchOracle
|
1inch.py
|
/1inch.py-2.0.3.tar.gz/1inch.py-2.0.3/oneinch_py/__init__.py
|
__init__.py
|
# -*- coding:utf-8 -*-
"""
@author:bbw
@file:nester.py
@time:2017/10/9 10:08
"""
"""这个模块提供了一个函数，打印列表，其中可能包含（也可能不包含嵌套列表）"""
import sys
def print_lol(the_list, indent=False, level=0, fh=sys.stdout):
"""这个函数取一个位置参数，名为the list，可以是任何python列表，所指定的每个数据项会递归的显示到屏幕上，且各占一行.
第二个参数用来在遇到嵌套列表时插入制表符"""
for each_item in the_list:
if isinstance(each_item, list):
print_lol(each_item, indent, level+1, fh)
else:
if indent:
for tab_stop in range(level):
print("\t", end='', file=fh)
print(each_item, file=fh)
|
1nester
|
/1nester-1.4.0.tar.gz/1nester-1.4.0/nester.py
|
nester.py
|
# -*- coding:utf-8 -*-
"""
@author:bbw
@file:setup.py.py
@time:2017/10/9 10:26
"""
from distutils.core import setup
setup(
name = '1nester',
version ='1.4.0',
py_modules = ['nester'],
author = 'bbw',
author_email = '[email protected]',
url = 'http://www.headfirstlabs.com',
description = 'a simple printer of nested lists',
)
|
1nester
|
/1nester-1.4.0.tar.gz/1nester-1.4.0/setup.py
|
setup.py
|
# 1neuron_pypi
1neuron_pypi
|
1neuron-pypi-overlordiam
|
/1neuron_pypi-overlordiam-0.0.1.tar.gz/1neuron_pypi-overlordiam-0.0.1/README.md
|
README.md
|
import setuptools
with open("README.md", "r", encoding="utf-8") as fh:
long_description = fh.read()
USER_NAME = "overlordiam"
PROJECT_NAME = "1neuron_pypi"
setuptools.setup(
name=f"{PROJECT_NAME}-{USER_NAME}",
version="0.0.1",
author=USER_NAME,
author_email="[email protected]",
description="An implementation of Perceptron",
long_description=long_description,
long_description_content_type="text/markdown",
url=f"https://github.com/{USER_NAME}/{PROJECT_NAME}",
project_urls={
"Bug Tracker": f"https://github.com/{USER_NAME}/{PROJECT_NAME}/issues",
},
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
package_dir={"": "src"},
packages=setuptools.find_packages(where="src"),
python_requires=">=3.7",
install_requires=[
"numpy",
"tqdm",
]
)
|
1neuron-pypi-overlordiam
|
/1neuron_pypi-overlordiam-0.0.1.tar.gz/1neuron_pypi-overlordiam-0.0.1/setup.py
|
setup.py
|
## perceptron class
import numpy as np
import logging
from tqdm import tqdm
class Perceptron:
def __init__(self, eta, epochs):
self.weights = np.random.randn(3) * 1e-4
logging.info(f"initial random weights assigned are: \n{self.weights}")
self.eta = eta
self.epochs = epochs
def activationFunction(self, inputs, weights):
z = np.dot(inputs, weights)
return np.where(z>0, 1, 0)
def fit(self, X, y):
self.X = X
self.y = y
X_with_bias = np.c_[self.X, -np.ones((len(self.X), 1))]
logging.info(f"X_with_bias: {X_with_bias}")
for epoch in tqdm(range(self.epochs), total=self.epochs, desc="Training the model"):
logging.info("--"*10)
logging.info(f"epoch no.: {epoch}")
logging.info("--"*10)
# FORWARD PROPAGATION
y_hat = self.activationFunction(X_with_bias, self.weights)
logging.info(f"Predicted y value after forward pass: \n{y_hat}")
self.error = self.y - y_hat
logging.info(f"Error: \n{self.error}")
# BACKWARD PROPAGATION
self.weights = self.weights + self.eta * np.dot(X_with_bias.T, self.error)
logging.info(f"Updated weights after \n{epoch}/{self.epochs}: \n{self.weights}")
logging.info("##"*10)
def predict(self, X):
X_with_bias = np.c_[X, -np.ones((len(X), 1))]
return self.activationFunction(X_with_bias, self.weights)
def total_loss(self):
total_loss = np.sum(self.error)
logging.info(f"total loss: {total_loss}")
return total_loss
|
1neuron-pypi-overlordiam
|
/1neuron_pypi-overlordiam-0.0.1.tar.gz/1neuron_pypi-overlordiam-0.0.1/src/1neuron/perceptron.py
|
perceptron.py
|
# 1on1
|
1on1
|
/1on1-0.1.tar.gz/1on1-0.1/README.md
|
README.md
|
from setuptools import setup, find_packages
VERSION=0.1
DESCRIPTION="A package for pre-trained image classification and context-decider for question-answering chatbots."
LONG_DESCRIPTION=""
CLASSIFIERS=[
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Education',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 3'
]
setup(name="1on1",version=VERSION,author="Sohini Bhattacharya",author_email="[email protected]",License="MIT",packages=find_packages(),keywords=["python","image-classification","active-learning-sampling","question-answering","pre-trained models","tiny-image-net","cifar10"],classifiers=CLASSIFIERS)
|
1on1
|
/1on1-0.1.tar.gz/1on1-0.1/setup.py
|
setup.py
|
=====
1pass
=====
A command line interface (and Python library) for reading passwords from
`1Password <https://agilebits.com/onepassword>`_.
Command line usage
==================
To get a password::
1pass mail.google.com
By default this will look in ``~/Dropbox/1Password.agilekeychain``. If that's
not where you keep your keychain::
1pass --path ~/whatever/1Password.agilekeychain mail.google.com
Or, you can set your keychain path as an enviornment variable::
export ONEPASSWORD_KEYCHAIN=/path/to/keychain
1pass mail.google.com
By default, the name you pass on the command line must match the name of an
item in your 1Password keychain exactly. To avoid this, fuzzy matching is
made possible with the ``--fuzzy`` flag::
1pass --fuzzy mail.goog
If you don't want to be prompted for your password, you can use the
``--no-prompt`` flag and provide the password via standard input instead::
emit_master_password | 1pass --no-prompt mail.google.com
Python usage
============
The interface is very simple::
from onepassword import Keychain
my_keychain = Keychain(path="~/Dropbox/1Password.agilekeychain")
my_keychain.unlock("my-master-password")
my_keychain.item("An item's name").password
An example of real-world use
============================
I wrote this so I could add the following line to my ``.muttrc`` file::
set imap_pass = "`1pass 'Google: personal'`"
Now, whenever I start ``mutt``, I am prompted for my 1Password Master Password
and not my Gmail password.
The ``--no-prompt`` flag is very useful when configuring ``mutt`` and PGP.
``mutt`` passes the PGP passphrase via standard in, so by inserting ``1pass``
into this pipline I can use my 1Password master password when prompted for my
PGP keyphrase::
set pgp_decrypt_command="1pass --no-prompt pgp-passphrase | gpg --passphrase-fd 0 ..."
Contributors
============
* Pip Taylor <https://github.com/pipt>
* Adam Coddington <https://github.com/latestrevision>
* Ash Berlin <https://github.com/ashb>
* Zach Allaun <https://github.com/zachallaun>
* Eric Mika <https://github.com/kitschpatrol>
License
=======
*1pass* is licensed under the MIT license. See the license file for details.
While it is designed to read ``.agilekeychain`` bundles created by 1Password,
*1pass* isn't officially sanctioned or supported by
`AgileBits <https://agilebits.com/>`_. I do hope they like it though.
|
1pass
|
/1pass-0.2.1.tar.gz/1pass-0.2.1/README.txt
|
README.txt
|
import os
from setuptools import setup
VERSION = "0.2.1"
def readme():
""" Load the contents of the README file """
readme_path = os.path.join(os.path.dirname(__file__), "README.txt")
with open(readme_path, "r") as f:
return f.read()
setup(
name="1pass",
version=VERSION,
author="George Brocklehurst",
author_email="[email protected]",
description="A Python library and command line interface for 1Password",
long_description=readme(),
install_requires=["M2Crypto", "fuzzywuzzy"],
license="MIT",
url="http://github.com/georgebrock/1pass",
classifiers=[],
packages=["onepassword"],
scripts=["bin/1pass"],
tests_require=["nose", "mock"],
test_suite="nose.collector",
)
|
1pass
|
/1pass-0.2.1.tar.gz/1pass-0.2.1/setup.py
|
setup.py
|
from base64 import b64decode
from hashlib import md5
from M2Crypto import EVP
class SaltyString(object):
SALTED_PREFIX = "Salted__"
ZERO_INIT_VECTOR = "\x00" * 16
def __init__(self, base64_encoded_string):
decoded_data = b64decode(base64_encoded_string)
if decoded_data.startswith(self.SALTED_PREFIX):
self.salt = decoded_data[8:16]
self.data = decoded_data[16:]
else:
self.salt = self.ZERO_INIT_VECTOR
self.data = decoded_data
class EncryptionKey(object):
MINIMUM_ITERATIONS = 1000
def __init__(self, data, iterations=0, validation="", identifier=None,
level=None):
self.identifier = identifier
self.level = level
self._encrypted_key = SaltyString(data)
self._decrypted_key = None
self._set_iterations(iterations)
self._validation = validation
def unlock(self, password):
key, iv = self._derive_pbkdf2(password)
self._decrypted_key = self._aes_decrypt(
key=key,
iv=iv,
encrypted_data=self._encrypted_key.data,
)
return self._validate_decrypted_key()
def decrypt(self, b64_data):
encrypted = SaltyString(b64_data)
key, iv = self._derive_openssl(self._decrypted_key, encrypted.salt)
return self._aes_decrypt(key=key, iv=iv, encrypted_data=encrypted.data)
def _set_iterations(self, iterations):
self.iterations = max(int(iterations), self.MINIMUM_ITERATIONS)
def _validate_decrypted_key(self):
return self.decrypt(self._validation) == self._decrypted_key
def _aes_decrypt(self, key, iv, encrypted_data):
aes = EVP.Cipher("aes_128_cbc", key, iv, key_as_bytes=False, padding=False, op=0)
return self._strip_padding(aes.update(encrypted_data) + aes.final())
def _strip_padding(self, decrypted):
padding_size = ord(decrypted[-1])
if padding_size >= 16:
return decrypted
else:
return decrypted[:-padding_size]
def _derive_pbkdf2(self, password):
key_and_iv = EVP.pbkdf2(
password,
self._encrypted_key.salt,
self.iterations,
32,
)
return (
key_and_iv[0:16],
key_and_iv[16:],
)
def _derive_openssl(self, key, salt):
key = key[0:-16]
key_and_iv = ""
prev = ""
while len(key_and_iv) < 32:
prev = md5(prev + key + salt).digest()
key_and_iv += prev
return (
key_and_iv[0:16],
key_and_iv[16:],
)
|
1pass
|
/1pass-0.2.1.tar.gz/1pass-0.2.1/onepassword/encryption_key.py
|
encryption_key.py
|
import json
import os
from fuzzywuzzy import process
from onepassword.encryption_key import EncryptionKey
class Keychain(object):
def __init__(self, path):
self._path = os.path.expanduser(path)
self._load_encryption_keys()
self._load_item_list()
self._locked = True
def unlock(self, password):
unlocker = lambda key: key.unlock(password)
unlock_results = map(unlocker, self._encryption_keys.values())
result = reduce(lambda x, y: x and y, unlock_results)
self._locked = not result
return result
def item(self, name, fuzzy_threshold=100):
"""
Extract a password from an unlocked Keychain using fuzzy
matching. ``fuzzy_threshold`` can be an integer between 0 and
100, where 100 is an exact match.
"""
match = process.extractOne(
name,
self._items.keys(),
score_cutoff=(fuzzy_threshold-1),
)
if match:
exact_name = match[0]
item = self._items[exact_name]
item.decrypt_with(self)
return item
else:
return None
def key(self, identifier=None, security_level=None):
"""
Tries to find an encryption key, first using the ``identifier`` and
if that fails or isn't provided using the ``security_level``.
Returns ``None`` if nothing matches.
"""
if identifier:
try:
return self._encryption_keys[identifier]
except KeyError:
pass
if security_level:
for key in self._encryption_keys.values():
if key.level == security_level:
return key
@property
def locked(self):
return self._locked
def _load_encryption_keys(self):
path = os.path.join(self._path, "data", "default", "encryptionKeys.js")
with open(path, "r") as f:
key_data = json.load(f)
self._encryption_keys = {}
for key_definition in key_data["list"]:
key = EncryptionKey(**key_definition)
self._encryption_keys[key.identifier] = key
def _load_item_list(self):
path = os.path.join(self._path, "data", "default", "contents.js")
with open(path, "r") as f:
item_list = json.load(f)
self._items = {}
for item_definition in item_list:
item = KeychainItem.build(item_definition, self._path)
self._items[item.name] = item
class KeychainItem(object):
@classmethod
def build(cls, row, path):
identifier = row[0]
type = row[1]
name = row[2]
if type == "webforms.WebForm":
return WebFormKeychainItem(identifier, name, path, type)
elif type == "passwords.Password" or type == "wallet.onlineservices.GenericAccount":
return PasswordKeychainItem(identifier, name, path, type)
else:
return KeychainItem(identifier, name, path, type)
def __init__(self, identifier, name, path, type):
self.identifier = identifier
self.name = name
self.password = None
self._path = path
self._type = type
@property
def key_identifier(self):
return self._lazily_load("_key_identifier")
@property
def security_level(self):
return self._lazily_load("_security_level")
def decrypt_with(self, keychain):
key = keychain.key(
identifier=self.key_identifier,
security_level=self.security_level,
)
encrypted_json = self._lazily_load("_encrypted_json")
decrypted_json = key.decrypt(self._encrypted_json)
self._data = json.loads(decrypted_json)
self.password = self._find_password()
def _find_password(self):
raise Exception("Cannot extract a password from this type of"
" keychain item (%s)" % self._type)
def _lazily_load(self, attr):
if not hasattr(self, attr):
self._read_data_file()
return getattr(self, attr)
def _read_data_file(self):
filename = "%s.1password" % self.identifier
path = os.path.join(self._path, "data", "default", filename)
with open(path, "r") as f:
item_data = json.load(f)
self._key_identifier = item_data.get("keyID")
self._security_level = item_data.get("securityLevel")
self._encrypted_json = item_data["encrypted"]
class WebFormKeychainItem(KeychainItem):
def _find_password(self):
for field in self._data["fields"]:
if field.get("designation") == "password" or \
field.get("name") == "Password":
return field["value"]
class PasswordKeychainItem(KeychainItem):
def _find_password(self):
return self._data["password"]
|
1pass
|
/1pass-0.2.1.tar.gz/1pass-0.2.1/onepassword/keychain.py
|
keychain.py
|
from keychain import Keychain
|
1pass
|
/1pass-0.2.1.tar.gz/1pass-0.2.1/onepassword/__init__.py
|
__init__.py
|
import argparse
import getpass
import os
import sys
from onepassword import Keychain
DEFAULT_KEYCHAIN_PATH = "~/Dropbox/1Password.agilekeychain"
class CLI(object):
"""
The 1pass command line interface.
"""
def __init__(self, stdin=sys.stdin, stdout=sys.stdout, stderr=sys.stderr,
getpass=getpass.getpass, arguments=sys.argv[1:]):
self.stdin = stdin
self.stdout = stdout
self.stderr = stderr
self.getpass = getpass
self.arguments = self.argument_parser().parse_args(arguments)
self.keychain = Keychain(self.arguments.path)
def run(self):
"""
The main entry point, performs the appropriate action for the given
arguments.
"""
self._unlock_keychain()
item = self.keychain.item(
self.arguments.item,
fuzzy_threshold=self._fuzzy_threshold(),
)
if item is not None:
self.stdout.write("%s\n" % item.password)
else:
self.stderr.write("1pass: Could not find an item named '%s'\n" % (
self.arguments.item,
))
sys.exit(os.EX_DATAERR)
def argument_parser(self):
parser = argparse.ArgumentParser()
parser.add_argument("item", help="The name of the password to decrypt")
parser.add_argument(
"--path",
default=os.environ.get('ONEPASSWORD_KEYCHAIN', DEFAULT_KEYCHAIN_PATH),
help="Path to your 1Password.agilekeychain file",
)
parser.add_argument(
"--fuzzy",
action="store_true",
help="Perform fuzzy matching on the item",
)
parser.add_argument(
"--no-prompt",
action="store_true",
help="Don't prompt for a password, read from STDIN instead",
)
return parser
def _unlock_keychain(self):
if self.arguments.no_prompt:
self._unlock_keychain_stdin()
else:
self._unlock_keychain_prompt()
def _unlock_keychain_stdin(self):
password = self.stdin.read().strip()
self.keychain.unlock(password)
if self.keychain.locked:
self.stderr.write("1pass: Incorrect master password\n")
sys.exit(os.EX_DATAERR)
def _unlock_keychain_prompt(self):
while self.keychain.locked:
try:
self.keychain.unlock(self.getpass("Master password: "))
except KeyboardInterrupt:
self.stdout.write("\n")
sys.exit(0)
def _fuzzy_threshold(self):
if self.arguments.fuzzy:
return 70
else:
return 100
|
1pass
|
/1pass-0.2.1.tar.gz/1pass-0.2.1/onepassword/cli.py
|
cli.py
|
import argparse
import json
import re
import subprocess
import sys
from datetime import datetime
from io import StringIO
from tempfile import NamedTemporaryFile
from dotenv import dotenv_values
from sgqlc.endpoint.http import HTTPEndpoint
FLY_GRAPHQL_ENDPOINT = 'https://api.fly.io/graphql'
DATE_FORMAT = '%Y/%m/%d %H:%M:%S'
DEFAULT_ENV_FILE_NAME = '.env'
class UserError(RuntimeError):
pass
def get_1password_env_file_item_id(title_substring):
secure_notes = json.loads(
subprocess.check_output(
[
'op',
'item',
'list',
'--categories',
'Secure Note',
'--format',
'json',
]
)
)
item_ids = list(
item['id']
for item in secure_notes
if title_substring in item['title'].split(' ')
)
if len(item_ids) == 0:
raise_error(
f'No 1password secure note found with a name containing {title_substring!r}'
)
if len(item_ids) > 1:
raise_error(
f'Found {len(item_ids)} 1password secure notes with a name containing '
f'{title_substring!r}, expected one'
)
return item_ids[0]
def get_item_from_1password(item_id):
return json.loads(
subprocess.check_output(
['op', 'item', 'get', item_id, '--format', 'json']
)
)
def get_envs_from_1password(item_id):
item = get_item_from_1password(item_id)
result = first(
field.get('value')
for field in item['fields']
if field['id'] == 'notesPlain'
)
if result is None or result == '':
raise_error('Empty secrets, aborting')
return result
def get_filename_from_1password(item_id):
item = get_item_from_1password(item_id)
result = first(
field.get('value')
for field in item['fields']
if field['label'] == 'file_name'
)
return result
def get_fly_auth_token():
return json.loads(
subprocess.check_output(['fly', 'auth', 'token', '--json'])
)['token']
def update_fly_secrets(app_id, secrets):
set_secrets_mutation = '''
mutation(
$appId: ID!
$secrets: [SecretInput!]!
$replaceAll: Boolean!
) {
setSecrets(
input: {
appId: $appId
replaceAll: $replaceAll
secrets: $secrets
}
) {
app {
name
}
release {
version
}
}
}
'''
secrets_input = [
{'key': key, 'value': value}
for key, value in secrets.items()
]
variables = {
'appId': app_id,
'secrets': secrets_input,
'replaceAll': True
}
headers = {'Authorization': f'Bearer {get_fly_auth_token()}'}
endpoint = HTTPEndpoint(
FLY_GRAPHQL_ENDPOINT,
headers
)
response = endpoint(
query=set_secrets_mutation,
variables=variables
)
if response.get('errors') is not None:
raise_error(response['errors'][0])
print(
'Releasing fly app {} version {}'.format(
app_id,
response['data']['setSecrets']['release']['version']
)
)
def update_1password_secrets(item_id, content):
subprocess.check_output([
'op',
'item',
'edit',
item_id,
f'notesPlain={content}'
])
def update_1password_custom_field(item_id, field, value):
subprocess.check_output([
'op',
'item',
'edit',
item_id,
f'Generated by 1password-secrets.{field}[text]={value}',
'--format',
'json'
])
def get_secrets_from_envs(input: str):
return dotenv_values(stream=StringIO(input))
def import_1password_secrets_to_fly(app_id):
item_id = get_1password_env_file_item_id(f'fly:{app_id}')
secrets = get_secrets_from_envs(get_envs_from_1password(item_id))
update_fly_secrets(app_id, secrets)
now_formatted = datetime.now().strftime(DATE_FORMAT)
update_1password_custom_field(
item_id,
'last imported at',
now_formatted
)
def edit_1password_secrets(app_id):
item_id = get_1password_env_file_item_id(f'fly:{app_id}')
secrets = get_envs_from_1password(item_id)
with NamedTemporaryFile('w+') as file:
file.writelines(secrets)
file.flush()
subprocess.check_output(['code', '--wait', file.name])
file.seek(0)
output = file.read()
if secrets == output:
print('No changes detected, aborting.')
return
update_1password_secrets(item_id, output)
now_formatted = datetime.now().strftime(DATE_FORMAT)
update_1password_custom_field(
item_id,
'last edited at',
now_formatted
)
user_input = ''
while user_input.lower() not in ['y', 'n']:
user_input = input(
'Secrets updated in 1password, '
f'do you wish to import secrets to the fly app {app_id} (y/n)?\n'
)
if user_input.lower() == 'y':
import_1password_secrets_to_fly(app_id)
def pull_local_secrets():
repository = get_git_repository_name_from_current_directory()
item_id = get_1password_env_file_item_id(f'repo:{repository}')
secrets = get_envs_from_1password(item_id)
env_file_name = get_filename_from_1password(item_id) or DEFAULT_ENV_FILE_NAME
with open(env_file_name, 'w') as file:
file.writelines(secrets)
print(f'Successfully updated {env_file_name} from 1password')
def push_local_secrets():
repository_name = get_git_repository_name_from_current_directory()
item_id = get_1password_env_file_item_id(f'repo:{repository_name}')
env_file_name = get_filename_from_1password(item_id) or DEFAULT_ENV_FILE_NAME
try:
with open(env_file_name, 'r') as file:
secrets = file.read()
except FileNotFoundError:
raise_error(f'Env file {env_file_name!r} not found!')
update_1password_secrets(item_id, secrets)
now_formatted = datetime.now().strftime(DATE_FORMAT)
update_1password_custom_field(
item_id,
'last edited at',
now_formatted
)
print(f'Successfully pushed secrets from {env_file_name} to 1password')
def get_git_repository_name_from_current_directory():
GIT_REPOSITORY_REGEX = r'^(https|git)(:\/\/|@)([^\/:]+)[\/:]([^\/:]+)\/(.+).git$'
try:
git_remote_origin_url = subprocess.check_output([
'git',
'config',
'--get',
'remote.origin.url'
]).decode('utf-8')
except subprocess.CalledProcessError:
raise_error('Either not in a git repository or remote "origin" is not set')
regex_match = re.match(
GIT_REPOSITORY_REGEX,
git_remote_origin_url
)
if regex_match is None:
raise_error('Could not get remote "origin" url from git repository')
repository_name = f'{regex_match.group(4)}/{regex_match.group(5)}'
return repository_name
def raise_error(message):
print(message)
raise UserError(message)
def first(iterable):
try:
return next(iterable)
except StopIteration:
return None
def main():
parser = argparse.ArgumentParser(
description='1password-secrets is a set of utilities to sync 1Password secrets.'
)
subparsers = parser.add_subparsers(dest='subcommand', required=True)
fly_parser = subparsers.add_parser('fly', help='manage fly secrets')
fly_parser.add_argument('action', type=str, choices=['import', 'edit'])
fly_parser.add_argument('app_name', type=str, help='fly application name')
local_parser = subparsers.add_parser('local', help='manage local secrets')
local_parser.add_argument('action', type=str, choices=['pull', 'push'])
args = parser.parse_args()
try:
if args.subcommand == 'fly':
if args.action == 'import':
import_1password_secrets_to_fly(args.app_name)
elif args.action == 'edit':
edit_1password_secrets(args.app_name)
elif args.subcommand == 'local':
if args.action == 'pull':
pull_local_secrets()
elif args.action == 'push':
push_local_secrets()
except UserError:
sys.exit(1)
if __name__ == '__main__':
main()
|
1password-secrets
|
/1password_secrets-0.0.4-py3-none-any.whl/onepassword_secrets.py
|
onepassword_secrets.py
|
# OnePassword python client
[](https://github.com/wandera/1password-client/actions/workflows/publish-to-pypi.yml)
[](https://github.com/wandera/1password-client/actions/workflows/codeql-analysis.yml)
Python client around the 1Password password manager cli for usage within python code and
Jupyter Notebooks. Developed by Data Scientists from Jamf.
## Supported versions
There are some of the pre-requisites that are needed to use the library. We automatically install the cli for Mac and
Linux users when installing the library. Windows users see below for help.
- 1Password App: 8+
- 1Password cli: 2+
- Python: 3.10+
## Operating systems
The library is split into two parts: installation and client in which we are slowly updating to cover as many operating
systems as possible the following table should ensure users understand what this library can and can't do at time of
install.
| | MacOS | Linux |
|-----------------|-------|-------|
| Fully supported | Y | Y |
| CLI install | Y | Y |
| SSO login | Y | Y |
| Login via App | Y | Y |
| Biometrics auth | Y | Y |
| Password auth | Y | Y |
| CLI client | Y | Y |
## Installation
```bash
pip install 1password
```
If you have issues with PyYaml or other distutils installed packages then use:
```bash
pip install --ignore-installed 1password
```
You are welcome to install and manage `op` yourself by visiting
[the CLI1 downloads page](https://app-updates.agilebits.com/product_history/CLI ) to download the version you require
and follow instructions for your platform as long as it's major version 2.
The above commands pip commands will check `op` is present already and if not will install the supported `op` cli
plus the python client itself.
This is currently fixed at `op` version 1.12.5 to ensure compatibility. If you wish to use a higher version of `op` you
can by following [this guide](https://developer.1password.com/docs/cli/upgrade),
however note that we cannot ensure it will work with our client yet.
MacOS users will be prompted with a separate installation window to ensure you have a signed version of `op` - make
sure to check other desktops that the installer might pop up on.
### Optional pre-requisites
#### base32
This utility is used to create a unique guid for your device but this isn't a hard requirement from AgileBits
and so if you see `base32: command not found` an empty string will be used instead,
and the client will still work fully.
If you really want to, you can make sure you have this installed by installing coreutils. Details per platform can
be found here: https://command-not-found.com/base32
## Basic Usage
Since v2 of the cli it is advised to connect your CLI to the local app installed on the device, thus removing the need
for secret keys and passwords in the terminal or shell. Read here on how to do that:
https://developer.1password.com/docs/cli/get-started#step-2-turn-on-the-1password-desktop-app-integration
An added extra for Mac users is that you can also enable TouchID for the app and by linking your cli with the app you
will get biometric login for both.
Once this is done any initial usage of the cli, and our client will request you to authenticate either via the app or
using your biometrics and then you can continue.
We are sure there are use cases where the app cannot be linked and hence a password etc is till required so this
functionality is still present from our v1 implementation and can be described below
### Password authentication
On first usage users will be asked for both the enrolled email, secret key and password.
There is also verification of your account domain and name.
For all following usages you will only be asked for a password.
You will be given 3 attempts and then pointed to reset password documentation or alternatively you can
restart your kernel.
No passwords are stored in memory without encryption.
If you have 2FA turned on for your 1Password account the client will ask for your six digit authenticator code.
```python
from onepassword import OnePassword
import json
op = OnePassword()
# List all vaults
json.loads(op.list_vaults())
# List all items in a vault, default is Private
op.list_items()
# Get all fields, one field or more fields for an item with uuid="example"
op.get_item(uuid="example")
op.get_item(uuid="example", fields="username")
op.get_item(uuid="example", fields=["username", "password"])
```
##
### Input formats
To be sure what you are using is of the right format
- Enrolled email: standard email format e.g. [email protected]
- Secret key: provided by 1Password e.g. ##-######-######-#####-#####-#####-#####
- Account domain: domain that you would login to 1Password via browser e.g. example.1password.com
- Account name: subdomain or account name that cli can use for multiple account holders e.g. example
## Contributing
The GitHub action will run a full build, test and release on any push.
If this is to the main branch then this will release to public PyPi and bump the patch version.
For a major or minor branch update your new branch should include this new version and this should be verified by the
code owners.
In general, this means when contributing you should create a feature branch off of the main branch and without
manually bumping the version you can focus on development.
## CLI coverage
Full op documentation can be found here: https://support.1password.com/command-line-reference/
The below is correct as of version 0.3.0.
### Commands
This is the set of commands the current python SDK covers:
- create: Create an object
- document
- delete: Remove an object
- item: we use this method to remove documents but now there is a new delete document method
- get: Get details about an object
- document
- item
- list: List objects and events
- items
- vaults
- signin: Sign in to a 1Password account
- signout: Sign out of a 1Password account
This is what still needs developing due to new functionality being released:
- add: Grant access to groups or vaults
- group
- user
- completion: Generate shell completion information
- confirm: Confirm a user
- create: Create an object
- group
- user
- item
- vault
- delete: Remove an object
- document
- user
- vault
- group
- trash
- edit: Edit an object
- document
- group
- item
- user
- vault
- encode: Encode the JSON needed to create an item
- forget: Remove a 1Password account from this device
- get: Get details about an object
- account
- group
- template
- totp
- user
- vault
- list: List objects and events
- documents
- events
- groups
- templates
- users
- reactivate: Reactivate a suspended user
- remove: Revoke access to groups or vaults
- suspend: Suspend a user
- update: Check for and download updates
## Roadmap
- Add Windows functionality
- Add clean uninstall of client and op
- Remove subprocess usage everywhere -> use pexpect
- Add test docker image
- Get full UT coverage
- Align response types into JSON / lists instead of JSON strings
- Ensure full and matching functionality of CLI in python
- add
- confirm
- create
- delete
- edit
- encode
- forget
- get
- list
- reactivate
- remove
- suspend
|
1password
|
/1password-1.0.1.tar.gz/1password-1.0.1/README.md
|
README.md
|
import os
import wget
import zipfile
import platform
from subprocess import Popen, PIPE
cli_version = "2.19.0"
version_string = "v{}".format(cli_version)
os.environ["OP_VERSION_STR"] = version_string
platform_links = {
"Darwin": {
"x86_64": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_apple_universal_{}.pkg".format(version_string,
version_string),
"arm64": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_apple_universal_{}.pkg".format(version_string,
version_string),
"download_loc": "/usr/local/bin/"
},
"FreeBSD": {
"i386": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_freebsd_386_{}.zip".format(version_string,
version_string),
"i686": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_freebsd_386_{}.zip".format(version_string,
version_string),
"x86_64": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_freebsd_amd64_{}.zip".format(version_string,
version_string),
"arm": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_freebsd_arm_{}.zip".format(version_string,
version_string),
"aarch64_be": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_freebsd_arm_{}.zip".format(version_string,
version_string),
"aarch64": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_freebsd_arm_{}.zip".format(version_string,
version_string),
"armv8b": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_freebsd_arm_{}.zip".format(version_string,
version_string),
"armv8l": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_freebsd_arm_{}.zip".format(version_string,
version_string),
"download_loc": "/usr/local/bin/"
},
"Linux": {
"i386": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_linux_386_{}.zip".format(version_string,
version_string),
"i686": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_linux_386_{}.zip".format(version_string,
version_string),
"x86_64": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_linux_amd64_{}.zip".format(version_string,
version_string),
"aarch64_be": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_linux_arm_{}.zip".format(version_string,
version_string),
"aarch64": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_linux_arm_{}.zip".format(version_string,
version_string),
"armv8b": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_linux_arm_{}.zip".format(version_string,
version_string),
"armv8l": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_linux_arm_{}.zip".format(version_string,
version_string),
"arm": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_linux_arm_{}.zip".format(version_string,
version_string),
"download_loc": "/usr/local/bin/"
},
"OpenBSD": {
"i386": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_openbsd_386_{}.zip".format(version_string,
version_string),
"i686": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_openbsd_386_{}.zip".format(version_string,
version_string),
"x86_64": "https://cache.agilebits.com/dist/1P/op2/pkg/{}/op_openbsd_amd64_{}.zip".format(version_string,
version_string),
"download_loc": "/usr/local/bin/"
}
}
def read_bash_return(cmd, single=True):
process = os.popen(cmd)
preprocessed = process.read()
process.close()
if single:
return str(preprocessed.split("\n")[0])
else:
return str(preprocessed)
def mkdirpy(directory):
if not os.path.exists(directory):
os.makedirs(directory)
class CliInstaller: # pragma: no cover
def __init__(self):
self.system = str(platform.system())
machine = str(platform.machine())
self.link = platform_links[self.system][machine]
self.download_location = platform_links[self.system]["download_loc"]
def install(self):
if self.system in platform_links.keys():
self.install_linux_mac()
else:
raise OSError("Operating system not supported")
def check_install_required(self): # pragma: no cover
"""
Helper function to check if op cli is already installed
:returns: :obj:`bool`: True or False
"""
op = read_bash_return("op --version")
if op == "":
return True, self.download_location
else:
if op == cli_version:
return False, ""
else:
existing_location = read_bash_return("which op")
return True, existing_location
def install_linux_mac(self):
"""
Helper function to download, unzip, install and chmod op cli files
"""
install_check, install_loc = self.check_install_required()
if install_check:
if install_loc == self.download_location:
local_bin = self.download_location
else:
local_bin = install_loc
try:
os.chmod(local_bin, 0o755)
except PermissionError:
local_bin = os.path.join(os.environ["HOME"], "op-downloads")
mkdirpy(local_bin)
os.chmod(local_bin, 0o755)
op_file = self.link.split("/")[-1]
download_path = os.path.join(local_bin, op_file)
print('Downloading the 1Password CLI: {}'.format(op_file))
wget.download(self.link, download_path)
if self.link[-4:] != ".pkg":
zip_ref = zipfile.ZipFile(download_path, 'r')
zip_ref.extractall(local_bin)
zip_ref.close()
os.chmod(os.path.join(local_bin, 'op'), 0o755)
else:
Popen(["open", os.path.join(local_bin, op_file)], stdin=PIPE, stdout=PIPE) # pragma: no cover
else:
print("op already installed, with supported version.")
if __name__ == '__main__':
# Run wizard if executed from terminal
install_cli = CliInstaller()
install_cli.install()
print()
|
1password
|
/1password-1.0.1.tar.gz/1password-1.0.1/install_op.py
|
install_op.py
|
import os
from setuptools import setup
from setuptools.command.develop import develop
from setuptools.command.install import install
class PostDevelopCommand(develop):
"""Post-installation for development mode."""
def run(self):
develop.run(self)
from install_op import CliInstaller
install_cli = CliInstaller()
install_cli.install()
class PostInstallCommand(install):
"""Post-installation for installation mode."""
def run(self):
install.run(self)
from install_op import CliInstaller
install_cli = CliInstaller()
install_cli.install()
def readme():
with open('README.md') as f:
return f.read()
root_dir = os.getcwd()
with open(os.path.join(root_dir, 'VERSION')) as version_file:
version = version_file.read().strip()
setup(
name="1password",
version=version,
author="David Pryce",
author_email="[email protected]",
description="A Python client and wrapper around the 1Password CLI.",
long_description=readme(),
long_description_content_type='text/markdown',
install_requires=[
"wget",
"pyyaml",
"pycryptodome",
"pexpect"
],
python_requires='>=3.7',
license="MIT",
url="https://github.com/wandera/1password-client",
classifiers=["Programming Language :: Python :: 3 :: Only",
"License :: OSI Approved :: MIT License",
"Operating System :: MacOS :: MacOS X",
"Operating System :: POSIX",
"Operating System :: Unix"],
packages=["onepassword"],
tests_require=["nose", "mock", "pytest"],
test_suite="nose.collector",
cmdclass={
'develop': PostDevelopCommand,
'install': PostInstallCommand,
},
setup_requires=["wget"]
)
|
1password
|
/1password-1.0.1.tar.gz/1password-1.0.1/setup.py
|
setup.py
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.