added boilerplates

onionr/coredb/keydb/userinfo.py

@@ -1,3 +1,22 @@
+'''
+    Onionr - Private P2P Communication
+
+    get or set information about a user id
+'''
+'''
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+'''
 import sqlite3
 def get_user_info(core_inst, peer, info):
     '''

onionr/httpapi/__init__.py

@@ -1,5 +1,5 @@
 '''
-    Onionr - P2P Anonymous Storage Network
+    Onionr - Private P2P Communication
 
     This file registers plugin's flask blueprints for the client http server
 '''

onionr/onionrutils/basicrequests.py

@@ -1,3 +1,22 @@
+'''
+    Onionr - Private P2P Communication
+
+    Do HTTP GET or POST requests through a proxy
+'''
+'''
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+'''
 import requests
 import logger, onionrexceptions
 def do_post_request(core_inst, url, data={}, port=0, proxyType='tor'):

onionr/onionrutils/blockmetadata.py

@@ -1,3 +1,22 @@
+'''
+    Onionr - Private P2P Communication
+
+    Module to fetch block metadata from raw block data and process it
+'''
+'''
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+'''
 import json, sqlite3
 import logger, onionrevents
 from onionrusers import onionrusers

onionr/onionrutils/bytesconverter.py

@@ -1,13 +1,14 @@
 def str_to_bytes(data):
+    '''Converts a string to bytes with .encode()'''
     try:
-        data = data.encode()
+        data = data.encode('UTF-8')
     except AttributeError:
         pass
     return data
 
 def bytes_to_str(data):
     try:
-        data = data.decode()
+        data = data.decode('UTF-8')
     except AttributeError:
         pass
     return data

onionr/onionrutils/checkcommunicator.py

@@ -1,3 +1,22 @@
+'''
+    Onionr - Private P2P Communication
+
+    Check if the communicator is running
+'''
+'''
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+'''
 import time, os
 def is_communicator_running(core_inst, timeout = 5, interval = 0.1):
     try:

onionr/onionrutils/epoch.py

@@ -1,3 +1,22 @@
+'''
+    Onionr - Private P2P Communication
+
+    Get floored epoch, or rounded epoch
+'''
+'''
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+'''
 import math, time
 def get_rounded_epoch(roundS=60):
     '''

onionr/onionrutils/escapeansi.py

@@ -3,7 +3,7 @@ def escape_ANSI(line):
     '''
         Remove ANSI escape codes from a string with regex
 
-        taken or adapted from: https://stackoverflow.com/a/38662876 by user https://stackoverflow.com/users/802365/%c3%89douard-lopez
+        adapted from: https://stackoverflow.com/a/38662876 by user https://stackoverflow.com/users/802365/%c3%89douard-lopez
         cc-by-sa-3 license https://creativecommons.org/licenses/by-sa/3.0/
     '''
     ansi_escape = re.compile(r'(\x9B|\x1B\[)[0-?]*[ -/]*[@-~]')

onionr/onionrutils/getclientapiserver.py

@@ -1,3 +1,22 @@
+'''
+    Onionr - Private P2P Communication
+
+    Return the client api server address and port, which is usually random
+'''
+'''
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+'''
 def get_client_API_server(core_inst):
     retData = ''
     try:

onionr/onionrutils/importnewblocks.py

@@ -1,3 +1,22 @@
+'''
+    Onionr - Private P2P Communication
+
+    import new blocks from disk, providing transport agnosticism
+'''
+'''
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+'''
 import glob
 import logger, core
 from onionrutils import blockmetadata

onionr/onionrutils/localcommand.py

@@ -1,3 +1,22 @@
+'''
+    Onionr - Private P2P Communication
+
+    send a command to the local API server
+'''
+'''
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+'''
 import urllib, requests, time
 import logger
 from onionrutils import getclientapiserver

onionr/onionrutils/mnemonickeys.py

@@ -1,3 +1,22 @@
+'''
+    Onionr - Private P2P Communication
+
+    convert a base32 string (intended for ed25519 user ids) to pgp word list
+'''
+'''
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+'''
 import base64
 from etc import pgpwords
 def get_human_readable_ID(core_inst, pub=''):

onionr/onionrutils/stringvalidators.py

@@ -1,3 +1,22 @@
+'''
+    Onionr - Private P2P Communication
+
+    validate various string data types
+'''
+'''
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+'''
 import base64, string
 import unpaddedbase32, nacl.signing, nacl.encoding
 from onionrutils import bytesconverter

onionr/onionrutils/validatemetadata.py

@@ -1,3 +1,22 @@
+'''
+    Onionr - Private P2P Communication
+
+    validate new block's metadata
+'''
+'''
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+'''
 import json
 import logger, onionrexceptions
 from etc import onionrvalues