Merge pull request #1 from hexonet/umlMigration

Migration to cross-SDK UML diagram

Author: KaiSchwarz-cnic

.travis.yml

@@ -12,14 +12,15 @@ notifications:
     on_success: always
     on_failure: always
 python:
-- '2.7'
-- '3.7'
+  - '2.7'
+  - '3.6'
 cache:
   directories:
   - "~/.npm"
   - node_modules
 install:
 - pip install -r requirements.txt
+- pip install -e .
 script:
 - "./scripts/pep8check.sh"
 - "./scripts/coverage.sh"

CONTRIBUTING.md

@@ -5,7 +5,7 @@ email, or any other method with the owners of this repository before making a ch
 
 Please note we have a code of conduct, please follow it in all your interactions with the project.
 
-## Pull Request (PR) Process
+## Pull Request Process
 
 Read [here](https://hexonet-python-sdk.readthedocs.io/en/latest/developmentguide.html#pull-request-pr-procedure).
 
@@ -33,7 +33,8 @@ include:
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
 * Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
 * Publishing others' private information, such as a physical or electronic
@@ -65,11 +66,11 @@ further defined and clarified by project maintainers.
 ### Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+reported by contacting the project team. All complaints will be reviewed and
+investigated and will result in a response that is deemed necessary and appropriate
+to the circumstances. The project team is obligated to maintain confidentiality
+with regard to the reporter of an incident. Further details of specific enforcement
+policies may be posted separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good
 faith may face temporary or permanent repercussions as determined by other

HISTORY.md

@@ -1,91 +0,0 @@
-### Changelog
-
-All notable changes to this project will be documented in this file. Dates are displayed in UTC.
-
-#### [1.2.7](https://github.com/hexonet/python-sdk/compare/1.2.6...1.2.7) (17 July 2018)
-
-- added tests and coverage reporting [`7440bce`](https://github.com/hexonet/python-sdk/commit/7440bce90542b66382d9cee85e84c335286d0e0c)
-- updated docs [`6cacf3f`](https://github.com/hexonet/python-sdk/commit/6cacf3f5467fb44743784632ce316b58036fdfef)
-- revalidated source code [`8e35832`](https://github.com/hexonet/python-sdk/commit/8e35832328091a8574a9038f3ae234f8a8ec1e6f)
-- generate version and release dynamically in conf.py [`de67279`](https://github.com/hexonet/python-sdk/commit/de67279491f538e19ef024aeec4b38013a888341)
-- updated sdk reference [`989284e`](https://github.com/hexonet/python-sdk/commit/989284e67c039ad5b285d415f8d6b5d98864cbbf)
-- corrected release version in docs [`9fd0ed5`](https://github.com/hexonet/python-sdk/commit/9fd0ed58501349a725de7fb509ee9edad83ff12c)
-- updated changelog [`b738293`](https://github.com/hexonet/python-sdk/commit/b738293d9b313e046382f0ae77801c02f6bb2977)
-- finalized tests [`195837f`](https://github.com/hexonet/python-sdk/commit/195837f845a299407a69a6436a7e8e69fb20ab1c)
-- increased version number [`fab7e18`](https://github.com/hexonet/python-sdk/commit/fab7e18eeef91e0c2c716f560f075e6c187601c6)
-- Update README.md [`97e9500`](https://github.com/hexonet/python-sdk/commit/97e950030a63d3ac8c0706a7a30c096957703ae8)
-
-#### [1.2.6](https://github.com/hexonet/python-sdk/compare/1.2.5...1.2.6) (12 July 2018)
-
-- minor code review; migrated to sphinx documenation [`da40a40`](https://github.com/hexonet/python-sdk/commit/da40a40e81217bc4218d5de95adcc12ab95c3cb7)
-- added development guide [`ffb6b7c`](https://github.com/hexonet/python-sdk/commit/ffb6b7cd129e794f75dcf6bbc3b2ca32248fb736)
-- linted .rst files; reviewed development guide [`ba27b08`](https://github.com/hexonet/python-sdk/commit/ba27b080ccaba06c49c159fde11bd8336ef86714)
-- use of m2r and mdincludes - WOW [`82e5e3c`](https://github.com/hexonet/python-sdk/commit/82e5e3c6454d8d736a10dca61b19624490d00733)
-- reviewed headline issues [`a0a644f`](https://github.com/hexonet/python-sdk/commit/a0a644fe750215937f3aa28e0a4c9d0477d7322f)
-- freezed deps into requirements.txt [`4312f11`](https://github.com/hexonet/python-sdk/commit/4312f114524880af0ae498dbed67c711c75d0fa8)
-- cleaned requirements.txt [`d4c3671`](https://github.com/hexonet/python-sdk/commit/d4c36712fe3b813e9e719e9d2fb9103d3b0a8683)
-- Update README.md [`295445b`](https://github.com/hexonet/python-sdk/commit/295445b91ddc626161f70b0770d17fbbf2645654)
-- Update README.md [`ebbe309`](https://github.com/hexonet/python-sdk/commit/ebbe3098bca572f337208310e8872be21e9b2184)
-- updated docs [`9829d01`](https://github.com/hexonet/python-sdk/commit/9829d015ec9ad72bee40defe05d32ca4b21136ed)
-- added index.html for github pages [`bfeebcb`](https://github.com/hexonet/python-sdk/commit/bfeebcb05e5023a7f7415b8b9d30dd118144e19d)
-- try out setup.py update for readthedocs.org [`5a9659f`](https://github.com/hexonet/python-sdk/commit/5a9659f2290de0fa282d9f350c12c4f4aefd92d8)
-- updated changelog [`b92ab41`](https://github.com/hexonet/python-sdk/commit/b92ab41eff6a6e5f963830d4064096e5db488ead)
-- added requirements.txt [`4e28994`](https://github.com/hexonet/python-sdk/commit/4e289943ee9297c7485f7b894e9025fbdbe84da7)
-- migrate from pep9 to pycodestyle [`8f5019d`](https://github.com/hexonet/python-sdk/commit/8f5019d130e7c10c599d2d0897b92e48ad59e2f0)
-- added .nojekyll file to allow folders starting with underline [`c4fe9bf`](https://github.com/hexonet/python-sdk/commit/c4fe9bf78fe3a0505ad56e9e037adb6ce7887844)
-- minor change to trigger github pages update [`7bd035c`](https://github.com/hexonet/python-sdk/commit/7bd035c04c5f6b114e15f6ccf4bc6ba781146649)
-- updated badges [`9a07712`](https://github.com/hexonet/python-sdk/commit/9a07712809fd4849bd0d11ea329a06728891092a)
-- Update CONTRIBUTING.md [`edc480c`](https://github.com/hexonet/python-sdk/commit/edc480c6f5ee5c67d4810241126f2a61b609b962)
-- updated badges [`e31581c`](https://github.com/hexonet/python-sdk/commit/e31581caf35cd9cca61c4fc776f2cfaa158ea136)
-- linted contents.rst.inc [`9f93c48`](https://github.com/hexonet/python-sdk/commit/9f93c48d5f112f948320bc50069f404fa02ea607)
-
-#### [1.2.5](https://github.com/hexonet/python-sdk/compare/1.2.4...1.2.5) (9 July 2018)
-
-- fix six import path [`a9ec1a1`](https://github.com/hexonet/python-sdk/commit/a9ec1a1547637535220b33eb86a8172a53634879)
-- updated changelog [`9e775a8`](https://github.com/hexonet/python-sdk/commit/9e775a850af227ecfd227b3b838f989daf63edff)
-
-#### [1.2.4](https://github.com/hexonet/python-sdk/compare/1.2.3...1.2.4) (9 July 2018)
-
-- updated changelog [`c5601be`](https://github.com/hexonet/python-sdk/commit/c5601beb264c7b7e763e88e11aafcc93da310edd)
-- fix six import paths [`e304262`](https://github.com/hexonet/python-sdk/commit/e3042628792eefce6168b93220308b138647c8f0)
-- set version 1.2.4 [`655b886`](https://github.com/hexonet/python-sdk/commit/655b88658c9c0b1db1be39af8700eb900a19ec87)
-
-#### [1.2.3](https://github.com/hexonet/python-sdk/compare/1.2.2...1.2.3) (9 July 2018)
-
-- import renaming [`bd7dc80`](https://github.com/hexonet/python-sdk/commit/bd7dc80c9decaccb480333aa4fe51db0c3722389)
-- set version to 1.2.2 [`5642b54`](https://github.com/hexonet/python-sdk/commit/5642b54c25dd3410f699fb54e0f97a4ee1957109)
-
-#### [1.2.2](https://github.com/hexonet/python-sdk/compare/1.2.1...1.2.2) (9 July 2018)
-
-- try import renaming [`d3fa6ae`](https://github.com/hexonet/python-sdk/commit/d3fa6ae84e8bc0c6ec941964445085b5ea3f3da6)
-
-#### [1.2.1](https://github.com/hexonet/python-sdk/compare/1.2.0...1.2.1) (9 July 2018)
-
-- test renamed imports [`0999708`](https://github.com/hexonet/python-sdk/commit/09997081ddf7c65a6f25fa1827cfb07fd68f82c5)
-- updated changelog [`eb5e6d4`](https://github.com/hexonet/python-sdk/commit/eb5e6d408f088b34172414ed9283fb0fc20e3df3)
-- set version 1.2.1 [`2d98115`](https://github.com/hexonet/python-sdk/commit/2d9811500081c0940e3f340af9265b1c66f36893)
-
-#### [1.2.0](https://github.com/hexonet/python-sdk/compare/1.1.0...1.2.0) (9 July 2018)
-
-- introduced six for py2 and py3 support [`fa7403a`](https://github.com/hexonet/python-sdk/commit/fa7403a9b18dc11b9cf8c74da603c12cee01477a)
-- updated changelog [`a0f7e2f`](https://github.com/hexonet/python-sdk/commit/a0f7e2f3418d238f2d4884d786c0d62383d3d0c9)
-- apiconnector version 1.2.0 [`85ec52f`](https://github.com/hexonet/python-sdk/commit/85ec52f18007de6a9d37889cd1b20711968749fa)
-
-#### [1.1.0](https://github.com/hexonet/python-sdk/compare/1.0.0...1.1.0) (9 July 2018)
-
-- added pep8 scripts and code refactoring [`95e0199`](https://github.com/hexonet/python-sdk/commit/95e0199073c19f842778d133ceea8d11a7f64ded)
-- added sdk documentation and generator script [`01fe1e0`](https://github.com/hexonet/python-sdk/commit/01fe1e0b858690ad95a3e611b9871067af3132be)
-- added changelog and changelog generator script [`a4bd960`](https://github.com/hexonet/python-sdk/commit/a4bd9606e5590388fac9f96c5621a9e03fd125c6)
-- update apiconnector version [`f1804eb`](https://github.com/hexonet/python-sdk/commit/f1804eb7bbb48c6e338f5b065dc935820ddcc595)
-
-#### 1.0.0 (9 July 2018)
-
-- initial PyPi package release [`eb2ac4c`](https://github.com/hexonet/python-sdk/commit/eb2ac4c6458a3620938e429878582e0b1ab93f00)
-- ignore .vscode subfolder [`67430e3`](https://github.com/hexonet/python-sdk/commit/67430e3419237823839b2946c324a93d7d8de22c)
-- added .gitignore [`946bc01`](https://github.com/hexonet/python-sdk/commit/946bc01b7c3505c28400aca50b9d9d4d4de33684)
-- Add files via upload [`aa2bc4d`](https://github.com/hexonet/python-sdk/commit/aa2bc4d5f92720c22b7853371ade371e1f95b9dd)
-- Create README.md [`400e58b`](https://github.com/hexonet/python-sdk/commit/400e58b5d2c0db4102ad207c65845a537d95aa93)
-- fix encoding problem (JIRA: HM-22) + fix in properties() results [`5dc88d4`](https://github.com/hexonet/python-sdk/commit/5dc88d4a85f90a7154d0ccde4df33faff0874591)
-- support for python2.5, use HTTP instead of HTTPS for the URL [`88cedbf`](https://github.com/hexonet/python-sdk/commit/88cedbf82075e19a957349dbc14b2836d99f2117)
-- support for python > 3; also backward compatible [`2756429`](https://github.com/hexonet/python-sdk/commit/27564296dcd0e0a388ce45b0e77c467e6d927a31)
-- Initial commit [`c89c917`](https://github.com/hexonet/python-sdk/commit/c89c917845cda5cef9e4f3a4fb5dc9d022e48006)

HISTORY.old.md

@@ -0,0 +1,89 @@
+All notable changes to this project will be documented in this file. Dates are displayed in UTC.
+
+#### [1.2.7](https://github.com/hexonet/python-sdk/compare/1.2.6...1.2.7) (17 July 2018)
+
+- added tests and coverage reporting [`7440bce`](https://github.com/hexonet/python-sdk/commit/7440bce90542b66382d9cee85e84c335286d0e0c)
+- updated docs [`6cacf3f`](https://github.com/hexonet/python-sdk/commit/6cacf3f5467fb44743784632ce316b58036fdfef)
+- revalidated source code [`8e35832`](https://github.com/hexonet/python-sdk/commit/8e35832328091a8574a9038f3ae234f8a8ec1e6f)
+- generate version and release dynamically in conf.py [`de67279`](https://github.com/hexonet/python-sdk/commit/de67279491f538e19ef024aeec4b38013a888341)
+- updated sdk reference [`989284e`](https://github.com/hexonet/python-sdk/commit/989284e67c039ad5b285d415f8d6b5d98864cbbf)
+- corrected release version in docs [`9fd0ed5`](https://github.com/hexonet/python-sdk/commit/9fd0ed58501349a725de7fb509ee9edad83ff12c)
+- updated changelog [`b738293`](https://github.com/hexonet/python-sdk/commit/b738293d9b313e046382f0ae77801c02f6bb2977)
+- finalized tests [`195837f`](https://github.com/hexonet/python-sdk/commit/195837f845a299407a69a6436a7e8e69fb20ab1c)
+- increased version number [`fab7e18`](https://github.com/hexonet/python-sdk/commit/fab7e18eeef91e0c2c716f560f075e6c187601c6)
+- Update README.md [`97e9500`](https://github.com/hexonet/python-sdk/commit/97e950030a63d3ac8c0706a7a30c096957703ae8)
+
+#### [1.2.6](https://github.com/hexonet/python-sdk/compare/1.2.5...1.2.6) (12 July 2018)
+
+- minor code review; migrated to sphinx documenation [`da40a40`](https://github.com/hexonet/python-sdk/commit/da40a40e81217bc4218d5de95adcc12ab95c3cb7)
+- added development guide [`ffb6b7c`](https://github.com/hexonet/python-sdk/commit/ffb6b7cd129e794f75dcf6bbc3b2ca32248fb736)
+- linted .rst files; reviewed development guide [`ba27b08`](https://github.com/hexonet/python-sdk/commit/ba27b080ccaba06c49c159fde11bd8336ef86714)
+- use of m2r and mdincludes - WOW [`82e5e3c`](https://github.com/hexonet/python-sdk/commit/82e5e3c6454d8d736a10dca61b19624490d00733)
+- reviewed headline issues [`a0a644f`](https://github.com/hexonet/python-sdk/commit/a0a644fe750215937f3aa28e0a4c9d0477d7322f)
+- freezed deps into requirements.txt [`4312f11`](https://github.com/hexonet/python-sdk/commit/4312f114524880af0ae498dbed67c711c75d0fa8)
+- cleaned requirements.txt [`d4c3671`](https://github.com/hexonet/python-sdk/commit/d4c36712fe3b813e9e719e9d2fb9103d3b0a8683)
+- Update README.md [`295445b`](https://github.com/hexonet/python-sdk/commit/295445b91ddc626161f70b0770d17fbbf2645654)
+- Update README.md [`ebbe309`](https://github.com/hexonet/python-sdk/commit/ebbe3098bca572f337208310e8872be21e9b2184)
+- updated docs [`9829d01`](https://github.com/hexonet/python-sdk/commit/9829d015ec9ad72bee40defe05d32ca4b21136ed)
+- added index.html for github pages [`bfeebcb`](https://github.com/hexonet/python-sdk/commit/bfeebcb05e5023a7f7415b8b9d30dd118144e19d)
+- try out setup.py update for readthedocs.org [`5a9659f`](https://github.com/hexonet/python-sdk/commit/5a9659f2290de0fa282d9f350c12c4f4aefd92d8)
+- updated changelog [`b92ab41`](https://github.com/hexonet/python-sdk/commit/b92ab41eff6a6e5f963830d4064096e5db488ead)
+- added requirements.txt [`4e28994`](https://github.com/hexonet/python-sdk/commit/4e289943ee9297c7485f7b894e9025fbdbe84da7)
+- migrate from pep9 to pycodestyle [`8f5019d`](https://github.com/hexonet/python-sdk/commit/8f5019d130e7c10c599d2d0897b92e48ad59e2f0)
+- added .nojekyll file to allow folders starting with underline [`c4fe9bf`](https://github.com/hexonet/python-sdk/commit/c4fe9bf78fe3a0505ad56e9e037adb6ce7887844)
+- minor change to trigger github pages update [`7bd035c`](https://github.com/hexonet/python-sdk/commit/7bd035c04c5f6b114e15f6ccf4bc6ba781146649)
+- updated badges [`9a07712`](https://github.com/hexonet/python-sdk/commit/9a07712809fd4849bd0d11ea329a06728891092a)
+- Update CONTRIBUTING.md [`edc480c`](https://github.com/hexonet/python-sdk/commit/edc480c6f5ee5c67d4810241126f2a61b609b962)
+- updated badges [`e31581c`](https://github.com/hexonet/python-sdk/commit/e31581caf35cd9cca61c4fc776f2cfaa158ea136)
+- linted contents.rst.inc [`9f93c48`](https://github.com/hexonet/python-sdk/commit/9f93c48d5f112f948320bc50069f404fa02ea607)
+
+#### [1.2.5](https://github.com/hexonet/python-sdk/compare/1.2.4...1.2.5) (9 July 2018)
+
+- fix six import path [`a9ec1a1`](https://github.com/hexonet/python-sdk/commit/a9ec1a1547637535220b33eb86a8172a53634879)
+- updated changelog [`9e775a8`](https://github.com/hexonet/python-sdk/commit/9e775a850af227ecfd227b3b838f989daf63edff)
+
+#### [1.2.4](https://github.com/hexonet/python-sdk/compare/1.2.3...1.2.4) (9 July 2018)
+
+- updated changelog [`c5601be`](https://github.com/hexonet/python-sdk/commit/c5601beb264c7b7e763e88e11aafcc93da310edd)
+- fix six import paths [`e304262`](https://github.com/hexonet/python-sdk/commit/e3042628792eefce6168b93220308b138647c8f0)
+- set version 1.2.4 [`655b886`](https://github.com/hexonet/python-sdk/commit/655b88658c9c0b1db1be39af8700eb900a19ec87)
+
+#### [1.2.3](https://github.com/hexonet/python-sdk/compare/1.2.2...1.2.3) (9 July 2018)
+
+- import renaming [`bd7dc80`](https://github.com/hexonet/python-sdk/commit/bd7dc80c9decaccb480333aa4fe51db0c3722389)
+- set version to 1.2.2 [`5642b54`](https://github.com/hexonet/python-sdk/commit/5642b54c25dd3410f699fb54e0f97a4ee1957109)
+
+#### [1.2.2](https://github.com/hexonet/python-sdk/compare/1.2.1...1.2.2) (9 July 2018)
+
+- try import renaming [`d3fa6ae`](https://github.com/hexonet/python-sdk/commit/d3fa6ae84e8bc0c6ec941964445085b5ea3f3da6)
+
+#### [1.2.1](https://github.com/hexonet/python-sdk/compare/1.2.0...1.2.1) (9 July 2018)
+
+- test renamed imports [`0999708`](https://github.com/hexonet/python-sdk/commit/09997081ddf7c65a6f25fa1827cfb07fd68f82c5)
+- updated changelog [`eb5e6d4`](https://github.com/hexonet/python-sdk/commit/eb5e6d408f088b34172414ed9283fb0fc20e3df3)
+- set version 1.2.1 [`2d98115`](https://github.com/hexonet/python-sdk/commit/2d9811500081c0940e3f340af9265b1c66f36893)
+
+#### [1.2.0](https://github.com/hexonet/python-sdk/compare/1.1.0...1.2.0) (9 July 2018)
+
+- introduced six for py2 and py3 support [`fa7403a`](https://github.com/hexonet/python-sdk/commit/fa7403a9b18dc11b9cf8c74da603c12cee01477a)
+- updated changelog [`a0f7e2f`](https://github.com/hexonet/python-sdk/commit/a0f7e2f3418d238f2d4884d786c0d62383d3d0c9)
+- apiconnector version 1.2.0 [`85ec52f`](https://github.com/hexonet/python-sdk/commit/85ec52f18007de6a9d37889cd1b20711968749fa)
+
+#### [1.1.0](https://github.com/hexonet/python-sdk/compare/1.0.0...1.1.0) (9 July 2018)
+
+- added pep8 scripts and code refactoring [`95e0199`](https://github.com/hexonet/python-sdk/commit/95e0199073c19f842778d133ceea8d11a7f64ded)
+- added sdk documentation and generator script [`01fe1e0`](https://github.com/hexonet/python-sdk/commit/01fe1e0b858690ad95a3e611b9871067af3132be)
+- added changelog and changelog generator script [`a4bd960`](https://github.com/hexonet/python-sdk/commit/a4bd9606e5590388fac9f96c5621a9e03fd125c6)
+- update apiconnector version [`f1804eb`](https://github.com/hexonet/python-sdk/commit/f1804eb7bbb48c6e338f5b065dc935820ddcc595)
+
+#### 1.0.0 (9 July 2018)
+
+- initial PyPi package release [`eb2ac4c`](https://github.com/hexonet/python-sdk/commit/eb2ac4c6458a3620938e429878582e0b1ab93f00)
+- ignore .vscode subfolder [`67430e3`](https://github.com/hexonet/python-sdk/commit/67430e3419237823839b2946c324a93d7d8de22c)
+- added .gitignore [`946bc01`](https://github.com/hexonet/python-sdk/commit/946bc01b7c3505c28400aca50b9d9d4d4de33684)
+- Add files via upload [`aa2bc4d`](https://github.com/hexonet/python-sdk/commit/aa2bc4d5f92720c22b7853371ade371e1f95b9dd)
+- Create README.md [`400e58b`](https://github.com/hexonet/python-sdk/commit/400e58b5d2c0db4102ad207c65845a537d95aa93)
+- fix encoding problem (JIRA: HM-22) + fix in properties() results [`5dc88d4`](https://github.com/hexonet/python-sdk/commit/5dc88d4a85f90a7154d0ccde4df33faff0874591)
+- support for python2.5, use HTTP instead of HTTPS for the URL [`88cedbf`](https://github.com/hexonet/python-sdk/commit/88cedbf82075e19a957349dbc14b2836d99f2117)
+- support for python > 3; also backward compatible [`2756429`](https://github.com/hexonet/python-sdk/commit/27564296dcd0e0a388ce45b0e77c467e6d927a31)
+- Initial commit [`c89c917`](https://github.com/hexonet/python-sdk/commit/c89c917845cda5cef9e4f3a4fb5dc9d022e48006)

README.md

@@ -19,12 +19,17 @@ This module is a connector library for the insanely fast HEXONET Backend API. Fo
 * [Development Guide](https://hexonet-python-sdk.readthedocs.io/en/latest/developmentguide.html)
 
 ## How to use this module in your project
+
 All you need to know, can be found [here](https://hexonet-python-sdk.readthedocs.io/en/latest/#usage-guide).
 
 ## Contributing
 
 Please read [our development guide](https://hexonet-python-sdk.readthedocs.io/en/latest/developmentguide.html) for details on our code of conduct, and the process for submitting pull requests to us.
 
+```bash
+pip3 install -e .
+```
+
 ## Authors
 
 List of responsible developers can be found [here](https://github.com/hexonet/python-sdk/blob/master/AUTHORS.md)