runtilities 2.3.0.dev2__tar.gz → 3.0.0.dev1__tar.gz

{runtilities-2.3.0.dev2 → runtilities-3.0.0.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: runtilities
-Version: 2.3.0.dev2
+Version: 3.0.0.dev1
 Summary: running related scripts
 Home-page: http://github.com/louking/running
 Author: Lou King

{runtilities-2.3.0.dev2 → runtilities-3.0.0.dev1}/running/runsignup.py

@@ -1,25 +1,3 @@
-###########################################################################################
-#   runsignup - access methods for runsignup.com
-#
-#   Date        Author      Reason
-#   ----        ------      ------
-#   12/31/17    Lou King    Create from runningahead.com
-#
-#   Copyright 2017 Lou King
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-#
-###########################################################################################
 '''
 runsignup - access methods for runsignup.com
 ===================================================
@@ -52,10 +30,6 @@ names = NameDenormalizer()
 
 # use api.runsignup.com per https://info.runsignup.com/2025/08/06/upgrading-our-api-infrastructure-for-ai-api-runsignup-com/
 
-# login API (deprecated)
-login_url = 'https://api.runsignup.com/rest/login'
-logout_url = 'https://api.runsignup.com/rest/logout'
-
 # methods
 members_url = 'https://api.runsignup.com/rest/club/{club_id}/members'
 getrace_url = 'https://api.runsignup.com/rest/race/{race_id}'
@@ -78,17 +52,21 @@ class RunSignUp():
     '''
     access methods for RunSignUp.com
 
-    either key and secret OR email and password should be supplied
-    key and secret take precedence
+    key and secret should be supplied for authenticated access
+
+    per https://info.runsignup.com/2026/07/17/new-api-registration-requirements/, all API callers must
+    register (free) and supply the resulting token/secret on every call starting 2027-01-01; existing
+    api_key/api_secret credentials are unaffected and continue to be required alongside these
 
     :param key: key from runsignup (direct key, no OAuth)
     :param secret: secret from runsignup (direct secret, no OAuth)
-    :param email: email for use by Login API (deprecated)
-    :param password: password for use by Login API (deprecated)
+    :param api_reg_token: API caller registration token, sent as rsu_api_reg GET parameter
+    :param api_reg_secret: API caller registration secret, sent as X-RSU-API-REG-SECRET header
     :param debug: set to True for debug logging of http requests, default False
     '''
 
-    def __init__(self, userpriv=False, key=None, secret=None, email=None, password=None, debug=False):
+    def __init__(self, userpriv=False, key=None, secret=None,
+                 api_reg_token=None, api_reg_secret=None, debug=False):
         """
         initialize
         """
@@ -108,27 +86,20 @@ class RunSignUp():
             requests_log.setLevel(logging.NOTSET)
             requests_log.propagate = False
 
-        self.userpriv = False
-        if (not key and not email):
-            self.userpriv = True
+        self.userpriv = not key
         if (key and not secret) or (secret and not key):
             raise parameterError('key and secret must be supplied together')
-        if (email and not password) or (password and not email):
-            raise parameterError('email and password must be supplied together')
+        if (api_reg_token and not api_reg_secret) or (api_reg_secret and not api_reg_token):
+            raise parameterError('api_reg_token and api_reg_secret must be supplied together')
 
         self.key = key
         self.secret = secret
-        self.email = email
-        self.password = password
+        self.api_reg_token = api_reg_token
+        self.api_reg_secret = api_reg_secret
         self.debug = debug
         self.client_credentials = {}
 
-        if self.userpriv:
-            self.credentials_type = 'none'
-        elif key:
-            self.credentials_type = 'key'
-        else:
-            self.credentials_type = 'login'
+        self.credentials_type = 'none' if self.userpriv else 'key'
 
     def __enter__(self):
         self.open()
@@ -142,22 +113,18 @@ class RunSignUp():
         # set up session for multiple requests
         self.session = requests.Session()
 
+        # per https://info.runsignup.com/2026/07/17/new-api-registration-requirements/, registration
+        # secret is sent as a header, applies regardless of credentials_type
+        if self.api_reg_secret:
+            self.session.headers.update({'X-RSU-API-REG-SECRET': self.api_reg_secret})
+
         if not self.userpriv:
-            # key / secret supplied - this take precedence
-            if self.credentials_type == 'key':
-                self.client_credentials = {'api_key'    : self.key,
-                                        'api_secret' : self.secret}
-
-            # email / password supplied
-            else:     
-                # login to runsignup - note temporary keys will expire 1 hour after last API call
-                # see https://api.runsignup.com/API/login/POST
-                r = requests.post(login_url, params={'format' : 'json'}, data={'email' : self.email, 'password' : self.password})
-                resp = r.json()
-
-                self.credentials_type = 'login'
-                self.client_credentials = {'tmp_key'    : resp['tmp_key'],
-                                        'tmp_secret' : resp['tmp_secret']}
+            self.client_credentials = {'api_key'    : self.key,
+                                    'api_secret' : self.secret}
+
+        # registration token is sent as a GET parameter alongside whichever credentials were set above
+        if self.api_reg_token:
+            self.client_credentials['rsu_api_reg'] = self.api_reg_token
 
     def close(self):
         '''
@@ -166,8 +133,6 @@ class RunSignUp():
         self.client_credentials = {}
         self.session.close()
 
-        # TODO: should we also log out?
-
     def members(self, club_id, **kwargs):
         '''
         return members accessible to this application
@@ -420,7 +385,8 @@ class RunSignUp():
         return data 
         
 #----------------------------------------------------------------------
-def updatemembercache(club_id, membercachefilename, key=None, secret=None, email=None, password=None, debug=False):
+def updatemembercache(club_id, membercachefilename, key=None, secret=None,
+                       api_reg_token=None, api_reg_secret=None, debug=False):
     if debug:
         # set up debug logging
         thislogger.setLevel(logging.DEBUG)
@@ -431,7 +397,8 @@ def updatemembercache(club_id, membercachefilename, key=None, secret=None, email
         thislogger.propagate = True
 
     # set up access to RunSignUp
-    rsu = RunSignUp(key=key, secret=secret, email=email, password=password, debug=debug)
+    rsu = RunSignUp(key=key, secret=secret,
+                     api_reg_token=api_reg_token, api_reg_secret=api_reg_secret, debug=debug)
     rsu.open()
 
     # transform from RunSignUp to membercache format
@@ -608,7 +575,8 @@ def updatemembercache(club_id, membercachefilename, key=None, secret=None, email
     return rsumembers
 
 #----------------------------------------------------------------------
-def members2csv(club_id, key, secret, mapping, filepath=None, encoding=None):
+def members2csv(club_id, key, secret, mapping, filepath=None, encoding=None,
+                 api_reg_token=None, api_reg_secret=None):
     '''
     Access club_id through RunSignUp API to retrieve members. Return
     list of members as if csv file. Optionally save csv file.
@@ -619,11 +587,13 @@ def members2csv(club_id, key, secret, mapping, filepath=None, encoding=None):
     :param mapping: OrderedDict {'outfield1':'infield1', 'outfield2':outfunction(inrec), ...} or ['inoutfield1', 'inoutfield2', ...]
     :param normfile: (optional) pathname to save csv file
     :param encoding: (optional) encoding to use for file
+    :param api_reg_token: API caller registration token, sent as rsu_api_reg GET parameter
+    :param api_reg_secret: API caller registration secret, sent as X-RSU-API-REG-SECRET header
     :rtype: csv file records, as list
     '''
 
     # get the members from the RunSignUp API
-    with RunSignUp(key=key, secret=secret) as rsu:
+    with RunSignUp(key=key, secret=secret, api_reg_token=api_reg_token, api_reg_secret=api_reg_secret) as rsu:
         members = rsu.members(club_id)
 
     filerows = record2csv(members, mapping, filepath, encoding=encoding)
@@ -879,12 +849,15 @@ class RunSignupFluent(UniversalClient):
     '''
     Fluent interface to RunSignUp API -- see https://universal-client.readthedocs.io
     '''
-    def __init__(self, key=None, secret=None, debug=False):
+    def __init__(self, key=None, secret=None, api_reg_token=None, api_reg_secret=None, debug=False):
         '''
         initialize RunSignUp Fluent client
 
         :param key: api key for RunSignUp
         :param secret: api secret for RunSignUp
+        :param api_reg_token: API caller registration token, sent as rsu_api_reg GET parameter -- see
+            https://info.runsignup.com/2026/07/17/new-api-registration-requirements/
+        :param api_reg_secret: API caller registration secret, sent as X-RSU-API-REG-SECRET header
         :param debug: debug flag
         '''
         # rsuservice = Oauth2Service(
@@ -898,9 +871,12 @@ class RunSignupFluent(UniversalClient):
         self._params = params = {'api_key'    : key,
                                  'api_secret' : secret,
                                  'format'     : 'json' }
-        
-        super().__init__(
-            url='https://api.runsignup.com/rest',
-            params=params,
-        )
+        if api_reg_token:
+            params['rsu_api_reg'] = api_reg_token
+
+        client_kwargs = {'url': 'https://api.runsignup.com/rest', 'params': params}
+        if api_reg_secret:
+            client_kwargs['headers'] = {'X-RSU-API-REG-SECRET': api_reg_secret}
+
+        super().__init__(**client_kwargs)
     

{runtilities-2.3.0.dev2 → runtilities-3.0.0.dev1}/running/version.py

@@ -1,2 +1,2 @@
 # this string is used for the version string in the documentation, as well as the egg
-__version__ = '2.3.0.dev2'
+__version__ = '3.0.0.dev1'

{runtilities-2.3.0.dev2 → runtilities-3.0.0.dev1}/runtilities.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: runtilities
-Version: 2.3.0.dev2
+Version: 3.0.0.dev1
 Summary: running related scripts
 Home-page: http://github.com/louking/running
 Author: Lou King