diff --git a/docs/_build/html/_sources/contributing.md.txt b/docs/_build/html/_sources/contributing.md.txt new file mode 100644 index 0000000..851517d --- /dev/null +++ b/docs/_build/html/_sources/contributing.md.txt @@ -0,0 +1,3 @@ +.. _contributing: + +.. mdinclude:: ../CONTRIBUTING.md \ No newline at end of file diff --git a/docs/_build/html/_sources/contributing.rst.txt b/docs/_build/html/_sources/contributing.rst.txt deleted file mode 100644 index a0ad0a8..0000000 --- a/docs/_build/html/_sources/contributing.rst.txt +++ /dev/null @@ -1,3 +0,0 @@ -.. _contributing: - -.. mdinclude:: ../CONTRIBUTING.md diff --git a/docs/_build/html/_sources/developmentguide.rst.txt b/docs/_build/html/_sources/developmentguide.rst.txt new file mode 100644 index 0000000..41299d7 --- /dev/null +++ b/docs/_build/html/_sources/developmentguide.rst.txt @@ -0,0 +1,136 @@ +.. _developmentguide: + +Development Guide +================= + +Please read our :ref:`Contributing guide lines ` first. + +Requirements +------------ + +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. + +.. _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. +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. + +.. _nvm: https://github.com/creationix/nvm +.. _Visual Studio Code: https://code.visualstudio.com +.. _here: https://code.visualstudio.com/docs/languages/python + +.. _testsnvalidation: + +Run Tests and Code Validation +----------------------------- + +There are up to no automated tests realized, but planned to come in short. + +Code validation and auto-fixing can be run by + +.. code-block:: bash + + ./scripts/pep8fix.sh + # to autofix possible issues + + ./scripts/pep9check.sh + # to check for issues left + +Please fix all issues before creating a PR. + +Pull Request (PR) Procedure +--------------------------- +* fork our project and create a new branch. +* clone it and check this branch out +* apply your desired changes / extensions +* :ref:`run tests and code validation` +* 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. + +**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. + +Versioning +---------- + +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 + +Releasing +--------- + +Merge the desired changes in case tests and code validation succeed. +Then create a new tag version by + +.. code-block:: bash + + git tag -a v1.2.3 master + # please replace the semver version accordingly + + 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. + +.. _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`_. + +.. _readthedocs.org: https://hexonet-python-sdk.readthedocs.io +.. _github pages: https://hexonet.github.io/python-sdk + +Publish your changes to the Python Package Index (PyPi_) by + +.. _PyPi: https://pypi.org/ + +.. code-block:: bash + + ./scripts/createdistribution.sh + # to create packages of the new distribution + + ./scripts/uploaddistribution_test.sh + # to upload the generated packages to the PyPi Test Index (test.pypi.org) + + ./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`_. + +.. _PyPi (Live) Index: https://pypi.org/project/hexonet.apiconnector/ +.. _PyPi (Test) Index: https://test.pypi.org/project/hexonet.apiconnector/ + +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: + +.. code-block:: bash + + ./scripts/generatedocs.sh + +The generated files are then available in subfolder "docs/_build/html". Commit and push the changes. + +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 diff --git a/docs/_build/html/api.html b/docs/_build/html/api.html index 8473edf..3e8b55e 100644 --- a/docs/_build/html/api.html +++ b/docs/_build/html/api.html @@ -80,8 +80,9 @@

Table Of Contents

diff --git a/docs/_build/html/api/hexonet.apiconnector.html b/docs/_build/html/api/hexonet.apiconnector.html index 1d3c992..02173cd 100644 --- a/docs/_build/html/api/hexonet.apiconnector.html +++ b/docs/_build/html/api/hexonet.apiconnector.html @@ -81,8 +81,9 @@

Table Of Contents

diff --git a/docs/_build/html/changelog.html b/docs/_build/html/changelog.html index 5edc069..10ae104 100644 --- a/docs/_build/html/changelog.html +++ b/docs/_build/html/changelog.html @@ -25,7 +25,7 @@ - + @@ -41,7 +41,7 @@

Navigation

modules |
  • - next |
  • Table Of Contents
  • 1.0.0
    • -
  • License
  • Contributing
    • +
  • Development Guide
    • +
  • License
  • Contact Us
    • @@ -243,7 +244,7 @@

    1.0.0
    - License + Contributing
    @@ -261,7 +262,7 @@

    Navigation

    modules |
  • - next |
  • Table Of Contents diff --git a/docs/_build/html/contactus.html b/docs/_build/html/contactus.html index 7677c9b..8a3b5ed 100644 --- a/docs/_build/html/contactus.html +++ b/docs/_build/html/contactus.html @@ -25,7 +25,7 @@ - + @@ -40,7 +40,7 @@

    Navigation

    modules |
  • - previous |
  • hexonet.apiconnector 1.2 documentation »
    • @@ -73,8 +73,9 @@

    Table Of Contents

    @@ -128,7 +129,7 @@

    Table Of Contents

    - Contributing + License
    @@ -147,7 +148,7 @@

    Navigation

    modules |
  • - previous |
  • hexonet.apiconnector 1.2 documentation »
    • diff --git a/docs/_build/html/contributing.html b/docs/_build/html/contributing.html index a8ee39d..372beeb 100644 --- a/docs/_build/html/contributing.html +++ b/docs/_build/html/contributing.html @@ -25,8 +25,8 @@ - - + + @@ -41,10 +41,10 @@

    Navigation

    modules |
  • - next |
  • - previous |
  • hexonet.apiconnector 1.2 documentation »
    • @@ -77,12 +77,13 @@

    Table Of Contents

    @@ -232,11 +233,11 @@

    Attribution
    - License + Changelog
    - Contact Us + Development Guide
    @@ -254,10 +255,10 @@

    Navigation

    modules |
  • - next |
  • - previous |
  • hexonet.apiconnector 1.2 documentation »
    • diff --git a/docs/_build/html/debugging.html b/docs/_build/html/debugging.html index ea87258..a7f2f01 100644 --- a/docs/_build/html/debugging.html +++ b/docs/_build/html/debugging.html @@ -77,8 +77,9 @@

    Table Of Contents

    diff --git a/docs/_build/html/developmentguide.html b/docs/_build/html/developmentguide.html new file mode 100644 index 0000000..7f685ff --- /dev/null +++ b/docs/_build/html/developmentguide.html @@ -0,0 +1,293 @@ + + + + + + + + + + + + + + + + + Development Guide — hexonet.apiconnector 1.2 documentation + + + + + + + + + + + + + + + + +
    + +
    + +
    + +
    + +
    +
      +
    1. Docs
      2. + +
    2. Development Guide
      3. +
    +
    + +
    + +
    +

    Development Guide

    +

    Please read our Contributing guide lines first.

    +
    +

    Requirements

    +

    You can find any required library for this project in the requirements.txt:

    +
    autopep8==1.3.5
+docutils==0.14
+guzzle-sphinx-theme==0.7.11
+-e git://github.com/miyakogi/m2r@dev#egg=m2r
+pep8==1.7.1
+pycodestyle==2.4.0
+six==1.11.0
+Sphinx==1.7.5
+sphinxcontrib-log-cabinet==1.0.0
+sphinxcontrib-websupport==1.1.0
+twine==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. +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.

    +
    +
    +

    Run Tests and Code Validation

    +

    There are up to no automated tests realized, but planned to come in short.

    +

    Code validation and auto-fixing can be run by

    +
    ./scripts/pep8fix.sh
+# to autofix possible issues
+
+./scripts/pep9check.sh
+# to check for issues left
+
    +
    +

    Please fix all issues before creating a PR.

    +
    +
    +

    Pull Request (PR) Procedure

    +
      +
    • fork our project and create a new branch.
      • +
    • clone it and check this branch out
      • +
    • apply your desired changes / extensions
      • +
    • run tests and code validation
      • +
    • 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.

    +

    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.

    +
    +
    +

    Versioning

    +

    We use SemVer for versioning. For the versions available, see the tags on this repository.

    +
    +
    +

    Releasing

    +

    Merge the desired changes in case tests and code validation succeed. +Then create a new tag version by

    +
    git tag -a v1.2.3 master
+# please replace the semver version accordingly
+
+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.

    +

    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
+
+./scripts/uploaddistribution_test.sh
+# to upload the generated packages to the PyPi Test Index (test.pypi.org)
+
+./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.

    +
    +
    +

    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:

    +
    ./scripts/generatedocs.sh
+
    +
    +

    The generated files are then available in subfolder “docs/_build/html”. Commit and push the changes.

    +
    +
    +

    Update Changelog

    +

    After having changes merged and released, run

    +
    ./scripts/changelog.sh
+
    +
    +

    Commit and push the changes.

    +
    +
    + + +
    + +
    + +
    + Contributing +
    + +
    + License +
    +
    +
    + +
    +
    +
    + + + +
    + © Copyright 2018 by HEXONET GmbH. Created using Sphinx. +
    + + \ No newline at end of file diff --git a/docs/_build/html/foreword.html b/docs/_build/html/foreword.html index a5b322a..855705f 100644 --- a/docs/_build/html/foreword.html +++ b/docs/_build/html/foreword.html @@ -81,8 +81,9 @@

    Table Of Contents

    diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html index e83bf30..ad20a36 100644 --- a/docs/_build/html/genindex.html +++ b/docs/_build/html/genindex.html @@ -70,8 +70,9 @@

    Table Of Contents

    diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html index 37f412f..287686d 100644 --- a/docs/_build/html/index.html +++ b/docs/_build/html/index.html @@ -73,8 +73,9 @@

    Table Of Contents

    @@ -87,7 +88,7 @@

    Contents

    +
  • Contributing +
    • +
  • Development Guide +
  • License
    • -
  • Contributing -
  • Contact Us
    • diff --git a/docs/_build/html/installation.html b/docs/_build/html/installation.html index 2ccec16..3d76a99 100644 --- a/docs/_build/html/installation.html +++ b/docs/_build/html/installation.html @@ -82,8 +82,9 @@

    Table Of Contents

    diff --git a/docs/_build/html/license.html b/docs/_build/html/license.html index fabcd2d..319dbfb 100644 --- a/docs/_build/html/license.html +++ b/docs/_build/html/license.html @@ -25,8 +25,8 @@ - - + + @@ -41,10 +41,10 @@

    Navigation

    modules |
  • - next |
  • - previous |
  • hexonet.apiconnector 1.2 documentation »
    • @@ -77,13 +77,14 @@

    Table Of Contents

    @@ -191,11 +192,11 @@

    General License Definitions
    - Changelog + Development Guide
    - Contributing + Contact Us
    @@ -213,10 +214,10 @@

    Navigation

    modules |
  • - next |
  • - previous |
  • hexonet.apiconnector 1.2 documentation »
    • diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv index e3838b7..871f7a3 100644 Binary files a/docs/_build/html/objects.inv and b/docs/_build/html/objects.inv differ diff --git a/docs/_build/html/py-modindex.html b/docs/_build/html/py-modindex.html index 3cfd7de..9fbad50 100644 --- a/docs/_build/html/py-modindex.html +++ b/docs/_build/html/py-modindex.html @@ -72,8 +72,9 @@

    Table Of Contents

    diff --git a/docs/_build/html/quickstart.html b/docs/_build/html/quickstart.html index e356f9c..9fad0fc 100644 --- a/docs/_build/html/quickstart.html +++ b/docs/_build/html/quickstart.html @@ -82,8 +82,9 @@

    Table Of Contents

    diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html index 5f613dd..e31632f 100644 --- a/docs/_build/html/search.html +++ b/docs/_build/html/search.html @@ -78,8 +78,9 @@

    Table Of Contents

    diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index 0bfae09..d4ef947 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","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","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,11],"27564296dcd0e0a388ce45b0e77c467e6d927a31":2,"2d98115":2,"2d9811500081c0940e3f340af9265b1c66f36893":2,"400e58b":2,"400e58b5d2c0db4102ad207c65845a537d95aa93":2,"54cd":[3,11],"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":12,"class":[0,1,3,8],"function":[0,1,8],"import":[2,3,11],"long":10,"new":[4,5,12],"public":5,"return":[1,8],"short":10,"true":1,"try":2,"while":12,AND:10,BUT:10,Being:5,FOR:10,For:10,NOT:10,One:7,Such:12,THE:10,The:[3,4,5,7,8,9,10,11],There:[3,4,6,8,9],These:12,USE:10,Use:[11,12],Using:[3,5],WITH:10,a0f7e2f3418d238f2d4884d786c0d62383d3d0c9:2,a0f7e2f:2,a4bd9606e5590388fac9f96c5621a9e03fd125c6:2,a4bd960:2,a9ec1a1547637535220b33eb86a8172a53634879:2,a9ec1a1:2,aa2bc4d5f92720c22b7853371ade371e1f95b9dd:2,aa2bc4d:2,about:[5,7,8],abov:[10,11],abus:5,accept:5,access:[7,11],accordingli:3,account:[5,11],act:5,action:[5,10],adapt:5,add:2,added:2,adding:10,address:[5,11],advanc:5,advantag:12,age:5,aka:7,align:5,all:[2,5,10,11],allow:[3,11],alreadi:[4,11],also:[2,8,11],analysi:11,ani:[1,5,8,10,12],anoth:11,answer:7,anthoni:10,anyth:12,api:[1,3,8,11],apiconnector:[0,2,3,6,7,9,10,11,12],app:[8,11],appear:5,appli:[5,10],applic:[3,8],appoint:5,appreci:[7,10],appropri:5,aris:10,around:3,arrai:1,as_hash:[1,11],as_list:[1,11],as_list_hash:[1,11],as_str:1,associ:10,assum:11,attack:5,attent:5,author:[4,8],auto:2,automat:9,avail:[3,5,6,8,11],backend:[3,8],background:8,backward:2,ban:5,base64:1,base64_decod:1,base64_encod:1,base:[1,11],basic:[8,10],bd7dc80:2,bd7dc80c9decaccb480333aa4fe51db0c3722389:2,befor:[3,5,7],begin:8,behavior:5,below:10,best:[5,7],better:10,bin:11,binari:1,bit:1,block:11,bodi:[1,5],both:[3,5],bring:7,bug:4,build:5,builtin:8,busi:7,c5601be:2,c5601beb264c7b7e763e88e11aafcc93da310edd:2,c89c917845cda5cef9e4f3a4fb5dc9d022e48006:2,c89c917:2,call:[1,3,11],call_raw:1,call_raw_http:1,can:[3,10,11],care:5,cgi:[3,11],chang:[2,3,5,9,12],changelog:8,charg:[3,10],check:[4,9],circumst:5,claim:10,clarifi:5,clean:1,code:[1,2,3,8,10,11,12],column:1,com:[2,3],come:6,command:[1,9,11,12],command_encod:1,comment:[5,10],commit:[2,5],commun:[5,11],compat:2,complaint:5,complet:[1,3],compon:8,condit:10,conduct:8,confidenti:5,config:1,configur:[8,11],connect:[1,3,7,10,11],connector:[7,8,9],consid:[3,5],construct:5,contact:[5,8,11],contain:[5,10],contin:[3,6],continu:7,contract:10,contribut:[4,8],contributor:[5,10],conveni:1,convert:1,cookpet:2,copi:10,copyright:10,coreapi:[3,11],correct:5,cost:3,could:[5,11],count:1,coven:5,cover:[3,12],creat:[2,5,11],credenti:3,critic:5,curl:1,current:1,custom:7,d3fa6a:2,d3fa6ae84e8bc0c6ec941964445085b5ea3f3da6:2,damag:10,data:[1,11],date:2,datetim:1,deal:10,debug:8,decod:1,deem:5,defin:[5,11],definit:8,demo:[8,11],depend:[3,5,8],derogatori:5,describ:8,descript:[1,11],design:[1,3,8],detail:[5,8],determin:5,develop:[7,10],did:11,differ:[3,5,7],disabl:5,discuss:5,displai:2,distribut:10,doc:8,document:[2,9,10],doing:[3,5],domain:7,don:[11,12],driven:7,e3042628792eefce6168b93220308b138647c8f0:2,e304262:2,each:8,eager:11,eb2ac4c6458a3620938e429878582e0b1ab93f00:2,eb2ac4c:2,eb5e6d408f088b34172414ed9283fb0fc20e3df3:2,eb5e6d4:2,edit:5,electron:5,element:1,email:5,empathi:5,encod:[1,2],end:5,ensur:5,entiti:[1,3,11],environ:[5,8,9],error:[1,8],etc:[3,5],ethnic:5,evalu:3,event:[5,10],everi:12,everyon:5,exactli:3,exampl:[5,10],exist:12,expect:5,experi:5,expert:7,explicit:5,expos:5,express:[5,10],extend:10,f1804eb7bbb48c6e338f5b065dc935820ddcc595:2,f1804eb:2,fa7403a9b18dc11b9cf8c74da603c12cee01477a:2,fa7403a:2,face:5,fair:5,faith:5,featur:[6,8,12],feel:11,file:[2,4,5,10],filter:11,first:[1,3,4,5,11],fit:10,fix:2,focus:[5,7,8],follow:[3,5,9,10],foreword:8,form:3,format:11,foster:5,found:[1,10],free:[3,5,10,11],from:[3,5,10,12],frontend:3,full:[8,10],furnish:10,further:[5,11],futur:[3,6],gender:5,gener:[2,8,11,12],get:[4,7,8,9,11],github:[2,4,8,10],gitignor:2,give:11,given:1,gmbh:10,goal:7,going:3,golang:7,good:[5,11],got:11,gracefulli:5,grant:10,handl:8,harass:5,hardcod:3,harm:5,hash:1,have:[5,7,11,12],head:11,help:[7,10,11],here:[8,9,11],herebi:10,hexonet:[0,2,3,6,9,10,11,12],hexotestman:3,his:7,holder:10,homepag:7,hopefulli:7,how:[11,12],howev:12,http:[1,2,3,5,7,11],hxclient:3,ident:5,ignor:2,imageri:5,implement:10,implementor:7,impli:10,improv:[3,6,12],inappropri:5,incid:5,includ:[5,10],inclus:5,index:1,individu:5,inform:[0,5,8,12],initi:2,insert:5,instal:[5,7,8,11,12],instanc:[1,5,11],instead:2,instruct:8,insult:5,integr:3,interact:5,interest:[5,8],interfac:5,intern:3,internet:7,introduc:2,introduct:11,investig:5,is_success:1,is_tmp_error:1,ispapi:11,issu:[4,5,11],its:5,itself:[10,12],java:7,jira:2,juli:2,just:[3,8],kai:10,kind:[3,10,12],known:[4,7],languag:[5,7],last:1,lastpagefirst:1,latest:9,layer:[1,5],lead:[3,7],leadership:5,legal:8,level:5,liabil:10,liabl:10,librari:[7,8,9,10,11],licens:8,like:[3,5,11,12],limit:[1,10,11],list:[1,4,9,10],locat:5,logic:3,login:[1,3,11],look:[8,11],made:10,mai:5,mail:[1,5],maintain:5,major:12,make:[1,5,7,12],manag:3,mani:3,media:5,member:5,merchant:10,merg:10,method:[0,5,8,11],might:[3,11],migrat:12,mime:1,minim:8,minor:12,mit:8,mode:3,modifi:10,modul:10,more:7,most:12,mostli:8,much:10,name:7,nation:5,necessari:[5,11],need:[3,11],net:[3,11],newer:8,next:[1,11],nextpag:1,nextpagefirst:1,nice:12,nodej:7,none:[1,3],noninfring:10,notabl:2,note:[5,12],notic:10,now:[3,6,9],number:1,object:1,oblig:5,obtain:10,offens:5,offer:7,offici:5,offlin:5,onc:12,one:[7,8,11],onli:10,onlin:5,open:5,oper:3,option:[7,11],order:4,org:5,orient:5,origin:10,other:[5,10],otherwis:[5,10],our:[3,4,6,7,8],out:[9,10],over:[1,11,12],overflow:4,overview:[8,9],own:12,owner:5,packag:[0,2,8],page:[1,11],paramet:[5,12],part:[1,8,10],particip:5,particular:10,passw0rd:[3,11],password:[1,3,11],patch:[10,12],path:2,peopl:10,pep8:2,perl:7,perman:5,permiss:[5,10],permit:10,person:[5,10],php:7,physic:5,pip3:[9,12],pip:[9,12],plai:3,plan:[3,6,11],pleas:[4,5],polici:5,polit:5,port:5,portion:10,posit:5,possibl:[4,12],post:5,prefer:4,previou:1,prevpag:1,prevpagefirst:1,privat:5,problem:[2,4],process:8,product:[3,7,11],profession:5,profit:12,program:7,project:[2,5,7],properti:[1,2,3],prose:8,provid:[3,7,10,11,12],publish:[5,10,12],pull:8,purpos:[7,10],py2:2,py3:2,pypi:2,python2:2,python:[2,3,7,8,11,12],qualiti:12,queri:1,querydomainlist:11,question:7,queuetim:1,quickstart:[7,8,9],race:5,read:[4,7,12],readm:[2,5],real:3,realiti:7,realtim:3,reason:[5,11],recommend:9,refactor:2,refer:[8,10],reflect:10,regard:5,regardless:5,registr:3,reject:5,releas:[2,8],religion:5,remoteaddr:11,remov:5,renam:2,repercuss:5,report:5,repositori:5,repres:5,represent:5,request:[8,11],requir:[3,12],respect:5,respons:[1,10,11],response_to_hash:1,response_to_list_hash:1,rest:8,restrict:10,result:[1,2,5,11],review:[5,10],rewrit:11,rhash:11,right:[5,10],rlist:11,rlisthash:11,role:[1,3,11],runtim:[1,3],sandbox:3,schneider:10,schwarz:10,script:[2,3],sdk:[2,3,6,7,11],search:4,section:[8,10,11],see:[10,12],seen:3,sell:10,separ:[3,5],servic:[3,7],session:[3,8],sessionless:11,set:[2,3,5],sever:4,sexual:5,shall:10,ship:10,show:[5,11],sign:11,six:2,size:5,slack:4,small:3,social:5,softwar:[10,12],solut:7,some:[3,7,8,11,12],someth:11,sourc:10,space:5,specif:[0,5,8],specifi:3,sql:1,sqldatetim:1,sqltime:1,stack:4,stand:3,start:[1,7,8,11],step:[5,8],string:1,subfold:2,subject:10,sublicens:10,submodul:0,substanti:10,subus:3,success:1,suffici:3,support:[2,4,7,9],sure:3,surviv:1,system:[7,8],sytem:3,take:[5,12],team:[5,7],technolog:7,temporari:5,temporarili:5,ten:7,test:[2,3,11],testrol:3,text:10,thei:[5,9],them:[4,9],thi:[1,2,3,4,5,6,7,8,9,10,11],thing:3,thousand:7,threaten:5,through:[1,7,11,12],thu:10,time:12,timesql:1,timestamp:1,tld:7,tmp:1,toggl:3,tort:10,total:1,touch:4,toward:5,transport:1,troll:5,two:3,unaccept:5,under:10,unittest:10,unix:1,unwelcom:5,updat:[2,5],upgrad:8,upload:2,url:[1,2,3,11],url_decod:1,url_encod:1,use:[2,3,4,5,9,10,11],used:[1,3],useful:5,user:[1,3,11],using:[3,5,9,11],usr:11,usual:3,utc:2,util:1,valu:8,variabl:5,version:[2,5,8],via:[2,5],view:3,viewpoint:5,vscode:2,wai:3,want:[3,10,11],warranti:10,welcom:5,well:[10,11],what:[3,5,8],whatev:10,when:[1,3,5,9],where:12,whether:[7,10],which:[3,5,7,8],who:[5,10],whom:10,wiki:5,wish:5,within:[5,9],without:[5,10],work:11,world:3,worldwid:7,www:11,yet:11,you:[3,5,7,8,10,11,12],your:[3,5,7,9,11,12]},titles:["SDK Documentation","hexonet.apiconnector package","Changelog","Configuration Handling","Contact Us","Contributing","Debugging","Foreword","Welcome to hexonet.apiconnector","Installation","License","Quickstart","Upgrading to Newer Releases"],titleterms:{"return":11,addit:8,api:7,apiconnector:[1,8],applic:11,attribut:5,author:10,backend:[7,11],basic:3,builtin:3,changelog:2,code:5,conduct:5,configur:3,contact:4,contribut:5,debug:[3,6],definit:10,depend:9,document:[0,8],enforc:5,environ:3,error:11,featur:3,foreword:7,gener:10,guid:8,handl:3,hexonet:[1,7,8],instal:9,just:11,licens:10,live:3,minim:11,mit:10,newer:12,note:8,our:5,packag:1,pledg:5,process:5,pull:5,python:9,quickstart:11,releas:12,request:5,respons:5,scope:5,sdk:[0,8],session:11,standard:5,submodul:1,system:[3,11],upgrad:12,user:8,valu:3,version:9,welcom:8,what:11}}) \ 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.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 diff --git a/docs/_build/html/sitemap.xml b/docs/_build/html/sitemap.xml index 1c0449a..74db870 100644 --- a/docs/_build/html/sitemap.xml +++ b/docs/_build/html/sitemap.xml @@ -1 +1 @@ -https://rawgit.com/hexonet/python-sdk/master/docs/api.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/api/hexonet.apiconnector.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/changelog.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/config.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/contactus.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/contributing.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/debugging.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/foreword.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/index.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/installation.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/license.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/quickstart.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/upgrading.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/genindex.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/py-modindex.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/search.html \ No newline at end of file +https://rawgit.com/hexonet/python-sdk/master/docs/api.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/api/hexonet.apiconnector.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/changelog.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/config.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/contactus.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/contributing.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/debugging.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/developmentguide.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/foreword.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/index.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/installation.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/license.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/quickstart.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/upgrading.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/genindex.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/py-modindex.htmlhttps://rawgit.com/hexonet/python-sdk/master/docs/search.html \ No newline at end of file diff --git a/docs/_build/html/upgrading.html b/docs/_build/html/upgrading.html index 5b0425a..1546058 100644 --- a/docs/_build/html/upgrading.html +++ b/docs/_build/html/upgrading.html @@ -77,8 +77,9 @@

    Table Of Contents

    diff --git a/docs/contents.rst.inc b/docs/contents.rst.inc index 3a11de6..4b8e7c3 100644 --- a/docs/contents.rst.inc +++ b/docs/contents.rst.inc @@ -1,5 +1,5 @@ -User's Guide ------------- +Usage Guide +----------- This part of the documentation, which is mostly prose, begins with some background information about HEXONET and it's Backend API, then focuses @@ -36,6 +36,7 @@ Design notes, legal information and changelog are here for the interested. upgrading changelog - license contributing + developmentguide + license contactus \ No newline at end of file diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 0000000..851517d --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,3 @@ +.. _contributing: + +.. mdinclude:: ../CONTRIBUTING.md \ No newline at end of file diff --git a/docs/contributing.rst b/docs/contributing.rst deleted file mode 100644 index a0ad0a8..0000000 --- a/docs/contributing.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. _contributing: - -.. mdinclude:: ../CONTRIBUTING.md diff --git a/docs/developmentguide.rst b/docs/developmentguide.rst new file mode 100644 index 0000000..41299d7 --- /dev/null +++ b/docs/developmentguide.rst @@ -0,0 +1,136 @@ +.. _developmentguide: + +Development Guide +================= + +Please read our :ref:`Contributing guide lines ` first. + +Requirements +------------ + +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. + +.. _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. +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. + +.. _nvm: https://github.com/creationix/nvm +.. _Visual Studio Code: https://code.visualstudio.com +.. _here: https://code.visualstudio.com/docs/languages/python + +.. _testsnvalidation: + +Run Tests and Code Validation +----------------------------- + +There are up to no automated tests realized, but planned to come in short. + +Code validation and auto-fixing can be run by + +.. code-block:: bash + + ./scripts/pep8fix.sh + # to autofix possible issues + + ./scripts/pep9check.sh + # to check for issues left + +Please fix all issues before creating a PR. + +Pull Request (PR) Procedure +--------------------------- +* fork our project and create a new branch. +* clone it and check this branch out +* apply your desired changes / extensions +* :ref:`run tests and code validation` +* 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. + +**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. + +Versioning +---------- + +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 + +Releasing +--------- + +Merge the desired changes in case tests and code validation succeed. +Then create a new tag version by + +.. code-block:: bash + + git tag -a v1.2.3 master + # please replace the semver version accordingly + + 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. + +.. _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`_. + +.. _readthedocs.org: https://hexonet-python-sdk.readthedocs.io +.. _github pages: https://hexonet.github.io/python-sdk + +Publish your changes to the Python Package Index (PyPi_) by + +.. _PyPi: https://pypi.org/ + +.. code-block:: bash + + ./scripts/createdistribution.sh + # to create packages of the new distribution + + ./scripts/uploaddistribution_test.sh + # to upload the generated packages to the PyPi Test Index (test.pypi.org) + + ./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`_. + +.. _PyPi (Live) Index: https://pypi.org/project/hexonet.apiconnector/ +.. _PyPi (Test) Index: https://test.pypi.org/project/hexonet.apiconnector/ + +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: + +.. code-block:: bash + + ./scripts/generatedocs.sh + +The generated files are then available in subfolder "docs/_build/html". Commit and push the changes. + +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