changeset 1223:f7b24987d5fb beta

fixed setup.py file to use same platform as defined in main rhodecode PLATFORM_OTHERS, added docs for lib
author Marcin Kuzminski <marcin@python-works.com>
date Wed, 06 Apr 2011 20:35:50 +0200
parents 2c246d24eb90
children e76833cd555a
files rhodecode/lib/__init__.py setup.py
diffstat 2 files changed, 24 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/rhodecode/lib/__init__.py	Wed Apr 06 20:25:51 2011 +0200
+++ b/rhodecode/lib/__init__.py	Wed Apr 06 20:35:50 2011 +0200
@@ -23,20 +23,33 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-def str2bool(s):
-    if s is None:
+
+def str2bool(_str):
+    """
+    returs True/False value from given string, it tries to translate the
+    string into boolean
+
+    :param _str: string value to translate into boolean
+    :rtype: boolean
+    :returns: boolean from given string
+    """
+    if _str is None:
         return False
-    if s in (True, False):
-        return s
-    s = str(s).strip().lower()
-    return s in ('t', 'true', 'y', 'yes', 'on', '1')
+    if _str in (True, False):
+        return _str
+    _str = str(_str).strip().lower()
+    return _str in ('t', 'true', 'y', 'yes', 'on', '1')
+
 
 def generate_api_key(username, salt=None):
     """
-    Generates uniq API key for given username
+    Generates unique API key for given username,if salt is not given
+    it'll be generated from some random string
 
     :param username: username as string
     :param salt: salt to hash generate KEY
+    :rtype: str
+    :returns: sha1 hash from username+salt
     """
     from tempfile import _RandomNameSequence
     import hashlib
@@ -46,11 +59,12 @@
 
     return hashlib.sha1(username + salt).hexdigest()
 
+
 def safe_unicode(_str, from_encoding='utf8'):
     """
     safe unicode function. In case of UnicodeDecode error we try to return
     unicode with errors replace
-    
+
     :param _str: string to decode
     :rtype: unicode
     :returns: unicode object
--- a/setup.py	Wed Apr 06 20:25:51 2011 +0200
+++ b/setup.py	Wed Apr 06 20:35:50 2011 +0200
@@ -2,6 +2,7 @@
 from rhodecode import get_version
 from rhodecode import __platform__
 from rhodecode import __license__
+from rhodecode import PLATFORM_OTHERS
 
 py_version = sys.version_info
 
@@ -36,7 +37,7 @@
     requirements.append("simplejson")
     requirements.append("pysqlite")
 
-if __platform__ in ('Linux', 'Darwin'):
+if __platform__ in PLATFORM_OTHERS:
     requirements.append("py-bcrypt")