Skip to content

Commit

Permalink
increment version of TRD, improve error message for venv and fix tzpr…
Browse files Browse the repository at this point in the history
…o API documentation

Signed-off-by: jdsika <carlo.van-driesten@vdl.digital>
  • Loading branch information
jdsika committed Nov 19, 2023
1 parent 030bdee commit c268c1c
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 9 deletions.
6 changes: 3 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,17 @@

# General information about the project.
project = "Tezos Reward Distributor (TRD)"
copyright = "2021, see contributors.csv"
copyright = "2023, see contributors.csv"
author = "TRD Organization"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = "9.0"
version = "12.0"
# The full version, including alpha/beta/rc tags.
release = "9.0"
release = "12.0"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ Available configuration parameters are:
mindelegation: TOE #(mindelegation will be shared with everyone)

**tzpro_api_key**
Generate a tzpro API key [here](https://tzpro.io/) if you want to use it as reward or block API.
Generate a tzpro API key [here](https://tzpro.io/) if you want to use it as reward or block API or leave blank.

Example::
tzpro_api_key: XXXXXXXXXX
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Blockwatch: TZPRO

The terms_ of TZPRO note that an account and API key are needed for the use of the API. Please review the [pricing](https://tzpro.io/#pricing) information. For further help contact hello@blockwatch.cc for more information.

In order to use your API key in the application copy and rename the .env.example to .env and add the API key for TZPRO.
In order to use your API key in the application add it to your configuration like tzpro_api_key: XXXXXXXXXX.

TzKT
-----------
Expand Down
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ TRD supports complex payments, pays in batches, and supports three backends for

The [terms and conditions](https://tzpro.io/terms) of TZPRO note that an account and API key are needed for the use of the API. Please review the [pricing](https://tzpro.io/#pricing) information. For further help contact hello@blockwatch.cc for more information.

In order to use your API key in the application copy and rename the .env.example to .env and add the API key for TZPRO.
In order to use your API key in the application add it to your configuration like tzpro_api_key: XXXXXXXXXX.

### TzKT

Expand Down
2 changes: 1 addition & 1 deletion src/Constants.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from datetime import date

# General
VERSION = 11.0
VERSION = 12.0
PYTHON_MAJOR = 3
PYTHON_MINOR = 7
LINER = "--------------------------------------------"
Expand Down
6 changes: 5 additions & 1 deletion src/launch_common.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,11 @@ def installed(package):
def requirements_installed(requirement_path=REQUIREMENTS_FILE_PATH):
if not in_venv():
print(
"Please make sure to activate a virtual environment for python due to breaking changes in Ubutu >= 23.XX:\n"
"System wide installations of packages using pip is deprecated in recent Linux distributions.\n"
"Please make sure to activate a virtual environment for python:\n\n"
"> python3 -m venv env\n"
"> source env/bin/activate\n\n"
"Read the documentation for more information:\n"
"https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/ \n"
)
return False
Expand Down
2 changes: 1 addition & 1 deletion src/util/parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ def add_argument_provider(argparser):
"Set to 'rpc' to use your own local node defined with the -A flag, "
"(it must be an ARCHIVE node in this case). "
"Set to 'prpc' to use a public RPC node defined with the -Ap flag. "
"An alternative for providing reward data is 'tzpro', but an API key associated with your account needs to be provided in the .env file!",
"An alternative for providing reward data is 'tzpro', but an API key associated with your account needs to be provided in your configuration!",
choices=["rpc", "prpc", "tzpro", "tzkt"],
default="tzkt",
)
Expand Down

0 comments on commit c268c1c

Please sign in to comment.