From af7ee8ea5bd103f185b5e6453ac07b084c1c4953 Mon Sep 17 00:00:00 2001 From: emotemot Date: Fri, 22 Apr 2022 10:27:51 +0300 Subject: [PATCH 01/17] build changes --- docs/root/generate_http_server_api_documentation.py | 4 ++++ .../installation/api/http-samples/api-index-response.http | 4 ++++ .../installation/api/http-samples/index-response.http | 8 ++++++++ 3 files changed, 16 insertions(+) diff --git a/docs/root/generate_http_server_api_documentation.py b/docs/root/generate_http_server_api_documentation.py index 1bf66ae..a3a94e6 100644 --- a/docs/root/generate_http_server_api_documentation.py +++ b/docs/root/generate_http_server_api_documentation.py @@ -9,8 +9,12 @@ import json import os import os.path +<<<<<<< Updated upstream from planetmint.transactions.common.input import Input from planetmint.transactions.common.transaction_link import TransactionLink +======= +from planetmint.common.transaction import Transaction, Input, TransactionLink +>>>>>>> Stashed changes from planetmint import lib from planetmint.transactions.types.assets.create import Create from planetmint.transactions.types.assets.transfer import Transfer diff --git a/docs/root/source/installation/api/http-samples/api-index-response.http b/docs/root/source/installation/api/http-samples/api-index-response.http index 7ba7be8..e92cb2f 100644 --- a/docs/root/source/installation/api/http-samples/api-index-response.http +++ b/docs/root/source/installation/api/http-samples/api-index-response.http @@ -4,7 +4,11 @@ Content-Type: application/json { "assets": "/assets/", "blocks": "/blocks/", +<<<<<<< Updated upstream "docs": "https://docs.planetmint.com/projects/server/en/v0.9.0/http-client-server-api.html", +======= + "docs": "https://docs.bigchaindb.com/projects/server/en/v0.9.0/http-client-server-api.html", +>>>>>>> Stashed changes "metadata": "/metadata/", "outputs": "/outputs/", "streams": "ws://localhost:9985/api/v1/streams/valid_transactions", diff --git a/docs/root/source/installation/api/http-samples/index-response.http b/docs/root/source/installation/api/http-samples/index-response.http index c593a91..1eff019 100644 --- a/docs/root/source/installation/api/http-samples/index-response.http +++ b/docs/root/source/installation/api/http-samples/index-response.http @@ -6,7 +6,11 @@ Content-Type: application/json "v1": { "assets": "/api/v1/assets/", "blocks": "/api/v1/blocks/", +<<<<<<< Updated upstream "docs": "https://docs.planetmint.com/projects/server/en/v0.9.0/http-client-server-api.html", +======= + "docs": "https://docs.bigchaindb.com/projects/server/en/v0.9.0/http-client-server-api.html", +>>>>>>> Stashed changes "metadata": "/api/v1/metadata/", "outputs": "/api/v1/outputs/", "streams": "ws://localhost:9985/api/v1/streams/valid_transactions", @@ -14,7 +18,11 @@ Content-Type: application/json "validators": "/api/v1/validators" } }, +<<<<<<< Updated upstream "docs": "https://docs.planetmint.com/projects/server/en/v0.9.0/", +======= + "docs": "https://docs.bigchaindb.com/projects/server/en/v0.9.0/", +>>>>>>> Stashed changes "software": "Planetmint", "version": "0.9.0" } From 6fc8821749515822e06442592d91ce3a584057e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Eckel?= Date: Wed, 27 Apr 2022 17:15:00 +0200 Subject: [PATCH 02/17] inc version number + added twine dep (#90) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jürgen Eckel --- planetmint/version.py | 2 +- setup.py | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/planetmint/version.py b/planetmint/version.py index 20b4fbf..3500cb5 100644 --- a/planetmint/version.py +++ b/planetmint/version.py @@ -3,7 +3,7 @@ # SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0) # Code is Apache-2.0 and docs are CC-BY-4.0 -__version__ = '0.9.1' +__version__ = '0.9.2' __short_version__ = '0.9' # Supported Tendermint versions diff --git a/setup.py b/setup.py index 6f881dc..5b623c8 100644 --- a/setup.py +++ b/setup.py @@ -43,7 +43,8 @@ dev_require = [ 'ipython', 'watchdog', 'logging_tree', - 'pre-commit' + 'pre-commit', + 'twine' ] docs_require = [ From ee504a0547181adb7f8727ad545359a35fa276f8 Mon Sep 17 00:00:00 2001 From: emotemot Date: Mon, 2 May 2022 14:58:47 +0300 Subject: [PATCH 03/17] updated .yml --- .readthedocs.yml | 35 ++++++++++++++++--- .../generate_http_server_api_documentation.py | 4 --- .../api/http-samples/api-index-response.http | 6 +--- .../api/http-samples/index-response.http | 14 ++------ docs/root/source/terminology.md | 13 +++---- 5 files changed, 39 insertions(+), 33 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 2ccc3f9..e2f0dfb 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -3,9 +3,36 @@ # SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0) # Code is Apache-2.0 and docs are CC-BY-4.0 -build: - image: latest +#build: +# image: latest +#python: +# version: 3.9 +# pip_install: true + + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-20.04 + tools: + python: "3.9" + # You can also specify other tool versions: + # nodejs: "16" + # rust: "1.55" + # golang: "1.17" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +# formats: +# - pdf + +# Optionally declare the Python requirements required to build your docs python: - version: 3.9 - pip_install: true + install: + - requirements: docs/requirements.txt \ No newline at end of file diff --git a/docs/root/generate_http_server_api_documentation.py b/docs/root/generate_http_server_api_documentation.py index a3a94e6..1bf66ae 100644 --- a/docs/root/generate_http_server_api_documentation.py +++ b/docs/root/generate_http_server_api_documentation.py @@ -9,12 +9,8 @@ import json import os import os.path -<<<<<<< Updated upstream from planetmint.transactions.common.input import Input from planetmint.transactions.common.transaction_link import TransactionLink -======= -from planetmint.common.transaction import Transaction, Input, TransactionLink ->>>>>>> Stashed changes from planetmint import lib from planetmint.transactions.types.assets.create import Create from planetmint.transactions.types.assets.transfer import Transfer diff --git a/docs/root/source/installation/api/http-samples/api-index-response.http b/docs/root/source/installation/api/http-samples/api-index-response.http index e92cb2f..601f9ef 100644 --- a/docs/root/source/installation/api/http-samples/api-index-response.http +++ b/docs/root/source/installation/api/http-samples/api-index-response.http @@ -4,11 +4,7 @@ Content-Type: application/json { "assets": "/assets/", "blocks": "/blocks/", -<<<<<<< Updated upstream - "docs": "https://docs.planetmint.com/projects/server/en/v0.9.0/http-client-server-api.html", -======= - "docs": "https://docs.bigchaindb.com/projects/server/en/v0.9.0/http-client-server-api.html", ->>>>>>> Stashed changes + "docs": "https://docs.planetmint.com/projects/server/en/v0.9.1/http-client-server-api.html", "metadata": "/metadata/", "outputs": "/outputs/", "streams": "ws://localhost:9985/api/v1/streams/valid_transactions", diff --git a/docs/root/source/installation/api/http-samples/index-response.http b/docs/root/source/installation/api/http-samples/index-response.http index 1eff019..f7e524e 100644 --- a/docs/root/source/installation/api/http-samples/index-response.http +++ b/docs/root/source/installation/api/http-samples/index-response.http @@ -6,11 +6,7 @@ Content-Type: application/json "v1": { "assets": "/api/v1/assets/", "blocks": "/api/v1/blocks/", -<<<<<<< Updated upstream - "docs": "https://docs.planetmint.com/projects/server/en/v0.9.0/http-client-server-api.html", -======= - "docs": "https://docs.bigchaindb.com/projects/server/en/v0.9.0/http-client-server-api.html", ->>>>>>> Stashed changes + "docs": "https://docs.planetmint.com/projects/server/en/v0.9.1/http-client-server-api.html", "metadata": "/api/v1/metadata/", "outputs": "/api/v1/outputs/", "streams": "ws://localhost:9985/api/v1/streams/valid_transactions", @@ -18,11 +14,7 @@ Content-Type: application/json "validators": "/api/v1/validators" } }, -<<<<<<< Updated upstream - "docs": "https://docs.planetmint.com/projects/server/en/v0.9.0/", -======= - "docs": "https://docs.bigchaindb.com/projects/server/en/v0.9.0/", ->>>>>>> Stashed changes + "docs": "https://docs.planetmint.com/projects/server/en/v0.9.1/", "software": "Planetmint", - "version": "0.9.0" + "version": "0.9.1" } diff --git a/docs/root/source/terminology.md b/docs/root/source/terminology.md index 6f42b32..8c51eca 100644 --- a/docs/root/source/terminology.md +++ b/docs/root/source/terminology.md @@ -11,11 +11,9 @@ There is some specialized terminology associated with Planetmint. To get started ### Planetmint Node -<<<<<<< HEAD -A **Planetmint node** is a machine (or logical machine) running [Planetmint Server](https://docs.planetmint.com/projects/server/en/latest/introduction.html) and related software. Each node is controlled by one person or organization. -======= -A **Planetmint node** is a machine (or logical machine) running [Planetmint Server](https://docs.planetmint.io/projects/server/en/latest/introduction.html) and related software. Each node is controlled by one person or organization. ->>>>>>> 3bfc3298f8210b135084e823eedd47f213538088 +**Planetmint node** is a machine (or logical machine) running [Planetmint Server](https://docs.planetmint.com/projects/server/en/latest/introduction.html) and related software. Each node is controlled by one person or organization. + +**Planetmint node** is a machine (or logical machine) running [Planetmint Server](https://docs.planetmint.io/projects/server/en/latest/introduction.html) and related software. Each node is controlled by one person or organization. ### Planetmint Network @@ -80,10 +78,7 @@ You could do more elaborate things too. As one example, each time someone writes ### Role-Based Access Control (RBAC) -<<<<<<< HEAD In September 2017, we published a [blog post about how one can define an RBAC sub-system on top of Planetmint](https://blog.planetmint.com/role-based-access-control-for-planetmint-assets-b7cada491997). -======= -In September 2017, BigchainDB published a [blog post about how one can define an RBAC sub-system on top of Planetmint](https://blog.bigchaindb.com/role-based-access-control-for-planetmint-assets-b7cada491997). ->>>>>>> 3bfc3298f8210b135084e823eedd47f213538088 + At the time of writing (January 2018), doing so required the use of a plugin, so it's not possible using standard Planetmint (which is what's available on the [IPDB Testnet](https://test.ipdb.io/>). That may change in the future. If you're interested, `contact IPDB `_. From c5b04aafc4b41b39412eb940b538411d286e9fd7 Mon Sep 17 00:00:00 2001 From: enesturk Date: Mon, 2 May 2022 15:19:47 +0300 Subject: [PATCH 04/17] build changes (#86) * build changes * updated .yml --- .readthedocs.yml | 35 ++++++++++++++++--- .../api/http-samples/api-index-response.http | 2 +- .../api/http-samples/index-response.http | 6 ++-- docs/root/source/terminology.md | 13 +++---- 4 files changed, 39 insertions(+), 17 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 2ccc3f9..e2f0dfb 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -3,9 +3,36 @@ # SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0) # Code is Apache-2.0 and docs are CC-BY-4.0 -build: - image: latest +#build: +# image: latest +#python: +# version: 3.9 +# pip_install: true + + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-20.04 + tools: + python: "3.9" + # You can also specify other tool versions: + # nodejs: "16" + # rust: "1.55" + # golang: "1.17" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +# formats: +# - pdf + +# Optionally declare the Python requirements required to build your docs python: - version: 3.9 - pip_install: true + install: + - requirements: docs/requirements.txt \ No newline at end of file diff --git a/docs/root/source/installation/api/http-samples/api-index-response.http b/docs/root/source/installation/api/http-samples/api-index-response.http index 7ba7be8..601f9ef 100644 --- a/docs/root/source/installation/api/http-samples/api-index-response.http +++ b/docs/root/source/installation/api/http-samples/api-index-response.http @@ -4,7 +4,7 @@ Content-Type: application/json { "assets": "/assets/", "blocks": "/blocks/", - "docs": "https://docs.planetmint.com/projects/server/en/v0.9.0/http-client-server-api.html", + "docs": "https://docs.planetmint.com/projects/server/en/v0.9.1/http-client-server-api.html", "metadata": "/metadata/", "outputs": "/outputs/", "streams": "ws://localhost:9985/api/v1/streams/valid_transactions", diff --git a/docs/root/source/installation/api/http-samples/index-response.http b/docs/root/source/installation/api/http-samples/index-response.http index c593a91..f7e524e 100644 --- a/docs/root/source/installation/api/http-samples/index-response.http +++ b/docs/root/source/installation/api/http-samples/index-response.http @@ -6,7 +6,7 @@ Content-Type: application/json "v1": { "assets": "/api/v1/assets/", "blocks": "/api/v1/blocks/", - "docs": "https://docs.planetmint.com/projects/server/en/v0.9.0/http-client-server-api.html", + "docs": "https://docs.planetmint.com/projects/server/en/v0.9.1/http-client-server-api.html", "metadata": "/api/v1/metadata/", "outputs": "/api/v1/outputs/", "streams": "ws://localhost:9985/api/v1/streams/valid_transactions", @@ -14,7 +14,7 @@ Content-Type: application/json "validators": "/api/v1/validators" } }, - "docs": "https://docs.planetmint.com/projects/server/en/v0.9.0/", + "docs": "https://docs.planetmint.com/projects/server/en/v0.9.1/", "software": "Planetmint", - "version": "0.9.0" + "version": "0.9.1" } diff --git a/docs/root/source/terminology.md b/docs/root/source/terminology.md index 6f42b32..8c51eca 100644 --- a/docs/root/source/terminology.md +++ b/docs/root/source/terminology.md @@ -11,11 +11,9 @@ There is some specialized terminology associated with Planetmint. To get started ### Planetmint Node -<<<<<<< HEAD -A **Planetmint node** is a machine (or logical machine) running [Planetmint Server](https://docs.planetmint.com/projects/server/en/latest/introduction.html) and related software. Each node is controlled by one person or organization. -======= -A **Planetmint node** is a machine (or logical machine) running [Planetmint Server](https://docs.planetmint.io/projects/server/en/latest/introduction.html) and related software. Each node is controlled by one person or organization. ->>>>>>> 3bfc3298f8210b135084e823eedd47f213538088 +**Planetmint node** is a machine (or logical machine) running [Planetmint Server](https://docs.planetmint.com/projects/server/en/latest/introduction.html) and related software. Each node is controlled by one person or organization. + +**Planetmint node** is a machine (or logical machine) running [Planetmint Server](https://docs.planetmint.io/projects/server/en/latest/introduction.html) and related software. Each node is controlled by one person or organization. ### Planetmint Network @@ -80,10 +78,7 @@ You could do more elaborate things too. As one example, each time someone writes ### Role-Based Access Control (RBAC) -<<<<<<< HEAD In September 2017, we published a [blog post about how one can define an RBAC sub-system on top of Planetmint](https://blog.planetmint.com/role-based-access-control-for-planetmint-assets-b7cada491997). -======= -In September 2017, BigchainDB published a [blog post about how one can define an RBAC sub-system on top of Planetmint](https://blog.bigchaindb.com/role-based-access-control-for-planetmint-assets-b7cada491997). ->>>>>>> 3bfc3298f8210b135084e823eedd47f213538088 + At the time of writing (January 2018), doing so required the use of a plugin, so it's not possible using standard Planetmint (which is what's available on the [IPDB Testnet](https://test.ipdb.io/>). That may change in the future. If you're interested, `contact IPDB `_. From a9655629197f720587c7360764223244621c4bda Mon Sep 17 00:00:00 2001 From: emotemot Date: Mon, 2 May 2022 15:44:19 +0300 Subject: [PATCH 05/17] requirements.txt updated --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index e2f0dfb..9819c43 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -35,4 +35,4 @@ sphinx: # Optionally declare the Python requirements required to build your docs python: install: - - requirements: docs/requirements.txt \ No newline at end of file + - requirements: docs/root/requirements.txt \ No newline at end of file From 7a3a7810fd3bf3c97878ab924c11eed9ba42220e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Eckel?= Date: Mon, 9 May 2022 10:39:21 +0200 Subject: [PATCH 06/17] fixed reference to conf.py MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jürgen Eckel --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 36567cc..6d5562a 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -26,7 +26,7 @@ build: # Build documentation in the docs/ directory with Sphinx sphinx: - configuration: docs/conf.py + configuration: docs/root/source/conf.py # If using Sphinx, optionally build your docs in additional formats such as PDF # formats: From 7fbbd640d3f64c061023fd121ee77e9942f5129c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Eckel?= Date: Mon, 9 May 2022 11:30:34 +0200 Subject: [PATCH 07/17] testing rtd MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jürgen Eckel --- .readthedocs.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 6d5562a..e0bb5da 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -25,8 +25,8 @@ build: # golang: "1.17" # Build documentation in the docs/ directory with Sphinx -sphinx: - configuration: docs/root/source/conf.py +#sphinx: +# configuration: docs/root/source/conf.py # If using Sphinx, optionally build your docs in additional formats such as PDF # formats: @@ -34,5 +34,6 @@ sphinx: # Optionally declare the Python requirements required to build your docs python: + version: 3.9 install: - requirements: docs/root/requirements.txt From 9f81fb92b6b55c4b898891849bc554f577fd5f25 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Eckel?= Date: Mon, 9 May 2022 11:39:35 +0200 Subject: [PATCH 08/17] added pip_install: true MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jürgen Eckel --- .readthedocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.readthedocs.yml b/.readthedocs.yml index e0bb5da..bead17a 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -35,5 +35,6 @@ build: # Optionally declare the Python requirements required to build your docs python: version: 3.9 + pip_install: true install: - requirements: docs/root/requirements.txt From e12bfe101fd6d9ec605b6050a4e596656a5a3d28 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Eckel?= Date: Mon, 9 May 2022 11:41:09 +0200 Subject: [PATCH 09/17] removed python version MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jürgen Eckel --- .readthedocs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index bead17a..e81dd5d 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -34,7 +34,6 @@ build: # Optionally declare the Python requirements required to build your docs python: - version: 3.9 pip_install: true install: - requirements: docs/root/requirements.txt From cbda2a47c85b3a4b4d5672d7ac12e231ff1b3665 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Eckel?= Date: Mon, 9 May 2022 11:47:55 +0200 Subject: [PATCH 10/17] addes setuptools installation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jürgen Eckel --- .readthedocs.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index e81dd5d..be79e36 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -34,6 +34,7 @@ build: # Optionally declare the Python requirements required to build your docs python: - pip_install: true + version: "3.9" install: - requirements: docs/root/requirements.txt + - method: setuptools From 0c1c56e76ad7fb2a791f3013529217dce8f39b2b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Eckel?= Date: Mon, 9 May 2022 11:48:58 +0200 Subject: [PATCH 11/17] fixed path MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jürgen Eckel --- .readthedocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.readthedocs.yml b/.readthedocs.yml index be79e36..d8e94e7 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -38,3 +38,4 @@ python: install: - requirements: docs/root/requirements.txt - method: setuptools + path: . From 48c89907050e59d5c694f4ac8fd6daa2b310dd3a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Eckel?= Date: Mon, 9 May 2022 11:49:47 +0200 Subject: [PATCH 12/17] rm version MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jürgen Eckel --- .readthedocs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index d8e94e7..841753b 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -34,7 +34,6 @@ build: # Optionally declare the Python requirements required to build your docs python: - version: "3.9" install: - requirements: docs/root/requirements.txt - method: setuptools From 395f078e9e2c1f297ee57c55f03e7f6bfb64fc97 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Eckel?= Date: Mon, 9 May 2022 11:55:40 +0200 Subject: [PATCH 13/17] changed installation order MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jürgen Eckel --- .readthedocs.yml | 25 ++----------------------- 1 file changed, 2 insertions(+), 23 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 841753b..d1a6b51 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -3,38 +3,17 @@ # SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0) # Code is Apache-2.0 and docs are CC-BY-4.0 -#build: -# image: latest -#python: -# version: 3.9 -# pip_install: true - - -# Required version: 2 -# Set the version of Python and other tools you might need + build: os: ubuntu-20.04 tools: python: "3.9" - # You can also specify other tool versions: - # nodejs: "16" - # rust: "1.55" - # golang: "1.17" -# Build documentation in the docs/ directory with Sphinx -#sphinx: -# configuration: docs/root/source/conf.py - -# If using Sphinx, optionally build your docs in additional formats such as PDF -# formats: -# - pdf - -# Optionally declare the Python requirements required to build your docs python: install: - - requirements: docs/root/requirements.txt - method: setuptools path: . + - requirements: docs/root/requirements.txt From 5d22dfa1149d9fe8993458051ae3d6fb8ab75c0e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Eckel?= Date: Tue, 10 May 2022 00:08:39 +0200 Subject: [PATCH 14/17] upgraded sphinx MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jürgen Eckel --- docs/root/requirements.txt | 5 +++-- docs/root/source/conf.py | 19 ++++++++++--------- 2 files changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/root/requirements.txt b/docs/root/requirements.txt index f04211f..fd9c9f9 100644 --- a/docs/root/requirements.txt +++ b/docs/root/requirements.txt @@ -1,5 +1,5 @@ -Sphinx~=1.0 -recommonmark>=0.4.0 +Sphinx>=2.1.0 +#recommonmark>=0.4.0 sphinx-rtd-theme>=0.1.9 sphinxcontrib-napoleon>=0.4.4 sphinxcontrib-httpdomain>=1.5.0 @@ -8,3 +8,4 @@ aafigure>=0.6 packaging~=18.0 wget jinja2==3.0.0 +myst-parser diff --git a/docs/root/source/conf.py b/docs/root/source/conf.py index 8dee073..0e9dc83 100644 --- a/docs/root/source/conf.py +++ b/docs/root/source/conf.py @@ -23,9 +23,7 @@ import sys import inspect from os import rename, remove -from recommonmark.parser import CommonMarkParser - - +#from recommonmark.parser import CommonMarkParser # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -51,9 +49,12 @@ sys.path.insert(0,parentdir) # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. +project = 'Planetmint' + import sphinx_rtd_theme extensions = [ + 'myst_parser', 'sphinx.ext.autosectionlabel', 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', @@ -61,6 +62,7 @@ extensions = [ 'sphinx.ext.viewcode', 'sphinx.ext.todo', 'sphinx.ext.napoleon', + #'sphinx.project', 'sphinxcontrib.httpdomain', 'aafigure.sphinxext', # Below are actually build steps made to look like sphinx extensions. @@ -99,9 +101,9 @@ autodoc_default_options = { 'members': None, } -source_parsers = { - '.md': CommonMarkParser, -} +#source_parsers = { +# '.md': CommonMarkParser, +#} # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: @@ -115,9 +117,8 @@ source_suffix = ['.rst', '.md'] # The master toctree document. master_doc = 'index' - +autosectionlabel_prefix_document = True # General information about the project. -project = 'Planetmint' now = datetime.datetime.now() copyright = str(now.year) + ', Planetmint Contributors' author = 'Planetmint Contributors' @@ -137,7 +138,7 @@ release = _version['__version__'] # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: From ff897848ea567fcb07b08e6ff6d94d1809a12f22 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Eckel?= Date: Tue, 10 May 2022 00:15:45 +0200 Subject: [PATCH 15/17] fixed requirements MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jürgen Eckel --- docs/root/requirements.txt | 51 ++++++++++++++++++++++++++++++-------- 1 file changed, 40 insertions(+), 11 deletions(-) diff --git a/docs/root/requirements.txt b/docs/root/requirements.txt index fd9c9f9..1f5622f 100644 --- a/docs/root/requirements.txt +++ b/docs/root/requirements.txt @@ -1,11 +1,40 @@ -Sphinx>=2.1.0 -#recommonmark>=0.4.0 -sphinx-rtd-theme>=0.1.9 -sphinxcontrib-napoleon>=0.4.4 -sphinxcontrib-httpdomain>=1.5.0 -pyyaml>=4.2b1 -aafigure>=0.6 -packaging~=18.0 -wget -jinja2==3.0.0 -myst-parser +aafigure==0.6 +alabaster==0.7.12 +Babel==2.10.1 +certifi==2021.10.8 +charset-normalizer==2.0.12 +commonmark==0.9.1 +docutils==0.17.1 +idna==3.3 +imagesize==1.3.0 +importlib-metadata==4.11.3 +Jinja2==3.0.0 +markdown-it-py==2.1.0 +MarkupSafe==2.1.1 +mdit-py-plugins==0.3.0 +mdurl==0.1.1 +myst-parser==0.17.2 +packaging==21.3 +pockets==0.9.1 +Pygments==2.12.0 +pyparsing==3.0.8 +pytz==2022.1 +PyYAML==6.0 +recommonmark==0.7.1 +requests==2.27.1 +six==1.16.0 +snowballstemmer==2.2.0 +Sphinx==4.5.0 +sphinx-rtd-theme==1.0.0 +sphinxcontrib-applehelp==1.0.2 +sphinxcontrib-devhelp==1.0.2 +sphinxcontrib-htmlhelp==2.0.0 +sphinxcontrib-httpdomain==1.8.0 +sphinxcontrib-jsmath==1.0.1 +sphinxcontrib-napoleon==0.7 +sphinxcontrib-qthelp==1.0.3 +sphinxcontrib-serializinghtml==1.1.5 +typing-extensions==4.2.0 +urllib3==1.26.9 +wget==3.2 +zipp==3.8.0 From eba8b9220977a4e7de4b15f86031efdbc2bf1987 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Eckel?= Date: Tue, 10 May 2022 00:16:44 +0200 Subject: [PATCH 16/17] cleaned up conf.py MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jürgen Eckel --- docs/root/source/conf.py | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/root/source/conf.py b/docs/root/source/conf.py index 0e9dc83..5c082ea 100644 --- a/docs/root/source/conf.py +++ b/docs/root/source/conf.py @@ -23,7 +23,6 @@ import sys import inspect from os import rename, remove -#from recommonmark.parser import CommonMarkParser # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -62,7 +61,6 @@ extensions = [ 'sphinx.ext.viewcode', 'sphinx.ext.todo', 'sphinx.ext.napoleon', - #'sphinx.project', 'sphinxcontrib.httpdomain', 'aafigure.sphinxext', # Below are actually build steps made to look like sphinx extensions. @@ -101,10 +99,6 @@ autodoc_default_options = { 'members': None, } -#source_parsers = { -# '.md': CommonMarkParser, -#} - # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # From 408c42a3a1f4372a8d594c1fb844c4d8ef19d789 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Eckel?= Date: Thu, 12 May 2022 19:26:44 +0200 Subject: [PATCH 17/17] fixed docs to pass the build (#107) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * fixed docs to pass the build Signed-off-by: Jürgen Eckel * fixed docs building issue Signed-off-by: Jürgen Eckel * removed obsolete deps Signed-off-by: Jürgen Eckel * fixed missing reference issue Signed-off-by: Jürgen Eckel * removed warning as error and redo a previous fix Signed-off-by: Jürgen Eckel --- docs/root/Makefile | 2 +- docs/root/requirements.txt | 8 +++----- .../api/http-samples/api-index-response.http | 2 +- .../api/http-samples/index-response.http | 6 +++--- docs/root/source/properties.md | 8 ++++---- docs/root/source/terminology.md | 8 ++++---- setup.py | 20 +++++++++---------- tox.ini | 2 +- 8 files changed, 26 insertions(+), 30 deletions(-) diff --git a/docs/root/Makefile b/docs/root/Makefile index 035608b..357bb5c 100644 --- a/docs/root/Makefile +++ b/docs/root/Makefile @@ -2,7 +2,7 @@ # # You can set these variables from the command line. -SPHINXOPTS = -W +SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = a4 BUILDDIR = build diff --git a/docs/root/requirements.txt b/docs/root/requirements.txt index 1f5622f..8d8ed0f 100644 --- a/docs/root/requirements.txt +++ b/docs/root/requirements.txt @@ -5,7 +5,7 @@ certifi==2021.10.8 charset-normalizer==2.0.12 commonmark==0.9.1 docutils==0.17.1 -idna==3.3 +idna imagesize==1.3.0 importlib-metadata==4.11.3 Jinja2==3.0.0 @@ -19,9 +19,8 @@ pockets==0.9.1 Pygments==2.12.0 pyparsing==3.0.8 pytz==2022.1 -PyYAML==6.0 -recommonmark==0.7.1 -requests==2.27.1 +PyYAML>=5.4.0 +requests>=2.25i.1 six==1.16.0 snowballstemmer==2.2.0 Sphinx==4.5.0 @@ -34,7 +33,6 @@ sphinxcontrib-jsmath==1.0.1 sphinxcontrib-napoleon==0.7 sphinxcontrib-qthelp==1.0.3 sphinxcontrib-serializinghtml==1.1.5 -typing-extensions==4.2.0 urllib3==1.26.9 wget==3.2 zipp==3.8.0 diff --git a/docs/root/source/installation/api/http-samples/api-index-response.http b/docs/root/source/installation/api/http-samples/api-index-response.http index 601f9ef..fe767cd 100644 --- a/docs/root/source/installation/api/http-samples/api-index-response.http +++ b/docs/root/source/installation/api/http-samples/api-index-response.http @@ -4,7 +4,7 @@ Content-Type: application/json { "assets": "/assets/", "blocks": "/blocks/", - "docs": "https://docs.planetmint.com/projects/server/en/v0.9.1/http-client-server-api.html", + "docs": "https://docs.planetmint.com/projects/server/en/v0.9.2/http-client-server-api.html", "metadata": "/metadata/", "outputs": "/outputs/", "streams": "ws://localhost:9985/api/v1/streams/valid_transactions", diff --git a/docs/root/source/installation/api/http-samples/index-response.http b/docs/root/source/installation/api/http-samples/index-response.http index f7e524e..789da5e 100644 --- a/docs/root/source/installation/api/http-samples/index-response.http +++ b/docs/root/source/installation/api/http-samples/index-response.http @@ -6,7 +6,7 @@ Content-Type: application/json "v1": { "assets": "/api/v1/assets/", "blocks": "/api/v1/blocks/", - "docs": "https://docs.planetmint.com/projects/server/en/v0.9.1/http-client-server-api.html", + "docs": "https://docs.planetmint.com/projects/server/en/v0.9.2/http-client-server-api.html", "metadata": "/api/v1/metadata/", "outputs": "/api/v1/outputs/", "streams": "ws://localhost:9985/api/v1/streams/valid_transactions", @@ -14,7 +14,7 @@ Content-Type: application/json "validators": "/api/v1/validators" } }, - "docs": "https://docs.planetmint.com/projects/server/en/v0.9.1/", + "docs": "https://docs.planetmint.com/projects/server/en/v0.9.2/", "software": "Planetmint", - "version": "0.9.1" + "version": "0.9.2" } diff --git a/docs/root/source/properties.md b/docs/root/source/properties.md index 862f464..861fe0a 100644 --- a/docs/root/source/properties.md +++ b/docs/root/source/properties.md @@ -7,7 +7,7 @@ Code is Apache-2.0 and docs are CC-BY-4.0 # Properties of Planetmint -### Decentralization +## Decentralization Decentralization means that no one owns or controls everything, and there is no single point of failure. @@ -23,12 +23,12 @@ If someone has (or gets) admin access to a node, they can mess with that node (e It’s worth noting that not even the admin or superuser of a node can transfer assets. The only way to create a valid transfer transaction is to fulfill the current crypto-conditions on the asset, and the admin/superuser can’t do that because the admin user doesn’t have the necessary information (e.g. private keys). -### Byzantine Fault Tolerance +## Byzantine Fault Tolerance [Tendermint](https://tendermint.io/) is used for consensus and transaction replication, and Tendermint is [Byzantine Fault Tolerant (BFT)](https://en.wikipedia.org/wiki/Byzantine_fault_tolerance). -### Node Diversity +## Node Diversity Steps should be taken to make it difficult for any one actor or event to control or damage “enough” of the nodes. (Because Planetmint Server uses Tendermint, "enough" is ⅓.) There are many kinds of diversity to consider, listed below. It may be quite difficult to have high diversity of all kinds. @@ -39,7 +39,7 @@ Steps should be taken to make it difficult for any one actor or event to control Note: If all the nodes are running the same code, i.e. the same implementation of Planetmint, then a bug in that code could be used to compromise all of the nodes. Ideally, there would be several different, well-maintained implementations of Planetmint Server (e.g. one in Python, one in Go, etc.), so that a consortium could also have a diversity of server implementations. Similar remarks can be made about the operating system. -### Immutability +## Immutability The blockchain community often describes blockchains as “immutable.” If we interpret that word literally, it means that blockchain data is unchangeable or permanent, which is absurd. The data _can_ be changed. For example, a plague might drive humanity extinct; the data would then get corrupted over time due to water damage, thermal noise, and the general increase of entropy. diff --git a/docs/root/source/terminology.md b/docs/root/source/terminology.md index 8c51eca..6827de7 100644 --- a/docs/root/source/terminology.md +++ b/docs/root/source/terminology.md @@ -9,17 +9,17 @@ Code is Apache-2.0 and docs are CC-BY-4.0 There is some specialized terminology associated with Planetmint. To get started, you should at least know the following: -### Planetmint Node +## Planetmint Node **Planetmint node** is a machine (or logical machine) running [Planetmint Server](https://docs.planetmint.com/projects/server/en/latest/introduction.html) and related software. Each node is controlled by one person or organization. **Planetmint node** is a machine (or logical machine) running [Planetmint Server](https://docs.planetmint.io/projects/server/en/latest/introduction.html) and related software. Each node is controlled by one person or organization. -### Planetmint Network +## Planetmint Network A set of Planetmint nodes can connect to each other to form a **Planetmint network**. Each node in the network runs the same software. A Planetmint network may have additional machines to do things such as monitoring. -### Planetmint Consortium +## Planetmint Consortium The people and organizations that run the nodes in a Planetmint network belong to a **Planetmint consortium** (i.e. another organization). A consortium must have some sort of governance structure to make decisions. If a Planetmint network is run by a single company, then the "consortium" is just that company. @@ -27,7 +27,7 @@ The people and organizations that run the nodes in a Planetmint network belong t A Planetmint network is just a bunch of connected nodes. A consortium is an organization which has a Planetmint network, and where each node in that network has a different operator. -### Transactions +## Transactions Are described in detail in `Planetmint Transactions Spec `_ . diff --git a/setup.py b/setup.py index 5b623c8..329e303 100644 --- a/setup.py +++ b/setup.py @@ -35,6 +35,15 @@ def check_setuptools_features(): ' $ pip3 install --upgrade setuptools\n' 'and then run this command again') +import pathlib +import pkg_resources + +with pathlib.Path('docs/root/requirements.txt').open() as requirements_txt: + docs_require= [ + str(requirement) + for requirement + in pkg_resources.parse_requirements(requirements_txt) + ] check_setuptools_features() @@ -47,17 +56,6 @@ dev_require = [ 'twine' ] -docs_require = [ - 'Sphinx~=1.0', - 'recommonmark>=0.4.0', - 'sphinx-rtd-theme>=0.1.9', - 'sphinxcontrib-httpdomain>=1.5.0', - 'sphinxcontrib-napoleon>=0.4.4', - 'aafigure>=0.6', - 'wget', - 'jinja2==3.0.0' -] - tests_require = [ 'coverage', 'pep8', diff --git a/tox.ini b/tox.ini index 4adc024..0cc9c26 100644 --- a/tox.ini +++ b/tox.ini @@ -35,5 +35,5 @@ deps = typing-extensions -r{toxinidir}/docs/root/requirements.txt extras = None -commands = sphinx-build -W -b html -d {envtmpdir}/doctrees . {envtmpdir}/html +commands = sphinx-build -b html -d {envtmpdir}/doctrees . {envtmpdir}/html