numerapi 2.19.1__tar.gz → 2.20.0__tar.gz

{numerapi-2.19.1 → numerapi-2.20.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: numerapi
-Version: 2.19.1
+Version: 2.20.0
 Summary: Automatically download and upload data for the Numerai machine learning competition
 Home-page: https://github.com/uuazed/numerapi
 Maintainer: uuazed
@@ -168,5 +168,3 @@ Each command has it's own help page, for example:
 
 Checkout the [detailed API docs](http://numerapi.readthedocs.io/en/latest/api/numerapi.html#module-numerapi.numerapi)
 to learn about all available methods, parameters and returned values.
-
-

{numerapi-2.19.1 → numerapi-2.20.0}/numerapi/base_api.py

@@ -46,12 +46,10 @@ class Api:
         self.tournament_id = 0
         self.global_data_dir = "."
 
-    def _login(self, public_id=None, secret_key=None):
+    def _login(self, public_id: str | None = None, secret_key: str | None = None) -> None:
         # check env variables if not set
-        if not public_id:
-            public_id = os.getenv("NUMERAI_PUBLIC_ID")
-        if not secret_key:
-            secret_key = os.getenv("NUMERAI_SECRET_KEY")
+        if not public_id or not secret_key:
+            public_id, secret_key = utils.load_secrets()
 
         if public_id and secret_key:
             self.token = (public_id, secret_key)
@@ -76,7 +74,7 @@ class Api:
 
     def raw_query(self, query: str, variables: Dict = None,
                   authorization: bool = False,
-                  retries: int = 3, delay: int = 5, backoff: int = 2):
+                  *, retries: int = 3, delay: int = 5, backoff: int = 2):
         """Send a raw request to the Numerai's GraphQL API.
 
         This function allows to build your own queries and fetch results from
@@ -391,15 +389,6 @@ class Api:
         round_num = data["number"]
         return round_num
 
-    def get_account_transactions(self) -> List:
-        """Get all your account deposits and withdrawals.
-
-        DEPRECATED - please use `wallet_transactions` instead"
-        """
-        self.logger.warning(
-            "DEPRECATED - please use `wallet_transactions` instead")
-        return self.wallet_transactions()
-
     def set_bio(self, model_id: str, bio: str) -> bool:
         """Set bio field for a model id.
 
@@ -573,7 +562,6 @@ class Api:
         Args:
             file_path (str): CSV file with predictions that will get uploaded
             tournament (int): ID of the tournament (optional, defaults to None)
-                -- DEPRECATED there is only one tournament nowadays
             model_id (str): Target model UUID (required for accounts with
                 multiple models)
             df (pandas.DataFrame): pandas DataFrame to upload, if function is
@@ -939,129 +927,12 @@ class Api:
     def round_model_performances(self, username: str) -> List[Dict]:
         """Fetch round model performance of a user.
 
-        Args:
-            username (str)
-
-        Returns:
-            list of dicts: list of round model performance entries
-
-            For each entry in the list, there is a dict with the following
-            content:
-
-                * corr (`float`)
-                * corr20V2 (`float` or None)
-                * corr20V2Percentile (`float` or None)
-                * corr20d (`float` or None)
-                * corr20dPercentile (`float` or None)
-                * corrMultiplier (`float`)
-                * corrPercentile (`float`)
-                * corrWMetamodel (`float`)
-                * tc (`float`)
-                * tcPercentile (`float`)
-                * tcMultiplier (`float`)
-                * ic (`float`)
-                * icPercentile (`float`)
-                * fnc (`float`)
-                * fncPercentile (`float`)
-                * fncV3 (`float`)
-                * fncV3Percentile (`float`)
-                * mmc (`float`)
-                * mmc20d (`float` or None)
-                * mmc20dPercentile (`float` or None)
-                * mmcMultiplier (`float`)
-                * mmcPercentile (`float`)
-                * payout (`Decimal`)
-                * roundNumber (`int`)
-                * roundOpenTime (`datetime`)
-                * roundPayoutFactor (`Decimal`)
-                * roundResolveTime (`datetime`)
-                * roundResolved (`bool`)
-                * roundTarget (`str` or None)
-                * selectedStakeValue (`Decimal`)
-
-        Example:
-            >>> api = NumerAPI()
-            >>> api.round_model_performances("uuazed")
-            [{'corr': -0.01296840448965,
-             'corr20V2': None,
-             'corr20V2Percentile': None,
-             'corr20d': None,
-             'corr20dPercentile': None,
-             'corrMultiplier': 1.0,
-             'corrPercentile': 0.0411107104219257,
-             'corrWMetamodel': 0.51542251407092,
-             'tc': 0.1415973344,
-             'tcPercentile': 0.115398485394879,
-             'ic': 0.1415973344,
-             'icPercentile': 0.115398485394879,
-             'fnc': 0.000437631996046271,
-             'fncPercentile': 0.115398485394879,
-             'fncV3': 0.000437631996046271,
-             'fncV3Percentile': 0.115398485394879,
-             'mmc': -0.0152125841680981,
-             'mmc20d': None,
-             'mmc20dPercentile': None,
-             ...
-            ]
+        DEPRECATED - please use `round_model_performances_v2` instead
         """
-        if self.tournament_id == 8:
-            endpoint = "v3UserProfile"
-        elif self.tournament_id == 11:
-            endpoint = "v2SignalsProfile"
-        else:
-            raise ValueError("round_model_performances is not available for ",
-                             f"tournament {self.tournament_id}")
         self.logger.warning(
-            "Deprecated soon. Checkout round_model_performances_v2.")
-        query = f"""
-          query($username: String!) {{
-            {endpoint}(modelName: $username) {{
-              roundModelPerformances {{
-                corr
-                corr20V2
-                corr20V2Percentile
-                corr20d
-                corr20dPercentile
-                corrMultiplier
-                corrPercentile
-                corrWMetamodel
-                tc
-                tcPercentile
-                ic
-                icPercentile
-                fnc
-                fncPercentile
-                fncV3
-                fncV3Percentile
-                mmc
-                mmc20d
-                mmc20dPercentile
-                mmcMultiplier
-                mmcPercentile
-                payout
-                roundNumber
-                roundOpenTime
-                roundPayoutFactor
-                roundResolveTime
-                roundResolved
-                roundTarget
-                selectedStakeValue
-                tcMultiplier
-              }}
-            }}
-          }}
-        """
-        arguments = {'username': username}
-        data = self.raw_query(query, arguments)['data'][endpoint]
-        performances = data['roundModelPerformances']
-        # convert strings to python objects
-        for perf in performances:
-            utils.replace(perf, "roundOpenTime", utils.parse_datetime_string)
-            utils.replace(perf, "roundResolveTime", utils.parse_datetime_string)
-            utils.replace(perf, "payout", utils.parse_float_string)
-            utils.replace(perf, "roundPayoutFactor", utils.parse_float_string)
-            utils.replace(perf, "selectedStakeValue", utils.parse_float_string)
-        return performances
+            "Deprecated. Checkout round_model_performances_v2.")
+        return self.round_model_performances_v2(username)
+
 
     def stake_change(self, nmr, action: str = "decrease",
                      model_id: str = None) -> Dict:
@@ -1196,7 +1067,6 @@ class Api:
             model_id (str): Target model UUID (required for accounts with
                 multiple models)
             tournament (int): ID of the tournament (optional, defaults to 8)
-                -- DEPRECATED there is only one tournament nowadays
 
         Returns:
             dict: stake information with the following content:
@@ -1240,7 +1110,7 @@ class Api:
         arguments = {'tournament': self.tournament_id}
         # in some period in between rounds, "number: 0" returns Value error -
         # "Current round not open for submissions", because there is no active
-        # round. This is catched by the try / except.
+        # round. This is caught by the try / except.
         try:
             raw = self.raw_query(query, arguments)['data']['rounds'][0]
         except ValueError:
@@ -1259,7 +1129,6 @@ class Api:
         Args:
             hours (int, optional): timeframe to consider, defaults to 12
             tournament (int): ID of the tournament (optional)
-                -- DEPRECATED this is now automatically filled
 
         Returns:
             bool: True if a new round has started, False otherwise.
@@ -1281,7 +1150,7 @@ class Api:
         arguments = {'tournament': tournament}
         # in some period in between rounds, "number: 0" returns Value error -
         # "Current round not open for submissions", because there is no active
-        # round. This is catched by the try / except.
+        # round. This is caught by the try / except.
         try:
             raw = self.raw_query(query, arguments)['data']['rounds'][0]
         except ValueError:

{numerapi-2.19.1 → numerapi-2.20.0}/numerapi/cli.py

@@ -112,15 +112,6 @@ def check_new_round(hours=12, tournament=8):
     click.echo(int(napi.check_new_round(hours=hours, tournament=tournament)))
 
 
-@cli.command()
-@click.option(
-    '--model_id', type=str, default=None,
-    help="An account model UUID (required for accounts with multiple models")
-def user(model_id):
-    """Get all information about you! DEPRECATED - use account"""
-    click.echo(prettify(napi.get_user(model_id)))
-
-
 @cli.command()
 def account():
     """Get all information about your account!"""

{numerapi-2.19.1 → numerapi-2.20.0}/numerapi/cryptoapi.py

@@ -1,3 +1,5 @@
+"""API for Numerai Crypto"""
+
 from numerapi import base_api
 
 class CryptoAPI(base_api.Api):

{numerapi-2.19.1 → numerapi-2.20.0}/numerapi/numerapi.py

@@ -28,7 +28,6 @@ class NumerAPI(base_api.Api):
 
         Args:
             tournament (int, optional): ID of the tournament, defaults to 8
-                -- DEPRECATED there is only one tournament nowadays
 
         Returns:
             list of dicts: list of rounds
@@ -81,7 +80,6 @@ class NumerAPI(base_api.Api):
 
         Args:
             tournament (int): optionally filter by ID of the tournament
-                -- DEPRECATED there is only one tournament nowadays
             round_num (int): optionally filter round number
             model_id (str): Target model UUID (required for accounts with
                 multiple models)
@@ -134,112 +132,6 @@ class NumerAPI(base_api.Api):
         filenames.sort(key=lambda f: (f['round_num'], f['tournament']))
         return filenames
 
-    def get_user(self, model_id: str = None) -> Dict:
-        """Get all information about you! DEPRECATED
-
-        Args:
-            model_id (str): Target model UUID (required for accounts with
-                multiple models)
-
-        Returns:
-            dict: user information including the following fields:
-
-                * assignedEthAddress (`str`)
-                * availableNmr (`decimal.Decimal`)
-                * availableUsd (`decimal.Decimal`)
-                * banned (`bool`)
-                * email (`str`)
-                * id (`str`)
-                * insertedAt (`datetime`)
-                * mfaEnabled (`bool`)
-                * status (`str`)
-                * username (`str`)
-                * country (`str)
-                * apiTokens (`list`) each with the following fields:
-                 * name (`str`)
-                 * public_id (`str`)
-                 * scopes (`list of str`)
-                * v2Stake
-                 * status (`str`)
-                 * txHash (`str`)
-
-        Example:
-            >>> api = NumerAPI(secret_key="..", public_id="..")
-            >>> model = api.get_models()['uuazed']
-            >>> api.get_user(model)
-            {'apiTokens': [
-                    {'name': 'tokenname',
-                     'public_id': 'BLABLA',
-                     'scopes': ['upload_submission', 'stake', ..]
-                     }, ..],
-             'assignedEthAddress': '0x0000000000000000000000000001',
-             'availableNmr': Decimal('99.01'),
-             'availableUsd': Decimal('9.47'),
-             'banned': False,
-             'email': 'username@example.com',
-             'country': 'US',
-             'id': '1234-ABC..',
-             'insertedAt': datetime.datetime(2018, 1, 1, 2, 16, 48),
-             'mfaEnabled': False,
-             'status': 'VERIFIED',
-             'username': 'cool username',
-             'v2Stake': None
-             }
-        """
-        self.logger.warning("Method get_user is DEPRECATED, use get_account")
-        query = """
-          query($modelId: String) {
-            user(modelId: $modelId) {
-              username
-              banned
-              assignedEthAddress
-              availableNmr
-              availableUsd
-              email
-              id
-              mfaEnabled
-              status
-              country
-              insertedAt
-              apiTokens {
-                name
-                public_id
-                scopes
-              }
-              v2Stake {
-                status
-                txHash
-              }
-            }
-          }
-        """
-        arguments = {'modelId': model_id}
-        data = self.raw_query(
-            query, arguments, authorization=True)['data']['user']
-        # convert strings to python objects
-        utils.replace(data, "insertedAt", utils.parse_datetime_string)
-        utils.replace(data, "availableUsd", utils.parse_float_string)
-        utils.replace(data, "availableNmr", utils.parse_float_string)
-        return data
-
-    def submission_status(self, model_id: str = None) -> None:
-        """submission status of the last submission associated with the account
-
-        DEPRECATED numerai no longer provides this data. This will be removed
-        in one of the next versions
-
-        Args:
-            model_id (str): Target model UUID (required for accounts with
-                multiple models)
-
-        Example:
-            >>> napi = NumerAPI(secret_key="..", public_id="..")
-            >>> model_id = napi.get_models()['uuazed']
-            >>> napi.submission_status(model_id)
-        """
-        _ = model_id
-        self.logger.warning("Method submission_status is DEPRECATED and will be removed soon.")
-
     def get_leaderboard(self, limit: int = 50, offset: int = 0) -> List[Dict]:
         """Get the current model leaderboard
 
@@ -423,12 +315,6 @@ class NumerAPI(base_api.Api):
         utils.replace(data, "startDate", utils.parse_datetime_string)
         return data
 
-    def daily_user_performances(self, username: str) -> List[Dict]:
-        """DEPRECATED"""
-        self.logger.warning("Method daily_user_performances is DEPRECATED, "
-                            "use daily_model_performances")
-        return self.daily_model_performances(username)
-
     def daily_model_performances(self, username: str) -> List[Dict]:
         """Fetch daily performance of a user.
 

{numerapi-2.19.1 → numerapi-2.20.0}/numerapi/signalsapi.py

@@ -151,23 +151,6 @@ class SignalsAPI(base_api.Api):
         create = self.raw_query(create_query, arguments, authorization=True)
         return create['data']['createSignalsSubmission']['id']
 
-    def submission_status(self, model_id: str = None) -> None:
-        """submission status of the last submission associated with the account
-
-        DEPRECATED numerai no longer provides this data. This will be removed
-        in one of the next versions
-
-        Args:
-            model_id (str)
-
-        Example:
-            >>> api = SignalsAPI(secret_key="..", public_id="..")
-            >>> model_id = api.get_models()['uuazed']
-            >>> api.submission_status(model_id)
-        """
-        _ = model_id
-        self.logger.warning("Method submission_status is DEPRECATED and will be removed soon.")
-
     def public_user_profile(self, username: str) -> Dict:
         """Fetch the public Numerai Signals profile of a user.
 
@@ -301,12 +284,6 @@ class SignalsAPI(base_api.Api):
         path = self.download_dataset("signals/v1.0/live.parquet")
         return pd.read_parquet(path).numerai_ticker.tolist()
 
-    def download_validation_data(self) -> None:
-        """download CSV file with historical targets and ticker universe
-        """
-        self.logger.warning("'download_validation_data' is DEPRECATED.")
-        self.logger.warning("Please use 'download_dataset' and 'list_datasets'")
-
     def stake_get(self, username) -> decimal.Decimal:
         """get current stake for a given users
 

{numerapi-2.19.1 → numerapi-2.20.0}/numerapi/utils.py

@@ -16,6 +16,21 @@ import tqdm
 logger = logging.getLogger(__name__)
 
 
+def load_secrets() -> tuple:
+    """load secrets from environment variables or dotenv file"""
+
+    try:
+        from dotenv import load_dotenv # pylint: disable-msg=import-outside-toplevel
+        load_dotenv()
+    except ImportError:
+        pass
+
+    public_id = os.getenv("NUMERAI_PUBLIC_ID")
+    secret_key = os.getenv("NUMERAI_SECRET_KEY")
+
+    return public_id, secret_key
+
+
 def parse_datetime_string(string: str) -> Optional[datetime.datetime]:
     """try to parse string to datetime object"""
     if string is None:
@@ -91,7 +106,7 @@ def download_file(url: str, dest_path: str, show_progress_bars: bool = True):
 
 
 def post_with_err_handling(url: str, body: str, headers: Dict,
-                           timeout: Optional[int] = None,
+                           *, timeout: Optional[int] = None,
                            retries: int = 3, delay: int = 1, backoff: int = 2
                            ) -> Dict:
     """send `post` request and handle (some) errors that might occur"""

{numerapi-2.19.1 → numerapi-2.20.0}/numerapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: numerapi
-Version: 2.19.1
+Version: 2.20.0
 Summary: Automatically download and upload data for the Numerai machine learning competition
 Home-page: https://github.com/uuazed/numerapi
 Maintainer: uuazed
@@ -168,5 +168,3 @@ Each command has it's own help page, for example:
 
 Checkout the [detailed API docs](http://numerapi.readthedocs.io/en/latest/api/numerapi.html#module-numerapi.numerapi)
 to learn about all available methods, parameters and returned values.
-
-

{numerapi-2.19.1 → numerapi-2.20.0}/numerapi.egg-info/entry_points.txt

@@ -1,3 +1,2 @@
 [console_scripts]
 numerapi = numerapi.cli:cli
-

{numerapi-2.19.1 → numerapi-2.20.0}/setup.py

@@ -6,7 +6,7 @@ def load(path):
     return open(path, 'r').read()
 
 
-numerapi_version = '2.19.1'
+numerapi_version = '2.20.0'
 
 
 classifiers = [