Contents
Applications need some kind of configuration. There are different settings you might want to change depending on the application environment like toggling the debug mode, setting credentials etc.
-The way hexonet.apiconnector is designed usually requires the configuration to be -provided at runtime when connecting to the HEXONET Backend API. You can hardcode -the configuration in the code, which for many small scripts is for sure sufficient. -Realtime applications and frontends need to cover some application logic around -using this SDK like a login form and session management.
+The way hexonet.apiconnector is designed usually requires the configuration +to be provided at runtime when connecting to the HEXONET Backend API. You +can hardcode the configuration in the code, which for many small scripts is +for sure sufficient. Realtime applications and frontends need to cover some +application logic around using this SDK like a login form and session +management.
Configuration Basics¶
The configuration can be provided in two ways. @@ -187,21 +188,22 @@
OT&E System
LIVE System¶
-The real world system - This system and the use our services and products can lead
-to real costs depending on what you’re exactly doing.
+
The real world system - This system and the use our services and products can
+lead to real costs depending on what you’re exactly doing.
To use this system, set configuration value for property entity to 54cd.
Builtin Configuration Values¶
The following configuration values are used internally by hexonet.apiconnector:
-Up to now - none, but this might change in future as we are continously improving our SDKs.
+Up to now - none, but this might change in future as we are continously +improving our SDKs.
Table Of Contents
Contact Us¶
-There are several possibilities to get in touch with us, we list them in our preferred order.
+There are several possibilities to get in touch with us, we list them +in our preferred order.
- Slack
- Stack Overflow @@ -120,7 +121,8 @@
- our Support
Table Of Contents
Please file Bugs / Issues / Problems as new github issue to us. -Please read our Contributing first and use the search to check if this is already a known issue.
+Please read our Contributing first and use the search to check +if this is already a known issue.Table Of Contents
Debugging¶
There’s no debug feature available in hexonet.apiconnector up to now. -This is a planned feature and will come in near future as we continously improve our SDKs.
+This is a planned feature and will come in near future as we continously +improve our SDKs.Contents
Development Guide¶
Please read our Contributing guide lines first.
-
-
+
+
Requirements¶
+Requirements¶
You can find any required library for this project in the requirements.txt:
autopep8==1.3.5
docutils==0.14
@@ -162,10 +162,18 @@ Requirementstwine==1.11.0
NOTE: Make sure to have also all the extensions listed in the docs/conf.py that are required for the SDK Documentation.
-In addition, you need nodejs/npm with globally installed module auto-changelog in case you want to generate an update changelog version. +
You can install them by
+pip3 install -r requirements.txt
+NOTE: Make sure to have also all the extensions listed in the docs/conf.py +that are required for the SDK Documentation.
+In addition, you need nodejs/npm with globally installed module +auto-changelog in case you want to generate an update changelog version. We suggest to use nvm.
-We suggest to use Visual Studio Code with installed plugins for Python Development described here. But if you prefer any other IDE / Editor, it is fine.
+We suggest to use Visual Studio Code with installed plugins for Python +Development described here. But if you prefer any other IDE / Editor, it +is fine.
Run Tests and Code Validation¶
@@ -190,14 +198,18 @@Pull Request (PR) Procedure
Versioning¶
-We use SemVer for versioning. For the versions available, see the tags on this repository.
+We use SemVer for versioning. For the versions available, see the
+tags on this repository.
Releasing¶
@@ -210,8 +222,11 @@Releasing# push the tags to remote
Create a new release out of that new tag and provide release details about the changes applied in the git interface. In case of breaking changes, describe what has changed and how to migrate.
-Changes will be auto-deployed by a webhook to readthedocs.org and automatically updated on github pages.
+Create a new release out of that new tag and provide release details about +the changes applied in the git interface. In case of breaking changes, +describe what has changed and how to migrate.
+Changes will be auto-deployed by a webhook to readthedocs.org and +automatically updated on github pages.
Publish your changes to the Python Package Index (PyPi) by
./scripts/createdistribution.sh
# to create packages of the new distribution
@@ -223,16 +238,19 @@ Releasing# to upload the generated packages to the PyPi Index (pypi.org)
The module can be accessed on the PyPi (Live) Index and the PyPi (Test) Index.
+The module can be accessed on the PyPi (Live) Index and the +PyPi (Test) Index.
Generate SDK Documentation¶
Have an eye on the generated SDK Documentation.
-If you want to generate it from scratch out of the sources, please use composer together with our project as follows:
+If you want to generate it from scratch out of the sources, please use +the below script:
./scripts/generatedocs.sh
The generated files are then available in subfolder “docs/_build/html”. Commit and push the changes.
+The generated files are then available in subfolder “docs/_build/html”. +Commit and push the changes.
Update Changelog¶
diff --git a/docs/_build/html/foreword.html b/docs/_build/html/foreword.html index 855705f..2897825 100644 --- a/docs/_build/html/foreword.html +++ b/docs/_build/html/foreword.html @@ -135,24 +135,28 @@Contents
Foreword¶
-Read this before you get started with hexonet.apiconnector. This hopefully answers some -questions about the purpose and goals of the project.
+Read this before you get started with hexonet.apiconnector. This +hopefully answers some questions about the purpose and goals of +the project.
HEXONET¶
-We’re known as leading developers of domain technologies and as the worldwide experts in -domain names. Our team is focused, and continually driven to bring customers the best -technological solutions, TLD offerings, customer support, and domain products to make their -internet goals a reality. Whether you have one domain or tens of thousands with us, we -appreciate your business.
+We’re known as leading developers of domain technologies and as +the worldwide experts in domain names. Our team is focused, and +continually driven to bring customers the best technological +solutions, TLD offerings, customer support, and domain products +to make their internet goals a reality. Whether you have one +domain or tens of thousands with us, we appreciate your business.
Read more about us and our products and service on our homepage.
HEXONET Backend API¶
-HEXONET provides his products and services through a Backend System that is accessible by different options. -One of these options is a HTTP API for which we provide SDKs in different programming languages such as -go/golang, nodejs, php, python, java and perl. -The hexonet.apiconnector (aka python-sdk) is one of these connector libraries that help implementors to connect -their systems to the HEXONET Backend System.
+HEXONET provides his products and services through a Backend System +that is accessible by different options. One of these options is a +HTTP API for which we provide SDKs in different programming languages +such as go/golang, nodejs, php, python, java and perl. The +hexonet.apiconnector (aka python-sdk) is one of these connector +libraries that help implementors to connect their systems to the +HEXONET Backend System.
Continue to Installation or the Quickstart.
Contents
Welcome to hexonet.apiconnector¶
-Welcome to hexonet.apiconnector’s documentation. Get started with Installation -and then get an overview with the Quickstart. There is also a Demo App available for -any of our SDK libraries. The one for hexonet.apiconnector (python-sdk) is available at github.
-The rest of the docs describe each component of hexonet.apiconnector in detail, with a full -reference in the SDK Documentation section.
+Welcome to hexonet.apiconnector’s documentation. Get started with +Installation and then get an overview with the Quickstart. +There is also a Demo App available for any of our SDK libraries. The +one for hexonet.apiconnector (python-sdk) is available at github.
+The rest of the docs describe each component of hexonet.apiconnector in +detail, with a full reference in the SDK Documentation section.
Usage Guide¶
This part of the documentation, which is mostly prose, begins with some diff --git a/docs/_build/html/installation.html b/docs/_build/html/installation.html index 3d76a99..a269ade 100644 --- a/docs/_build/html/installation.html +++ b/docs/_build/html/installation.html @@ -139,16 +139,21 @@
Contents
Installation¶
Python Version¶
-We recommend using the latest version of Python 3. hexonet.apiconnector supports Python 3.x and 2.7.
+We recommend using the latest version of Python 3. hexonet.apiconnector +supports Python 3.x and 2.7.
Dependencies¶
-There are NO dependencies to install. If this changes, we will list them here and they will be installed -automatically when hexonet.apiconnector is getting installed.
+There are NO dependencies to install. If this changes, we will list them +here and they will be installed automatically when hexonet.apiconnector +is getting installed.
+There are dependencies that we just need in steps of +our build process.
Installation¶
-Within the your environment, use the following command to install hexonet.apiconnector:
+Within the your environment, use the following command to install +hexonet.apiconnector:
pip install hexonet.apiconnector
# for python 2.x
@@ -156,7 +161,8 @@ Installation# for python 3.x
The connector library is now installed. Check out the Quickstart or go to the +
The connector library is now installed. Check out the +Quickstart or go to the Documentation Overview.
General License DefinitionsAuthors section.
diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
index 871f7a3..c60306c 100644
Binary files a/docs/_build/html/objects.inv and b/docs/_build/html/objects.inv differ
diff --git a/docs/_build/html/quickstart.html b/docs/_build/html/quickstart.html
index 9fad0fc..a5a56f3 100644
--- a/docs/_build/html/quickstart.html
+++ b/docs/_build/html/quickstart.html
@@ -137,9 +137,9 @@
A Minimal ApplicationSo what did that code do?
diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
index d4ef947..1e24a5e 100644
--- a/docs/_build/html/searchindex.js
+++ b/docs/_build/html/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["api","api/hexonet.apiconnector","changelog","config","contactus","contributing","debugging","developmentguide","foreword","index","installation","license","quickstart","upgrading"],envversion:{"sphinx.domains.c":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":1,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,sphinx:54},filenames:["api.rst","api/hexonet.apiconnector.rst","changelog.rst","config.rst","contactus.rst","contributing.md","debugging.rst","developmentguide.rst","foreword.rst","index.rst","installation.rst","license.rst","quickstart.rst","upgrading.rst"],objects:{"hexonet.apiconnector":{connect:[1,1,1,""],connection:[1,0,0,"-"],response:[1,0,0,"-"],util:[1,0,0,"-"]},"hexonet.apiconnector.connection":{Connection:[1,2,1,""]},"hexonet.apiconnector.connection.Connection":{call:[1,3,1,""],call_raw:[1,3,1,""],call_raw_http:[1,3,1,""]},"hexonet.apiconnector.response":{Response:[1,2,1,""]},"hexonet.apiconnector.response.Response":{as_hash:[1,3,1,""],as_list:[1,3,1,""],as_list_hash:[1,3,1,""],as_string:[1,3,1,""],code:[1,3,1,""],columns:[1,3,1,""],count:[1,3,1,""],description:[1,3,1,""],first:[1,3,1,""],is_success:[1,3,1,""],is_tmp_error:[1,3,1,""],last:[1,3,1,""],lastpagefirst:[1,3,1,""],limit:[1,3,1,""],nextpage:[1,3,1,""],nextpagefirst:[1,3,1,""],page:[1,3,1,""],pages:[1,3,1,""],prevpage:[1,3,1,""],prevpagefirst:[1,3,1,""],properties:[1,3,1,""],property:[1,3,1,""],queuetime:[1,3,1,""],runtime:[1,3,1,""],total:[1,3,1,""]},"hexonet.apiconnector.util":{base64_decode:[1,1,1,""],base64_encode:[1,1,1,""],command_encode:[1,1,1,""],response_to_hash:[1,1,1,""],response_to_list_hash:[1,1,1,""],sqltime:[1,1,1,""],timesql:[1,1,1,""],url_decode:[1,1,1,""],url_encode:[1,1,1,""]},hexonet:{apiconnector:[1,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"01fe1e0":2,"01fe1e0b858690ad95a3e611b9871067af3132b":2,"09997081ddf7c65a6f25fa1827cfb07fd68f82c5":2,"1api":[3,12],"27564296dcd0e0a388ce45b0e77c467e6d927a31":2,"2d98115":2,"2d9811500081c0940e3f340af9265b1c66f36893":2,"400e58b":2,"400e58b5d2c0db4102ad207c65845a537d95aa93":2,"54cd":[3,12],"5642b54":2,"5642b54c25dd3410f699fb54e0f97a4ee1957109":2,"5dc88d4":2,"5dc88d4a85f90a7154d0ccde4df33faff0874591":2,"655b886":2,"655b88658c9c0b1db1be39af8700eb900a19ec87":2,"67430e3":2,"67430e3419237823839b2946c324a93d7d8de22c":2,"85ec52f":2,"85ec52f18007de6a9d37889cd1b20711968749fa":2,"88cedbf":2,"88cedbf82075e19a957349dbc14b2836d99f2117":2,"946bc01":2,"946bc01b7c3505c28400aca50b9d9d4d4de33684":2,"95e0199":2,"95e0199073c19f842778d133ceea8d11a7f64d":2,"9e775a8":2,"9e775a850af227ecfd227b3b838f989daf63edff":2,"break":[7,13],"case":7,"class":[0,1,3,9],"function":[0,1,9],"import":[2,3,12],"long":11,"new":[4,5,7,13],"public":5,"return":[1,9],"short":[7,11],"true":1,"try":2,"while":13,AND:11,BUT:11,Being:5,But:7,FOR:11,For:[7,11],IDE:7,NOT:11,One:8,Such:13,THE:11,The:[3,4,5,7,8,9,10,11,12],Then:7,There:[3,4,6,7,9,10],These:13,USE:11,Use:[12,13],Using:[3,5],WITH:11,_build:7,a0f7e2f3418d238f2d4884d786c0d62383d3d0c9:2,a0f7e2f:2,a4bd9606e5590388fac9f96c5621a9e03fd125c6:2,a4bd960:2,a9ec1a1547637535220b33eb86a8172a53634879:2,a9ec1a1:2,aa2bc4d5f92720c22b7853371ade371e1f95b9dd:2,aa2bc4d:2,about:[5,7,8,9],abov:[11,12],abus:5,accept:5,access:[7,8,12],accordingli:[3,7],account:[5,12],act:5,action:[5,11],adapt:5,add:2,added:2,adding:11,addit:7,address:[5,12],advanc:5,advantag:13,after:7,age:5,aka:8,align:[5,7],all:[2,5,7,11,12],allow:[3,12],alreadi:[4,12],also:[2,7,9,12],analysi:12,ani:[1,5,7,9,11,13],anoth:12,answer:8,anthoni:11,anyth:13,api:[1,3,9,12],apiconnector:[0,2,3,6,8,10,11,12,13],app:[9,12],appear:5,appli:[5,7,11],applic:[3,9],appoint:5,appreci:[8,11],appropri:5,aris:11,around:3,arrai:1,as_hash:[1,12],as_list:[1,12],as_list_hash:[1,12],as_str:1,associ:11,assum:12,attack:5,attent:5,author:[4,9],auto:[2,7],autofix:7,autom:7,automat:[7,10],autopep8:7,avail:[3,5,6,7,9,12],backend:[3,9],background:9,backward:2,ban:5,base64:1,base64_decod:1,base64_encod:1,base:[1,12],basic:[9,11],bd7dc80:2,bd7dc80c9decaccb480333aa4fe51db0c3722389:2,befor:[3,5,7,8],begin:9,behavior:5,below:[7,11],best:[5,8],better:11,bin:12,binari:1,bit:[1,7],block:12,bodi:[1,5],both:[3,5],branch:7,bring:8,bug:4,build:[5,7],builtin:9,busi:8,c5601be:2,c5601beb264c7b7e763e88e11aafcc93da310edd:2,c89c917845cda5cef9e4f3a4fb5dc9d022e48006:2,c89c917:2,cabinet:7,call:[1,3,12],call_raw:1,call_raw_http:1,can:[3,7,11,12],care:[5,7],cgi:[3,12],chang:[2,3,5,7,10,13],changelog:9,charg:[3,11],check:[4,7,10],circumst:5,claim:11,clarifi:5,clean:1,clone:7,code:[1,2,3,9,11,12,13],column:1,com:[2,3,7],come:[6,7],command:[1,10,12,13],command_encod:1,comment:[5,11],commit:[2,5,7],commun:[5,12],compat:2,complaint:5,complet:[1,3],compon:9,compos:7,condit:11,conduct:9,conf:7,confidenti:5,config:1,configur:[9,12],connect:[1,3,8,11,12],connector:[8,9,10],consid:[3,5],construct:5,contact:[5,9,12],contain:[5,11],contin:[3,6],continu:8,contract:11,contribut:[4,7,9],contributor:[5,11],conveni:1,convert:1,cookpet:2,copi:11,copyright:11,coreapi:[3,12],correct:5,cost:3,could:[5,12],count:1,coven:5,cover:[3,13],creat:[2,5,7,12],createdistribut:7,credenti:3,critic:5,curl:1,current:[1,7],custom:8,d3fa6a:2,d3fa6ae84e8bc0c6ec941964445085b5ea3f3da6:2,damag:11,data:[1,12],date:2,datetim:1,deal:11,debug:9,decod:1,deem:5,defin:[5,12],definit:9,demo:[9,12],depend:[3,5,9],deploi:7,derogatori:5,describ:[7,9],descript:[1,12],design:[1,3,9],desir:7,detail:[5,7,9],determin:5,dev:7,develop:[8,9,11],did:12,differ:[3,5,8],disabl:5,discuss:5,displai:2,distribut:[7,11],doc:[7,9],document:[2,10,11],docutil:7,doing:[3,5],domain:8,don:[12,13],driven:8,e3042628792eefce6168b93220308b138647c8f0:2,e304262:2,each:9,eager:12,eb2ac4c6458a3620938e429878582e0b1ab93f00:2,eb2ac4c:2,eb5e6d408f088b34172414ed9283fb0fc20e3df3:2,eb5e6d4:2,edit:5,editor:7,egg:7,electron:5,element:1,email:5,empathi:5,encod:[1,2],end:5,ensur:5,entiti:[1,3,12],environ:[5,9,10],error:[1,9],etc:[3,5],ethnic:5,evalu:3,event:[5,11],everi:13,everyon:5,exactli:3,exampl:[5,11],exist:13,expect:5,experi:5,expert:8,explicit:5,expos:5,express:[5,11],extend:11,extens:7,eye:7,f1804eb7bbb48c6e338f5b065dc935820ddcc595:2,f1804eb:2,fa7403a9b18dc11b9cf8c74da603c12cee01477a:2,fa7403a:2,face:5,fair:5,faith:5,featur:[6,9,13],feel:12,file:[2,4,5,7,11],filter:12,find:7,fine:7,first:[1,3,4,5,7,12],fit:11,fix:[2,7],focus:[5,8,9],follow:[3,5,7,10,11],foreword:9,fork:7,form:3,format:12,foster:5,found:[1,11],free:[3,5,11,12],from:[3,5,7,11,13],frontend:3,full:[9,11],furnish:11,further:[5,7,12],futur:[3,6],gender:5,gener:[2,9,12,13],generatedoc:7,get:[4,8,9,10,12],git:7,github:[2,4,7,9,11],gitignor:2,give:12,given:1,global:7,gmbh:11,goal:8,going:3,golang:8,good:[5,12],got:12,gracefulli:5,grant:11,guzzl:7,handl:9,harass:5,hardcod:3,harm:5,has:7,hash:1,have:[5,7,8,12,13],head:12,help:[8,11,12],here:[7,9,10,12],herebi:11,hexonet:[0,2,3,6,10,11,12,13],hexotestman:3,his:8,holder:11,homepag:8,hopefulli:8,how:[7,12,13],howev:13,html:7,http:[1,2,3,5,8,12],hxclient:3,ident:5,ignor:2,imageri:5,implement:11,implementor:8,impli:11,improv:[3,6,13],inappropri:5,incid:5,includ:[5,11],inclus:5,index:[1,7],individu:5,inform:[0,5,9,13],initi:2,insert:5,instal:[5,7,8,9,12,13],instanc:[1,5,12],instead:2,instruct:9,insult:5,integr:3,interact:5,interest:[5,9],interfac:[5,7],intern:3,internet:8,introduc:2,introduct:12,investig:5,is_success:1,is_tmp_error:1,ispapi:12,issu:[4,5,7,12],its:5,itself:[11,13],java:8,jira:2,juli:2,just:[3,7,9],kai:11,keep:7,kind:[3,11,13],known:[4,8],languag:[5,7,8],last:1,lastpagefirst:1,latest:10,layer:[1,5],lead:[3,8],leadership:5,left:7,legal:9,level:5,liabil:11,liabl:11,librari:[7,8,9,10,11,12],licens:9,like:[3,5,7,12,13],limit:[1,11,12],line:7,list:[1,4,7,10,11],live:7,locat:5,log:7,logic:3,login:[1,3,12],look:[9,12],m2r:7,made:11,mai:5,mail:[1,5],maintain:5,major:13,make:[1,5,7,8,13],manag:3,mani:3,master:7,media:5,member:5,merchant:11,merg:[7,11],method:[0,5,9,12],might:[3,7,12],migrat:[7,13],mime:1,minim:9,minor:13,mit:9,miyakogi:7,mode:3,modifi:11,modul:[7,11],more:8,most:13,mostli:9,much:11,name:8,nation:5,necessari:[5,12],need:[3,7,12],net:[3,12],newer:9,next:[1,12],nextpag:1,nextpagefirst:1,nice:13,nodej:[7,8],none:[1,3],noninfring:11,notabl:2,note:[5,7,13],notic:11,now:[3,6,10],npm:7,number:1,nvm:7,object:1,oblig:5,obtain:11,offens:5,offer:8,offici:5,offlin:5,onc:13,one:[8,9,12],onli:11,onlin:5,open:[5,7],oper:3,option:[8,12],order:4,org:[5,7],orient:5,origin:11,other:[5,7,11],otherwis:[5,11],our:[3,4,6,7,8,9],out:[7,10,11],over:[1,12,13],overflow:4,overview:[9,10],own:13,owner:5,packag:[0,2,7,9],page:[1,7,12],paramet:[5,13],part:[1,9,11],particip:5,particular:11,passw0rd:[3,12],password:[1,3,12],patch:[11,13],path:2,peopl:11,pep8:[2,7],pep8fix:7,pep9check:7,perl:8,perman:5,permiss:[5,11],permit:11,person:[5,11],php:8,physic:5,pip3:[10,13],pip:[10,13],plai:3,plan:[3,6,7,12],pleas:[4,5,7],plugin:7,polici:5,polit:5,port:5,portion:11,posit:5,possibl:[4,7,13],post:5,prefer:[4,7],previou:1,prevpag:1,prevpagefirst:1,privat:5,problem:[2,4],procedur:9,process:9,product:[3,8,12],profession:5,profit:13,program:8,project:[2,5,7,8],properti:[1,2,3],prose:9,provid:[3,7,8,11,12,13],publish:[5,7,11,13],pull:9,purpos:[8,11],push:7,py2:2,py3:2,pycodestyl:7,pypi:[2,7],python2:2,python:[2,3,7,8,9,12,13],qualiti:13,queri:1,querydomainlist:12,question:8,queuetim:1,quickstart:[8,9,10],race:5,read:[4,7,8,13],readm:[2,5],readthedoc:7,real:3,realeas:7,realiti:8,realiz:7,realtim:3,reason:[5,12],recommend:10,refactor:2,refer:[7,9,11],reflect:11,regard:5,regardless:5,registr:3,reject:5,releas:[2,9],religion:5,remot:7,remoteaddr:12,remov:5,renam:2,repercuss:5,replac:7,report:5,repositori:[5,7],repres:5,represent:5,request:[9,12],requir:[3,9,13],respect:5,respons:[1,11,12],response_to_hash:1,response_to_list_hash:1,rest:[7,9],restrict:11,result:[1,2,5,12],review:[5,11],rewrit:12,rhash:12,right:[5,11],rlist:12,rlisthash:12,role:[1,3,7,12],run:9,runtim:[1,3],sandbox:3,schneider:11,schwarz:11,scratch:7,script:[2,3,7],sdk:[2,3,6,8,12],search:4,section:[7,9,11,12],see:[7,11,13],seen:3,sell:11,semver:7,separ:[3,5],servic:[3,8],session:[3,9],sessionless:12,set:[2,3,5],sever:4,sexual:5,shall:11,ship:11,show:[5,12],sign:12,six:[2,7],size:5,slack:4,small:3,social:5,softwar:[11,13],solut:8,some:[3,8,9,12,13],someth:12,sourc:[7,11],space:5,specif:[0,5,9],specifi:3,sphinx:7,sphinxcontrib:7,sql:1,sqldatetim:1,sqltime:1,stack:4,stand:3,start:[1,8,9,12],step:[5,9],stop:7,string:1,studio:7,subfold:[2,7],subject:11,sublicens:11,submodul:0,substanti:11,subus:3,succe:7,success:1,suffici:3,suggest:7,support:[2,4,7,8,10],sure:[3,7],surviv:1,system:[8,9],sytem:3,tag:7,take:[5,7,13],team:[5,8],technolog:8,temporari:5,temporarili:5,ten:8,test:[2,3,9,12],testrol:3,text:11,thei:[5,10],them:[4,10],theme:7,thi:[1,2,3,4,5,6,7,8,9,10,11,12],thing:[3,7],thousand:8,threaten:5,through:[1,8,12,13],thu:[7,11],tia:7,time:[7,13],timesql:1,timestamp:1,tld:8,tmp:1,togeth:7,toggl:3,tort:11,total:1,touch:4,toward:5,transport:1,troll:5,twine:7,two:3,txt:7,unaccept:5,under:11,unittest:11,unix:1,unwelcom:5,updat:[2,5,9],upgrad:9,upload:[2,7],uploaddistribution_l:7,uploaddistribution_test:7,url:[1,2,3,12],url_decod:1,url_encod:1,use:[2,3,4,5,7,10,11,12],used:[1,3],useful:5,user:[1,3,12],using:[3,5,10,12],usr:12,usual:3,utc:2,util:1,valid:9,valu:9,variabl:5,version:[2,5,9],via:[2,5],view:3,viewpoint:5,visual:7,vscode:2,wai:3,want:[3,7,11,12],warranti:11,webhook:7,websupport:7,welcom:5,well:[11,12],what:[3,5,7,9],whatev:11,when:[1,3,5,10],where:13,whether:[8,11],which:[3,5,8,9],who:[5,11],whom:11,wiki:5,wish:5,within:[5,10],without:[5,11],work:12,world:3,worldwid:8,worri:7,www:12,yet:12,you:[3,5,7,8,9,11,12,13],your:[3,5,7,8,10,12,13]},titles:["SDK Documentation","hexonet.apiconnector package","Changelog","Configuration Handling","Contact Us","Contributing","Debugging","Development Guide","Foreword","Welcome to hexonet.apiconnector","Installation","License","Quickstart","Upgrading to Newer Releases"],titleterms:{"return":12,addit:9,api:8,apiconnector:[1,9],applic:12,attribut:5,author:11,backend:[8,12],basic:3,builtin:3,changelog:[2,7],code:[5,7],conduct:5,configur:3,contact:4,contribut:5,debug:[3,6],definit:11,depend:10,develop:7,document:[0,7,9],enforc:5,environ:3,error:12,featur:3,foreword:8,gener:[7,11],guid:[7,9],handl:3,hexonet:[1,8,9],instal:10,just:12,licens:11,live:3,minim:12,mit:11,newer:13,note:9,our:5,packag:1,pledg:5,procedur:7,process:5,pull:[5,7],python:10,quickstart:12,releas:[7,13],request:[5,7],requir:7,respons:5,run:7,scope:5,sdk:[0,7,9],session:12,standard:5,submodul:1,system:[3,12],test:7,updat:7,upgrad:13,usag:9,valid:7,valu:3,version:[7,10],welcom:9,what:12}})
\ No newline at end of file
+Search.setIndex({docnames:["api","api/hexonet.apiconnector","changelog","config","contactus","contributing","debugging","developmentguide","foreword","index","installation","license","quickstart","upgrading"],envversion:{"sphinx.domains.c":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":1,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,sphinx:54},filenames:["api.rst","api/hexonet.apiconnector.rst","changelog.rst","config.rst","contactus.rst","contributing.rst","debugging.rst","developmentguide.rst","foreword.rst","index.rst","installation.rst","license.rst","quickstart.rst","upgrading.rst"],objects:{"hexonet.apiconnector":{connect:[1,1,1,""],connection:[1,0,0,"-"],response:[1,0,0,"-"],util:[1,0,0,"-"]},"hexonet.apiconnector.connection":{Connection:[1,2,1,""]},"hexonet.apiconnector.connection.Connection":{call:[1,3,1,""],call_raw:[1,3,1,""],call_raw_http:[1,3,1,""]},"hexonet.apiconnector.response":{Response:[1,2,1,""]},"hexonet.apiconnector.response.Response":{as_hash:[1,3,1,""],as_list:[1,3,1,""],as_list_hash:[1,3,1,""],as_string:[1,3,1,""],code:[1,3,1,""],columns:[1,3,1,""],count:[1,3,1,""],description:[1,3,1,""],first:[1,3,1,""],is_success:[1,3,1,""],is_tmp_error:[1,3,1,""],last:[1,3,1,""],lastpagefirst:[1,3,1,""],limit:[1,3,1,""],nextpage:[1,3,1,""],nextpagefirst:[1,3,1,""],page:[1,3,1,""],pages:[1,3,1,""],prevpage:[1,3,1,""],prevpagefirst:[1,3,1,""],properties:[1,3,1,""],property:[1,3,1,""],queuetime:[1,3,1,""],runtime:[1,3,1,""],total:[1,3,1,""]},"hexonet.apiconnector.util":{base64_decode:[1,1,1,""],base64_encode:[1,1,1,""],command_encode:[1,1,1,""],response_to_hash:[1,1,1,""],response_to_list_hash:[1,1,1,""],sqltime:[1,1,1,""],timesql:[1,1,1,""],url_decode:[1,1,1,""],url_encode:[1,1,1,""]},hexonet:{apiconnector:[1,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"01fe1e0":2,"01fe1e0b858690ad95a3e611b9871067af3132b":2,"09997081ddf7c65a6f25fa1827cfb07fd68f82c5":2,"1api":[3,12],"27564296dcd0e0a388ce45b0e77c467e6d927a31":2,"2d98115":2,"2d9811500081c0940e3f340af9265b1c66f36893":2,"400e58b":2,"400e58b5d2c0db4102ad207c65845a537d95aa93":2,"54cd":[3,12],"5642b54":2,"5642b54c25dd3410f699fb54e0f97a4ee1957109":2,"5dc88d4":2,"5dc88d4a85f90a7154d0ccde4df33faff0874591":2,"655b886":2,"655b88658c9c0b1db1be39af8700eb900a19ec87":2,"67430e3":2,"67430e3419237823839b2946c324a93d7d8de22c":2,"85ec52f":2,"85ec52f18007de6a9d37889cd1b20711968749fa":2,"88cedbf":2,"88cedbf82075e19a957349dbc14b2836d99f2117":2,"946bc01":2,"946bc01b7c3505c28400aca50b9d9d4d4de33684":2,"95e0199":2,"95e0199073c19f842778d133ceea8d11a7f64d":2,"9e775a8":2,"9e775a850af227ecfd227b3b838f989daf63edff":2,"break":[7,13],"case":7,"class":[0,1,3,9],"function":[0,1,9],"import":[2,3,12],"long":11,"new":[4,5,7,13],"public":5,"return":[1,9],"short":[7,11],"true":1,"try":2,"while":13,AND:11,BUT:11,Being:5,But:7,FOR:11,For:[7,11],IDE:7,NOT:11,One:8,Such:13,THE:11,The:[3,4,5,7,8,9,10,11,12],Then:7,There:[3,4,6,7,9,10],These:13,USE:11,Use:[12,13],Using:[3,5],WITH:11,_build:7,a0f7e2f3418d238f2d4884d786c0d62383d3d0c9:2,a0f7e2f:2,a4bd9606e5590388fac9f96c5621a9e03fd125c6:2,a4bd960:2,a9ec1a1547637535220b33eb86a8172a53634879:2,a9ec1a1:2,aa2bc4d5f92720c22b7853371ade371e1f95b9dd:2,aa2bc4d:2,about:[5,7,8,9],abov:[11,12],abus:5,accept:5,access:[7,8,12],accordingli:[3,7],account:[5,12],act:5,action:[5,11],adapt:5,add:2,added:2,adding:11,addit:7,address:[5,12],advanc:5,advantag:13,after:7,age:5,aka:8,align:[5,7],all:[2,5,7,11,12],allow:[3,12],alreadi:[4,12],also:[2,7,9,12],analysi:12,ani:[1,5,7,9,11,13],anoth:12,answer:8,anthoni:11,anyth:13,api:[1,3,9,12],apiconnector:[0,2,3,6,8,10,11,12,13],app:[9,12],appear:5,appli:[5,7,11],applic:[3,9],appoint:5,appreci:[8,11],appropri:5,aris:11,around:3,arrai:1,as_hash:[1,12],as_list:[1,12],as_list_hash:[1,12],as_str:1,associ:11,assum:12,attack:5,attent:5,author:[4,9],auto:[2,7],autofix:7,autom:7,automat:[7,10],autopep8:7,avail:[3,5,6,7,9,12],backend:[3,9],background:9,backward:2,ban:5,base64:1,base64_decod:1,base64_encod:1,base:[1,12],basic:[9,11],bd7dc80:2,bd7dc80c9decaccb480333aa4fe51db0c3722389:2,befor:[3,5,7,8],begin:9,behavior:5,below:[7,11],best:[5,8],better:11,bin:12,binari:1,bit:[1,7],block:12,bodi:[1,5],both:[3,5],branch:7,bring:8,bug:4,build:[5,7,10],builtin:9,busi:8,c5601be:2,c5601beb264c7b7e763e88e11aafcc93da310edd:2,c89c917845cda5cef9e4f3a4fb5dc9d022e48006:2,c89c917:2,cabinet:7,call:[1,3,12],call_raw:1,call_raw_http:1,can:[3,7,11,12],care:[5,7],cgi:[3,12],chang:[2,3,5,7,10,13],changelog:9,charg:[3,11],check:[4,7,10],circumst:5,claim:11,clarifi:5,clean:1,clone:7,code:[1,2,3,9,11,12,13],column:1,com:[2,3,7],come:[6,7],command:[1,10,12,13],command_encod:1,comment:[5,11],commit:[2,5,7],commun:[5,12],compat:2,complaint:5,complet:[1,3],compon:9,condit:11,conduct:9,conf:7,confidenti:5,config:1,configur:[9,12],connect:[1,3,8,11,12],connector:[8,9,10],consid:[3,5],construct:5,contact:[5,9,12],contain:[5,11],contin:[3,6],continu:8,contract:11,contribut:[4,7,9],contributor:[5,11],conveni:1,convert:1,cookpet:2,copi:11,copyright:11,coreapi:[3,12],correct:5,cost:3,could:[5,12],count:1,coven:5,cover:[3,13],creat:[2,5,7,12],createdistribut:7,credenti:3,critic:5,curl:1,current:[1,7],custom:8,d3fa6a:2,d3fa6ae84e8bc0c6ec941964445085b5ea3f3da6:2,damag:11,data:[1,12],date:2,datetim:1,deal:11,debug:9,decod:1,deem:5,defin:[5,12],definit:9,demo:[9,12],depend:[3,5,9],deploi:7,derogatori:5,describ:[7,9],descript:[1,12],design:[1,3,9],desir:7,detail:[5,7,9],determin:5,dev:7,develop:[8,9,11],did:12,differ:[3,5,8],disabl:5,discuss:5,displai:2,distribut:[7,11],doc:[7,9],document:[2,10,11],docutil:7,doing:[3,5],domain:8,don:[12,13],driven:8,e3042628792eefce6168b93220308b138647c8f0:2,e304262:2,each:9,eager:12,eb2ac4c6458a3620938e429878582e0b1ab93f00:2,eb2ac4c:2,eb5e6d408f088b34172414ed9283fb0fc20e3df3:2,eb5e6d4:2,edit:5,editor:7,egg:7,electron:5,element:1,email:5,empathi:5,encod:[1,2],end:5,ensur:5,entiti:[1,3,12],environ:[5,9,10],error:[1,9],etc:[3,5],ethnic:5,evalu:3,event:[5,11],everi:13,everyon:5,exactli:3,exampl:[5,11],exist:13,expect:5,experi:5,expert:8,explicit:5,expos:5,express:[5,11],extend:11,extens:7,eye:7,f1804eb7bbb48c6e338f5b065dc935820ddcc595:2,f1804eb:2,fa7403a9b18dc11b9cf8c74da603c12cee01477a:2,fa7403a:2,face:5,fair:5,faith:5,featur:[6,9,13],feel:12,file:[2,4,5,7,11],filter:12,find:7,fine:7,first:[1,3,4,5,7,12],fit:11,fix:[2,7],focus:[5,8,9],follow:[3,5,10,11],foreword:9,fork:7,form:3,format:12,foster:5,found:[1,11],free:[3,5,11,12],from:[3,5,7,11,13],frontend:3,full:[9,11],furnish:11,further:[5,7,12],futur:[3,6],gender:5,gener:[2,9,12,13],generatedoc:7,get:[4,8,9,10,12],git:7,github:[2,4,7,9,11],gitignor:2,give:12,given:1,global:7,gmbh:11,goal:8,going:3,golang:8,good:[5,12],got:12,gracefulli:5,grant:11,guzzl:7,handl:9,harass:5,hardcod:3,harm:5,has:7,hash:1,have:[5,7,8,12,13],head:12,help:[8,11,12],here:[7,9,10,12],herebi:11,hexonet:[0,2,3,6,10,11,12,13],hexotestman:3,his:8,holder:11,homepag:8,hopefulli:8,how:[7,12,13],howev:13,html:7,http:[1,2,3,5,8,12],hxclient:3,ident:5,ignor:2,imageri:5,implement:11,implementor:8,impli:11,improv:[3,6,13],inappropri:5,incid:5,includ:[5,11],inclus:5,index:[1,7],individu:5,inform:[0,5,9,13],initi:2,insert:5,instal:[5,7,8,9,12,13],instanc:[1,5,12],instead:2,instruct:9,insult:5,integr:3,interact:5,interest:[5,9],interfac:[5,7],intern:3,internet:8,introduc:2,introduct:12,investig:5,is_success:1,is_tmp_error:1,ispapi:12,issu:[4,5,7,12],its:5,itself:[11,13],java:8,jira:2,juli:2,just:[3,7,9,10],kai:11,keep:7,kind:[3,11,13],known:[4,8],languag:[5,7,8],last:1,lastpagefirst:1,latest:10,layer:[1,5],lead:[3,8],leadership:5,left:7,legal:9,level:5,liabil:11,liabl:11,librari:[7,8,9,10,11,12],licens:9,like:[3,5,7,12,13],limit:[1,11,12],line:7,list:[1,4,7,10,11],live:7,locat:5,log:7,logic:3,login:[1,3,12],look:[9,12],m2r:7,made:11,mai:5,mail:[1,5],maintain:5,major:13,make:[1,5,7,8,13],manag:3,mani:3,master:7,media:5,member:5,merchant:11,merg:[7,11],method:[0,5,9,12],might:[3,7,12],migrat:[7,13],mime:1,minim:9,minor:13,mit:9,miyakogi:7,mode:3,modifi:11,modul:[7,11],more:8,most:13,mostli:9,much:11,name:8,nation:5,necessari:[5,12],need:[3,7,10,12],net:[3,12],newer:9,next:[1,12],nextpag:1,nextpagefirst:1,nice:13,nodej:[7,8],none:[1,3],noninfring:11,notabl:2,note:[5,7,13],notic:11,now:[3,6,10],npm:7,number:1,nvm:7,object:1,oblig:5,obtain:11,offens:5,offer:8,offici:5,offlin:5,onc:13,one:[8,9,12],onli:11,onlin:5,open:[5,7],oper:3,option:[8,12],order:4,org:[5,7],orient:5,origin:11,other:[5,7,11],otherwis:[5,11],our:[3,4,6,7,8,9,10],out:[7,10,11],over:[1,12,13],overflow:4,overview:[9,10],own:13,owner:5,packag:[0,2,7,9],page:[1,7,12],paramet:[5,13],part:[1,9,11],particip:5,particular:11,passw0rd:[3,12],password:[1,3,12],patch:[11,13],path:2,peopl:11,pep8:[2,7],pep8fix:7,pep9check:7,perl:8,perman:5,permiss:[5,11],permit:11,person:[5,11],php:8,physic:5,pip3:[7,10,13],pip:[10,13],plai:3,plan:[3,6,7,12],pleas:[4,5,7],plugin:7,polici:5,polit:5,port:5,portion:11,posit:5,possibl:[4,7,13],post:5,prefer:[4,7],previou:1,prevpag:1,prevpagefirst:1,privat:5,problem:[2,4],procedur:9,process:[9,10],product:[3,8,12],profession:5,profit:13,program:8,project:[2,5,7,8],properti:[1,2,3],prose:9,provid:[3,7,8,11,12,13],publish:[5,7,11,13],pull:9,purpos:[8,11],push:7,py2:2,py3:2,pycodestyl:7,pypi:[2,7],python2:2,python:[2,3,7,8,9,12,13],qualiti:13,queri:1,querydomainlist:12,question:8,queuetim:1,quickstart:[8,9,10],race:5,read:[4,7,8,13],readm:[2,5],readthedoc:7,real:3,realeas:7,realiti:8,realiz:7,realtim:3,reason:[5,12],recommend:10,refactor:2,refer:[7,9,11],reflect:11,regard:5,regardless:5,registr:3,reject:5,releas:[2,9],religion:5,remot:7,remoteaddr:12,remov:5,renam:2,repercuss:5,replac:7,report:5,repositori:[5,7],repres:5,represent:5,request:[9,12],requir:[3,9,13],respect:5,respons:[1,11,12],response_to_hash:1,response_to_list_hash:1,rest:[7,9],restrict:11,result:[1,2,5,12],review:[5,11],rewrit:12,rhash:12,right:[5,11],rlist:12,rlisthash:12,role:[1,3,7,12],run:9,runtim:[1,3],sandbox:3,schneider:11,schwarz:11,scratch:7,script:[2,3,7],sdk:[2,3,6,8,12],search:4,section:[7,9,11,12],see:[7,11,13],seen:3,sell:11,semver:7,separ:[3,5],servic:[3,8],session:[3,9],sessionless:12,set:[2,3,5],sever:4,sexual:5,shall:11,ship:11,show:[5,12],sign:12,six:[2,7],size:5,slack:4,small:3,social:5,softwar:[11,13],solut:8,some:[3,8,9,12,13],someth:12,sourc:[7,11],space:5,specif:[0,5,9],specifi:3,sphinx:7,sphinxcontrib:7,sql:1,sqldatetim:1,sqltime:1,stack:4,stand:3,start:[1,8,9,12],step:[5,9,10],stop:7,string:1,studio:7,subfold:[2,7],subject:11,sublicens:11,submodul:0,substanti:11,subus:3,succe:7,success:1,suffici:3,suggest:7,support:[2,4,7,8,10],sure:[3,7],surviv:1,system:[8,9],sytem:3,tag:7,take:[5,7,13],team:[5,8],technolog:8,temporari:5,temporarili:5,ten:8,test:[2,3,9,12],testrol:3,text:11,thei:[5,10],them:[4,7,10],theme:7,thi:[1,2,3,4,5,6,7,8,9,10,11,12],thing:[3,7],thousand:8,threaten:5,through:[1,8,12,13],thu:[7,11],tia:7,time:[7,13],timesql:1,timestamp:1,tld:8,tmp:1,toggl:3,tort:11,total:1,touch:4,toward:5,transport:1,troll:5,twine:7,two:3,txt:7,unaccept:5,under:11,unittest:11,unix:1,unwelcom:5,updat:[2,5,9],upgrad:9,upload:[2,7],uploaddistribution_l:7,uploaddistribution_test:7,url:[1,2,3,12],url_decod:1,url_encod:1,use:[2,3,4,5,7,10,11,12],used:[1,3],useful:5,user:[1,3,12],using:[3,5,10,12],usr:12,usual:3,utc:2,util:1,valid:9,valu:9,variabl:5,version:[2,5,9],via:[2,5],view:3,viewpoint:5,visual:7,vscode:2,wai:3,want:[3,7,11,12],warranti:11,webhook:7,websupport:7,welcom:5,well:[11,12],what:[3,5,7,9],whatev:11,when:[1,3,5,10],where:13,whether:[8,11],which:[3,5,8,9],who:[5,11],whom:11,wiki:5,wish:5,within:[5,10],without:[5,11],work:12,world:3,worldwid:8,worri:7,www:12,yet:12,you:[3,5,7,8,9,11,12,13],your:[3,5,7,8,10,12,13]},titles:["SDK Documentation","hexonet.apiconnector package","Changelog","Configuration Handling","Contact Us","Contributing","Debugging","Development Guide","Foreword","Welcome to hexonet.apiconnector","Installation","License","Quickstart","Upgrading to Newer Releases"],titleterms:{"return":12,addit:9,api:8,apiconnector:[1,9],applic:12,attribut:5,author:11,backend:[8,12],basic:3,builtin:3,changelog:[2,7],code:[5,7],conduct:5,configur:3,contact:4,contribut:5,debug:[3,6],definit:11,depend:10,develop:7,document:[0,7,9],enforc:5,environ:3,error:12,featur:3,foreword:8,gener:[7,11],guid:[7,9],handl:3,hexonet:[1,8,9],instal:10,just:12,licens:11,live:3,minim:12,mit:11,newer:13,note:9,our:5,packag:1,pledg:5,procedur:7,process:5,pull:[5,7],python:10,quickstart:12,releas:[7,13],request:[5,7],requir:7,respons:5,run:7,scope:5,sdk:[0,7,9],session:12,standard:5,submodul:1,system:[3,12],test:7,updat:7,upgrad:13,usag:9,valid:7,valu:3,version:[7,10],welcom:9,what:12}})
\ No newline at end of file
diff --git a/docs/_build/html/upgrading.html b/docs/_build/html/upgrading.html
index 1546058..72f97b7 100644
--- a/docs/_build/html/upgrading.html
+++ b/docs/_build/html/upgrading.html
@@ -116,16 +116,16 @@
Contents
Quickstart¶
-Eager to get started? This page gives a good introduction to hexonet.apiconnector. -It assumes you already have it installed. If you do not, head over to the -Installation section.
+Eager to get started? This page gives a good introduction to +hexonet.apiconnector. It assumes you already have it installed. +If you do not, head over to the Installation section.
A Minimal Application¶
A minimal application using hexonet.apiconnector looks something like this:
@@ -179,22 +179,30 @@A Minimal ApplicationSo what did that code do?
- First we imported the
hexonet.apiconnector.
-- Next we create an Connection to the HEXONET Backend System by using the
connect().
-- We then use the
call() to request a provided command to the backend system.
-- The response is an instance of
Response. It provides all necessary methods to access API response data.
+- Next we create an Connection to the HEXONET Backend System by using the
+
connect().
+- We then use the
call()
+to request a provided command to the backend system.
+- The response is an instance of
+
Response. It provides all necessary
+methods to access API response data.
hexonet.apiconnector.connect().call() to request a provided command to the backend system.Response. It provides all necessary methods to access API response data.connect().call()
+to request a provided command to the backend system.Response. It provides all necessary
+methods to access API response data.What to do if the backend system just returns an error¶
-Well this in general needs some further analysis. Reasons might be that you have an ip filter defined and you do not provide your ip address through configuration option “remoteaddr”. +
Well this in general needs some further analysis. Reasons might be that you +have an ip filter defined and you do not provide your ip address through +configuration option “remoteaddr”. It could also be that you provided an ip address that is blocked. -Another issue can be that you connect using a role user that is not allowed to request this command as it got blocked by role user configuration.
+Another issue can be that you connect using a role user that is not allowed +to request this command as it got blocked by role user configuration.Feel free to Contact Us if you need help.
Sessions¶
-Session-based communication is not yet available in this SDK. This is a planned rewrite. -The above application code shows how sessionless communication with the HEXONET Backend API works.
+Session-based communication is not yet available in this SDK. This is a planned +rewrite. The above application code shows how sessionless communication with +the HEXONET Backend API works.
Table Of Contents
Upgrading to Newer Releases¶
-hexonet.apiconnector itself is changing like any software is changing over time. -Most of the changes are the nice kind, the kind where you don’t have to change -anything in your code to profit from a new release. These are in general changes that -are released as patch or minor release.
+hexonet.apiconnector itself is changing like any software is changing over +time. Most of the changes are the nice kind, the kind where you don’t have +to change anything in your code to profit from a new release. These are in +general changes that are released as patch or minor release.
However every once in a while there are changes that do require some changes in your code or there are changes that make it possible for you to improve your own code quality by taking advantage of new features in hexonet.apiconnector. Such breaking changes are covered through major releases.
-Use the pip command to upgrade your existing hexonet.apiconnector installation by
-providing the --upgrade parameter:
Use the pip command to upgrade your existing hexonet.apiconnector
+installation by providing the --upgrade parameter:
$ pip install --upgrade hexonet.apiconnector
# for python 2.x
diff --git a/docs/api.rst b/docs/api.rst
index 7ccffc8..ec9f5b5 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -8,4 +8,4 @@ Information on specific functions, classes, and methods.
.. toctree::
:glob:
- api/*
\ No newline at end of file
+ api/*
diff --git a/docs/config.rst b/docs/config.rst
index 01cc89b..167cfe3 100644
--- a/docs/config.rst
+++ b/docs/config.rst
@@ -7,11 +7,12 @@ Applications need some kind of configuration. There are different settings
you might want to change depending on the application environment like
toggling the debug mode, setting credentials etc.
-The way hexonet.apiconnector is designed usually requires the configuration to be
-provided at runtime when connecting to the HEXONET Backend API. You can hardcode
-the configuration in the code, which for many small scripts is for sure sufficient.
-Realtime applications and frontends need to cover some application logic around
-using this SDK like a login form and session management.
+The way hexonet.apiconnector is designed usually requires the configuration
+to be provided at runtime when connecting to the HEXONET Backend API. You
+can hardcode the configuration in the code, which for many small scripts is
+for sure sufficient. Realtime applications and frontends need to cover some
+application logic around using this SDK like a login form and session
+management.
Configuration Basics
@@ -19,7 +20,7 @@ Configuration Basics
The configuration can be provided in two ways.
Using the :meth:`hexonet.apiconnector.connect`::
-
+
import hexonet.apiconnector
api = hexonet.apiconnector.connect(
"test.user",
@@ -37,7 +38,7 @@ or by using the :class:`hexonet.apiconnector.connection.Connection` class accord
"login": "test.user",
"password": "test.passw0rd",
"url": "https://coreapi.1api.net/api/call.cgi",
- "entity": "1234",
+ "entity": "1234",
//"user": "hexotestman.com",//subuser view
//"role": "testrole",//specify a role user
});
@@ -61,15 +62,15 @@ OT&E System
OT&E Sytem stands for Operational Test & Evaluation System.
No costs, just for playing around with things. This system can be seen as a
kind of sandbox system that allows to test your integration first before going
-live with it. This system and the use of our products and services is completely
-free of charge.
+live with it. This system and the use of our products and services is
+completely free of charge.
To use this system, set configuration value for property `entity` to `1234`.
LIVE System
^^^^^^^^^^^
-The real world system - This system and the use our services and products can lead
-to real costs depending on what you're exactly doing.
+The real world system - This system and the use our services and products can
+lead to real costs depending on what you're exactly doing.
To use this system, set configuration value for property `entity` to `54cd`.
Builtin Configuration Values
@@ -77,4 +78,5 @@ Builtin Configuration Values
The following configuration values are used internally by hexonet.apiconnector:
-Up to now - none, but this might change in future as we are continously improving our SDKs.
\ No newline at end of file
+Up to now - none, but this might change in future as we are continously
+improving our SDKs.
diff --git a/docs/contactus.rst b/docs/contactus.rst
index cc44be0..080f64c 100644
--- a/docs/contactus.rst
+++ b/docs/contactus.rst
@@ -3,7 +3,8 @@
Contact Us
==========
-There are several possibilities to get in touch with us, we list them in our preferred order.
+There are several possibilities to get in touch with us, we list them
+in our preferred order.
- `Slack`_
@@ -18,6 +19,7 @@ There are several possibilities to get in touch with us, we list them in our pre
.. _Support: https://hexonet.support
Please file Bugs / Issues / Problems as `new github issue`_ to us.
-Please read our :ref:`contributing` first and use the search to check if this is already a known issue.
+Please read our :ref:`contributing` first and use the search to check
+if this is already a known issue.
-.. _new github issue: https://github.com/hexonet/python-sdk/issues/new
\ No newline at end of file
+.. _new github issue: https://github.com/hexonet/python-sdk/issues/new
diff --git a/docs/contributing.md b/docs/contributing.md
deleted file mode 100644
index 851517d..0000000
--- a/docs/contributing.md
+++ /dev/null
@@ -1,3 +0,0 @@
-.. _contributing:
-
-.. mdinclude:: ../CONTRIBUTING.md
\ No newline at end of file
diff --git a/docs/contributing.rst b/docs/contributing.rst
new file mode 100644
index 0000000..a0ad0a8
--- /dev/null
+++ b/docs/contributing.rst
@@ -0,0 +1,3 @@
+.. _contributing:
+
+.. mdinclude:: ../CONTRIBUTING.md
diff --git a/docs/debugging.rst b/docs/debugging.rst
index bb3b13d..38ac440 100644
--- a/docs/debugging.rst
+++ b/docs/debugging.rst
@@ -4,4 +4,5 @@ Debugging
=========
There's no debug feature available in hexonet.apiconnector up to now.
-This is a planned feature and will come in near future as we continously improve our SDKs.
\ No newline at end of file
+This is a planned feature and will come in near future as we continously
+improve our SDKs.
diff --git a/docs/developmentguide.rst b/docs/developmentguide.rst
index 41299d7..7308f55 100644
--- a/docs/developmentguide.rst
+++ b/docs/developmentguide.rst
@@ -5,6 +5,8 @@ Development Guide
Please read our :ref:`Contributing guide lines ` first.
+.. _requirements:
+
Requirements
------------
@@ -12,14 +14,24 @@ You can find any required library for this project in the *requirements.txt*:
.. literalinclude:: ../requirements.txt
-NOTE: Make sure to have also all the extensions listed in the `docs/conf.py`_ that are required for the SDK Documentation.
+You can install them by
+
+.. code-block:: bash
+
+ pip3 install -r requirements.txt
+
+NOTE: Make sure to have also all the extensions listed in the `docs/conf.py`
+that are required for the SDK Documentation.
.. _docs/conf.py: https://rawgit.com/hexonet/python-sdk/master/docs/conf.py
-In addition, you need nodejs/npm with globally installed module *auto-changelog* in case you want to generate an update changelog version.
+In addition, you need nodejs/npm with globally installed module
+*auto-changelog* in case you want to generate an update changelog version.
We suggest to use nvm_.
-We suggest to use `Visual Studio Code`_ with installed plugins for Python Development described here_. But if you prefer any other IDE / Editor, it is fine.
+We suggest to use `Visual Studio Code`_ with installed plugins for Python
+Development described here_. But if you prefer any other IDE / Editor, it
+is fine.
.. _nvm: https://github.com/creationix/nvm
.. _Visual Studio Code: https://code.visualstudio.com
@@ -53,17 +65,21 @@ Pull Request (PR) Procedure
* commit and push it to remote
* open a pull request (PR)
-**We care then about the rest** - no need to worry about things like building current realease and versioning.
+**We care then about the rest** - no need to worry about things like
+building current realease and versioning.
**You can stop here.**
The below sections are just for our reference.
-TIA for your PR and thus for your support of this project. As we have further SDKs in other languages, it might take a bit of time to check if we can role out that PR as we want to keep all our SDKs aligned.
+TIA for your PR and thus for your support of this project. As we have
+further SDKs in other languages, it might take a bit of time to check
+if we can role out that PR as we want to keep all our SDKs aligned.
Versioning
----------
-We use SemVer_ for versioning. For the versions available, see the `tags on this repository`_.
+We use SemVer_ for versioning. For the versions available, see the
+`tags on this repository`_.
.. _SemVer: http://semver.org/
.. _tags on this repository: https://github.com/hexonet/python-sdk/tags
@@ -82,11 +98,14 @@ Then create a new tag version by
git push --tags
# push the tags to remote
-Create a new release out of that new tag and provide release details about the changes applied in the `git interface`_. In case of breaking changes, describe what has changed and how to migrate.
+Create a new release out of that new tag and provide release details about
+the changes applied in the `git interface`_. In case of breaking changes,
+describe what has changed and how to migrate.
.. _git interface: https://github.com/hexonet/python-sdk/releases
-Changes will be auto-deployed by a webhook to readthedocs.org_ and automatically updated on `github pages`_.
+Changes will be auto-deployed by a webhook to readthedocs.org_ and
+automatically updated on `github pages`_.
.. _readthedocs.org: https://hexonet-python-sdk.readthedocs.io
.. _github pages: https://hexonet.github.io/python-sdk
@@ -106,7 +125,8 @@ Publish your changes to the Python Package Index (PyPi_) by
./scripts/uploaddistribution_live.sh
# to upload the generated packages to the PyPi Index (pypi.org)
-The module can be accessed on the `PyPi (Live) Index`_ and the `PyPi (Test) Index`_.
+The module can be accessed on the `PyPi (Live) Index`_ and the
+`PyPi (Test) Index`_.
.. _PyPi (Live) Index: https://pypi.org/project/hexonet.apiconnector/
.. _PyPi (Test) Index: https://test.pypi.org/project/hexonet.apiconnector/
@@ -116,13 +136,15 @@ Generate SDK Documentation
Have an eye on the generated :ref:`api`.
-If you want to generate it from scratch out of the sources, please use composer together with our project as follows:
+If you want to generate it from scratch out of the sources, please use
+the below script:
.. code-block:: bash
-
+
./scripts/generatedocs.sh
-The generated files are then available in subfolder "docs/_build/html". Commit and push the changes.
+The generated files are then available in subfolder "docs/_build/html".
+Commit and push the changes.
Update Changelog
----------------
@@ -130,7 +152,7 @@ Update Changelog
After having changes merged and released, run
.. code-block:: bash
-
+
./scripts/changelog.sh
-Commit and push the changes.
\ No newline at end of file
+Commit and push the changes.
diff --git a/docs/foreword.rst b/docs/foreword.rst
index 5436ae5..64280c3 100644
--- a/docs/foreword.rst
+++ b/docs/foreword.rst
@@ -1,16 +1,18 @@
Foreword
========
-Read this before you get started with hexonet.apiconnector. This hopefully answers some
-questions about the purpose and goals of the project.
+Read this before you get started with hexonet.apiconnector. This
+hopefully answers some questions about the purpose and goals of
+the project.
HEXONET
-------
-We're known as leading developers of domain technologies and as the worldwide experts in
-domain names. Our team is focused, and continually driven to bring customers the best
-technological solutions, TLD offerings, customer support, and domain products to make their
-internet goals a reality. Whether you have one domain or tens of thousands with us, we
-appreciate your business.
+We're known as leading developers of domain technologies and as
+the worldwide experts in domain names. Our team is focused, and
+continually driven to bring customers the best technological
+solutions, TLD offerings, customer support, and domain products
+to make their internet goals a reality. Whether you have one
+domain or tens of thousands with us, we appreciate your business.
Read more about us and our products and service on our homepage_.
@@ -19,10 +21,12 @@ Read more about us and our products and service on our homepage_.
HEXONET Backend API
-------------------
-HEXONET provides his products and services through a Backend System that is accessible by different options.
-One of these options is a HTTP API for which we provide SDKs in different programming languages such as
-go/golang, nodejs, php, python, java and perl.
-The hexonet.apiconnector (aka python-sdk) is one of these connector libraries that help implementors to connect
-their systems to the HEXONET Backend System.
+HEXONET provides his products and services through a Backend System
+that is accessible by different options. One of these options is a
+HTTP API for which we provide SDKs in different programming languages
+such as go/golang, nodejs, php, python, java and perl. The
+hexonet.apiconnector (aka python-sdk) is one of these connector
+libraries that help implementors to connect their systems to the
+HEXONET Backend System.
Continue to :ref:`installation` or the :ref:`quickstart`.
diff --git a/docs/index.rst b/docs/index.rst
index f2db86b..eac239f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -7,13 +7,14 @@ Welcome to hexonet.apiconnector
:alt: hexonet.apiconnector: Connector library for the HEXONET Backend API
:align: right
-Welcome to hexonet.apiconnector's documentation. Get started with :ref:`installation`
-and then get an overview with the :ref:`quickstart`. There is also a Demo App available for
-any of our SDK libraries. The one for hexonet.apiconnector (python-sdk) is available at github_.
+Welcome to hexonet.apiconnector's documentation. Get started with
+:ref:`installation` and then get an overview with the :ref:`quickstart`.
+There is also a Demo App available for any of our SDK libraries. The
+one for hexonet.apiconnector (python-sdk) is available at github_.
.. _github: https://github.com/hexonet/python-sdk-demo
-The rest of the docs describe each component of hexonet.apiconnector in detail, with a full
-reference in the :ref:`api` section.
+The rest of the docs describe each component of hexonet.apiconnector in
+detail, with a full reference in the :ref:`api` section.
-.. include:: contents.rst.inc
\ No newline at end of file
+.. include:: contents.rst.inc
diff --git a/docs/installation.rst b/docs/installation.rst
index ea0491d..cba3ec4 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -6,20 +6,25 @@ Installation
Python Version
--------------
-We recommend using the latest version of Python 3. hexonet.apiconnector supports Python 3.x and 2.7.
+We recommend using the latest version of Python 3. hexonet.apiconnector
+supports Python 3.x and 2.7.
Dependencies
------------
-There are NO dependencies to install. If this changes, we will list them here and they will be installed
-automatically when hexonet.apiconnector is getting installed.
+There are NO dependencies to install. If this changes, we will list them
+here and they will be installed automatically when hexonet.apiconnector
+is getting installed.
+There are :ref:`dependencies` that we just need in steps of
+our build process.
Installation
-------------
-Within the your environment, use the following command to install hexonet.apiconnector:
+Within the your environment, use the following command to install
+hexonet.apiconnector:
.. code-block:: sh
@@ -29,5 +34,6 @@ Within the your environment, use the following command to install hexonet.apicon
pip3 install hexonet.apiconnector
# for python 3.x
-The connector library is now installed. Check out the :doc:`/quickstart` or go to the
-:doc:`Documentation Overview `.
\ No newline at end of file
+The connector library is now installed. Check out the
+:doc:`/quickstart` or go to the
+:doc:`Documentation Overview `.
diff --git a/docs/license.rst b/docs/license.rst
index 35f3776..ed02e58 100644
--- a/docs/license.rst
+++ b/docs/license.rst
@@ -1,7 +1,7 @@
License
=======
-hexonet.apiconnector is licensed under MIT License.
+hexonet.apiconnector is licensed under MIT License.
A short, permissive software license. Basically, you can do whatever you
want as long as you include the original copyright and license notice in
any copy of the software/source.
@@ -25,8 +25,8 @@ documentation.
:ref:`authors` section.
- The ":ref:`mit-license`" applies to all the source code shipped as
- part of hexonet.apiconnector (the module itself as well as the examples and the unittests)
- as well as documentation.
+ part of hexonet.apiconnector (the module itself as well as the examples and
+ the unittests) as well as documentation.
.. _mit-license:
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
index 0e7ce6c..9a39e1f 100644
--- a/docs/quickstart.rst
+++ b/docs/quickstart.rst
@@ -3,9 +3,9 @@
Quickstart
==========
-Eager to get started? This page gives a good introduction to hexonet.apiconnector.
-It assumes you already have it installed. If you do not, head over to the
-:ref:`installation` section.
+Eager to get started? This page gives a good introduction to
+hexonet.apiconnector. It assumes you already have it installed.
+If you do not, head over to the :ref:`installation` section.
A Minimal Application
@@ -16,29 +16,37 @@ A minimal application using hexonet.apiconnector looks something like this:
.. literalinclude:: app.py
:language: python
:encoding: utf-8
- :caption: Python SDK Demo App
+ :caption: Python SDK Demo App
So what did that code do?
1. First we imported the :mod:`hexonet.apiconnector`.
-2. Next we create an Connection to the HEXONET Backend System by using the :meth:`~hexonet.apiconnector.connect`.
+2. Next we create an Connection to the HEXONET Backend System by using the
+ :meth:`~hexonet.apiconnector.connect`.
-3. We then use the :meth:`~hexonet.apiconnector.connection.Connection.call` to request a provided command to the backend system.
+3. We then use the :meth:`~hexonet.apiconnector.connection.Connection.call`
+ to request a provided command to the backend system.
-4. The response is an instance of :class:`~hexonet.apiconnector.response.Response`. It provides all necessary methods to access API response data.
+4. The response is an instance of
+ :class:`~hexonet.apiconnector.response.Response`. It provides all necessary
+ methods to access API response data.
What to do if the backend system just returns an error
------------------------------------------------------
-Well this in general needs some further analysis. Reasons might be that you have an ip filter defined and you do not provide your ip address through configuration option "remoteaddr".
+Well this in general needs some further analysis. Reasons might be that you
+have an ip filter defined and you do not provide your ip address through
+configuration option "remoteaddr".
It could also be that you provided an ip address that is blocked.
-Another issue can be that you connect using a role user that is not allowed to request this command as it got blocked by role user configuration.
+Another issue can be that you connect using a role user that is not allowed
+to request this command as it got blocked by role user configuration.
Feel free to :ref:`contact-us` if you need help.
Sessions
--------
-Session-based communication is not yet available in this SDK. This is a planned rewrite.
-The above application code shows how sessionless communication with the HEXONET Backend API works.
\ No newline at end of file
+Session-based communication is not yet available in this SDK. This is a planned
+rewrite. The above application code shows how sessionless communication with
+the HEXONET Backend API works.
diff --git a/docs/upgrading.rst b/docs/upgrading.rst
index 2a5c62d..7bc6da1 100644
--- a/docs/upgrading.rst
+++ b/docs/upgrading.rst
@@ -1,18 +1,18 @@
Upgrading to Newer Releases
===========================
-hexonet.apiconnector itself is changing like any software is changing over time.
-Most of the changes are the nice kind, the kind where you don't have to change
-anything in your code to profit from a new release. These are in general changes that
-are released as patch or minor release.
+hexonet.apiconnector itself is changing like any software is changing over
+time. Most of the changes are the nice kind, the kind where you don't have
+to change anything in your code to profit from a new release. These are in
+general changes that are released as patch or minor release.
However every once in a while there are changes that do require some
changes in your code or there are changes that make it possible for you to
improve your own code quality by taking advantage of new features in
hexonet.apiconnector. Such breaking changes are covered through major releases.
-Use the :command:`pip` command to upgrade your existing hexonet.apiconnector installation by
-providing the ``--upgrade`` parameter::
+Use the :command:`pip` command to upgrade your existing hexonet.apiconnector
+installation by providing the ``--upgrade`` parameter::
$ pip install --upgrade hexonet.apiconnector
# for python 2.x
@@ -23,4 +23,4 @@ providing the ``--upgrade`` parameter::
See the how to migrate your code by reading the `release notes`_.
We publish there any information on how to migrate.
-.. _release notes: https://github.com/hexonet/python-sdk/releases
\ No newline at end of file
+.. _release notes: https://github.com/hexonet/python-sdk/releases