numerapi 2.18.0__tar.gz → 2.19.1__tar.gz

numerapi-2.19.1/PKG-INFO

@@ -0,0 +1,172 @@
+Metadata-Version: 2.1
+Name: numerapi
+Version: 2.19.1
+Summary: Automatically download and upload data for the Numerai machine learning competition
+Home-page: https://github.com/uuazed/numerapi
+Maintainer: uuazed
+Maintainer-email: uuazed@gmail.com
+License: MIT License
+Platform: OS Independent
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+[![Build Status](https://app.travis-ci.com/uuazed/numerapi.svg)](https://app.travis-ci.com/uuazed/numerapi)
+[![codecov](https://codecov.io/gh/uuazed/numerapi/branch/master/graph/badge.svg)](https://codecov.io/gh/uuazed/numerapi)
+[![PyPI](https://img.shields.io/pypi/v/numerapi.svg)](https://pypi.python.org/pypi/numerapi)
+[![Downloads](https://pepy.tech/badge/numerapi/month)](https://pepy.tech/project/numerapi)
+[![Docs](https://readthedocs.org/projects/numerapi/badge/?version=stable)](http://numerapi.readthedocs.io/en/stable/?badge=stable)
+
+# Numerai Python API
+Automatically download and upload data for the Numerai machine learning
+competition.
+
+This library is a Python client to the Numerai API. The interface is programmed
+in Python and allows downloading the training data, uploading predictions, and
+accessing user, submission and competitions information. It works for both, the
+main competition and the newer Numerai Signals competition.
+
+If you encounter a problem or have suggestions, feel free to open an issue.
+
+# Installation
+`pip install --upgrade numerapi`
+
+# Usage
+
+Numerapi can be used as a regular, importable Python module or from the command
+line.
+
+Some actions (like uploading predictions or staking) require a token to verify
+that it is really you interacting with Numerai's API. These tokens consists of
+a `public_id` and `secret_key`. Both can be obtained by login in to Numer.ai and
+going to Account -> Custom API Keys. Tokens can be passed to the Python module
+as parameters or you can be set via environment variables (`NUMERAI_PUBLIC_ID`
+and `NUMERAI_SECRET_KEY`).
+
+## Python module
+
+### Usage example - main competition
+
+    import numerapi
+    # some API calls do not require logging in
+    napi = numerapi.NumerAPI(verbosity="info")
+    # download current dataset => also check `https://numer.ai/data`
+    napi.download_dataset("v4/train.parquet", "train.parquet")
+    # get current leaderboard
+    leaderboard = napi.get_leaderboard()
+    # check if a new round has started
+    if napi.check_new_round():
+        print("new round has started within the last 12hours!")
+    else:
+        print("no new round within the last 12 hours")
+
+    # provide api tokens
+    example_public_id = "somepublicid"
+    example_secret_key = "somesecretkey"
+    napi = numerapi.NumerAPI(example_public_id, example_secret_key)
+
+    # upload predictions
+    model_id = napi.get_models()['uuazed']
+    napi.upload_predictions("preds.csv", model_id=model_id)
+    # increase your stake by 1.2 NMR
+    napi.stake_increase(1.2)
+
+    # convert results to a pandas dataframe
+    import pandas as pd
+    df = pd.DataFrame(napi.daily_user_performances("uuazed"))
+
+
+### Usage example - Numerai Signals
+
+    import numerapi
+
+    napi = numerapi.SignalsAPI()
+    # get current leaderboard
+    leaderboard = napi.get_leaderboard()
+
+    # setup API with api tokens
+    example_public_id = "somepublicid"
+    example_secret_key = "somesecretkey"
+    napi = numerapi.SignalsAPI(example_public_id, example_secret_key)
+
+    # upload predictions
+    model_id = napi.get_models()['uuazed']
+    napi.upload_predictions("preds.csv", model_id=model_id)
+
+    # get daily performance as pandas dataframe
+    import pandas as pd
+    df = pd.DataFrame(napi.daily_user_performances("uuazed"))
+
+    # using the diagnostics tool
+    napi.upload_diagnostics("preds.csv", model_id=model_id)
+    # ... or using a pandas DataFrame directly
+    napi.upload_diagnostics(df=df, model_id=model_id)
+    # fetch results
+    napi.diagnostic(model_id)
+
+
+## Command line interface
+
+To get started with the cli interface, let's take a look at the help page:
+
+    $ numerapi --help
+    Usage: numerapi [OPTIONS] COMMAND [ARGS]...
+
+      Wrapper around the Numerai API
+
+      Options:
+        --help  Show this message and exit.
+
+      Commands:
+        account                         Get all information about your account!
+        check-new-round                 Check if a new round has started within...
+        competitions                    Retrieves information about all...
+        current-round                   Get number of the current active round.
+        daily-model-performances        Fetch daily performance of a model.
+        daily-submissions-performances  Fetch daily performance of a user's...
+        dataset-url                     Fetch url of the current dataset.
+        download-dataset                Download specified file for the given...
+        download-dataset-old            Download dataset for the current active...
+        leaderboard                     Get the leaderboard.
+        list-datasets                   List of available data files
+        models                          Get map of account models!
+        profile                         Fetch the public profile of a user.
+        stake-decrease                  Decrease your stake by `value` NMR.
+        stake-drain                     Completely remove your stake.
+        stake-get                       Get stake value of a user.
+        stake-increase                  Increase your stake by `value` NMR.
+        submission-filenames            Get filenames of your submissions
+        submit                          Upload predictions from file.
+        transactions                    List all your deposits and withdrawals.
+        user                            Get all information about you!...
+        version                         Installed numerapi version.
+
+
+Each command has it's own help page, for example:
+
+    $ numerapi submit --help
+    Usage: numerapi submit [OPTIONS] PATH
+
+      Upload predictions from file.
+
+    Options:
+      --tournament INTEGER  The ID of the tournament, defaults to 1
+      --model_id TEXT       An account model UUID (required for accounts with
+                            multiple models
+
+      --help                Show this message and exit.
+
+
+# API Reference
+
+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.18.0 → numerapi-2.19.1}/numerapi/__init__.py

@@ -11,4 +11,5 @@ except pkg_resources.DistributionNotFound:
 # pylint: disable=wrong-import-position
 from numerapi.numerapi import NumerAPI
 from numerapi.signalsapi import SignalsAPI
+from numerapi.cryptoapi import CryptoAPI
 # pylint: enable=wrong-import-position

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

@@ -3,7 +3,7 @@
 import os
 import datetime
 import logging
-from typing import Dict, List
+from typing import Dict, List, Union, Tuple
 from io import BytesIO
 import pytz
 
@@ -655,6 +655,7 @@ class Api:
                     * validationFncV4 (`float`)
                     * validationIcV2 (`float`)
                     * validationRic (`float`)
+                    * validationBmc (`float`)
                 * validationCorrPlusMmcStd (`float`)
                 * validationMmcMean (`float`)
                 * validationCorrStdRating (`float`)
@@ -686,6 +687,7 @@ class Api:
                 * validationCorrV4CorrWExamplePreds (`float`)
                 * validationCorrV4MaxDrawdown (`float`)
                 * validationCorrV4Mean (`float`)
+                * validationBmcMean (`float`)
                 * validationCorrV4Sharpe (`float`)
                 * validationCorrV4Std (`float`)
                 * validationFeatureNeutralCorrV3Mean (`float`)
@@ -737,6 +739,7 @@ class Api:
                     validationFncV4
                     validationIcV2
                     validationRic
+                    validationBmc
                 }
                 status
                 trainedOnVal
@@ -767,6 +770,7 @@ class Api:
                 validationMmcSharpeRating
                 validationMmcStd
                 validationMmcStdRating
+                validationBmcMean
 
                 validationAdjustedSharpe
                 validationApy
@@ -1116,9 +1120,7 @@ class Api:
         """Completely remove your stake.
 
         Args:
-            model_id (str): Target model UUID (required for accounts with
-                multiple models)
-            tournament (int): ID of the tournament (optional, defaults to 8)
+            model_id (str): Target model UUID
 
         Returns:
             dict: stake information with the following content:
@@ -1127,17 +1129,36 @@ class Api:
               * status (`str`)
               * requestedAmount (`decimal.Decimal`)
               * type (`str`)
+              * drain (`bool`)
 
         Example:
             >>> api = NumerAPI(secret_key="..", public_id="..")
-            >>> model = api.get_models()['uuazed']
-            >>> api.stake_drain(model)
+            >>> model_id = api.get_models()['uuazed']
+            >>> api.stake_drain(model_id)
             {'dueDate': None,
              'requestedAmount': decimal.Decimal('11000000'),
              'type': 'decrease',
-             'status': ''}
+             'status': '',
+             'drain": True}
         """
-        return self.stake_decrease(11000000, model_id)
+        query = '''
+            mutation($drain: bool!
+                     $amount: String
+                     $modelId: String) {
+                releaseStake(drain: $drain
+                             modelId: $modelId
+                             amount: $amount) {
+                    id
+                    dueDate
+                    status
+                    type
+                    requestedAmount
+                    drain
+                }
+            }'''
+        arguments = {'drain': True, "modelId": model_id, "amount": '11000000'}
+        raw = self.raw_query(query, arguments, authorization=True)
+        return raw['data']['releaseStake']
 
     def stake_decrease(self, nmr, model_id: str = None) -> Dict:
         """Decrease your stake by `value` NMR.
@@ -1624,3 +1645,78 @@ class Api:
             dest_path = data["filename"]
         path = utils.download_file(data["url"], dest_path)
         return path
+
+    def upload_predictions(self, file_path: str = "predictions.csv",
+                            model_id: str = None,
+                            df: pd.DataFrame = None,
+                            data_datestamp: int = None,
+                            timeout: Union[None, float, Tuple[float, float]] = (10, 600)
+        ) -> str:
+        """Upload predictions from file.
+        Will read TRIGGER_ID from the environment if this model is enabled with
+        a Numerai Compute cluster setup by Numerai CLI.
+
+        Args:
+            file_path (str): CSV file with predictions that will get uploaded
+            model_id (str): Target model UUID (required for accounts with
+                multiple models)
+            df (pandas.DataFrame): pandas DataFrame to upload, if function is
+                given df and file_path, df will be uploaded.
+            data_datestamp (int): Data lag, in case submission is done using
+                data from the previous day(s).
+            timeout (float|tuple(float,float)): waiting time (connection timeout,
+                read timeout)
+
+        Returns:
+            str: submission_id
+
+        Example:
+            >>> api = NumerAPI(secret_key="..", public_id="..")
+            >>> model_id = api.get_models()['uuazed']
+            >>> api.upload_predictions("prediction.cvs", model_id=model_id)
+            '93c46857-fed9-4594-981e-82db2b358daf'
+            >>> # upload from pandas DataFrame directly:
+            >>> api.upload_predictions(df=predictions_df, model_id=model_id)
+        """
+        self.logger.info("uploading predictions...")
+
+        # write the pandas DataFrame as a binary buffer if provided
+        buffer_csv = None
+
+        if df is not None:
+            buffer_csv = BytesIO(df.to_csv(index=False).encode())
+            buffer_csv.name = file_path
+
+        upload_auth = self._upload_auth(
+            'submission_upload_auth', file_path, self.tournament_id, model_id)
+
+        # get compute id if available and pass it along
+        headers = {"x_compute_id": os.getenv("NUMERAI_COMPUTE_ID")}
+        with open(file_path, 'rb') if df is None else buffer_csv as file:
+            requests.put(
+                upload_auth['url'], data=file.read(), headers=headers,
+                timeout=timeout)
+        create_query = '''
+            mutation($filename: String!
+                     $tournament: Int!
+                     $modelId: String
+                     $triggerId: String,
+                     $dataDatestamp: Int) {
+                create_submission(filename: $filename
+                                  tournament: $tournament
+                                  modelId: $modelId
+                                  triggerId: $triggerId
+                                  source: "numerapi"
+                                  dataDatestamp: $dataDatestamp) {
+                    id
+                }
+            }
+            '''
+        arguments = {'filename': upload_auth['filename'],
+                     'tournament': self.tournament_id,
+                     'modelId': model_id,
+                     'triggerId': os.getenv('TRIGGER_ID', None),
+                     'dataDatestamp': data_datestamp}
+        create = self.raw_query(create_query, arguments, authorization=True)
+        submission_id = create['data']['create_submission']['id']
+        return submission_id

numerapi-2.19.1/numerapi/cryptoapi.py

@@ -0,0 +1,8 @@
+from numerapi import base_api
+
+class CryptoAPI(base_api.Api):
+    """"API for Numerai Crypto"""
+
+    def __init__(self, *args, **kwargs):
+        base_api.Api.__init__(self, *args, **kwargs)
+        self.tournament_id = 12

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

@@ -1,12 +1,7 @@
 """API for Numerai Classic"""
 
-import os
 import decimal
-from typing import List, Dict, Tuple, Union
-from io import BytesIO
-
-import requests
-import pandas as pd
+from typing import List, Dict
 
 from numerapi import utils
 from numerapi import base_api
@@ -245,84 +240,6 @@ class NumerAPI(base_api.Api):
         _ = model_id
         self.logger.warning("Method submission_status is DEPRECATED and will be removed soon.")
 
-    def upload_predictions(self, file_path: str = "predictions.csv",
-                           tournament: int = 8,
-                           model_id: str = None,
-                           df: pd.DataFrame = None,
-                           data_datestamp: int = None,
-                           timeout: Union[None, float, Tuple[float, float]] = (10, 600),
-    ) -> str:
-        """Upload predictions from file.
-        Will read TRIGGER_ID from the environment if this model is enabled with
-        a Numerai Compute cluster setup by Numerai CLI.
-
-        Args:
-            file_path (str): CSV file with predictions that will get uploaded
-            tournament (int): ID of the tournament (optional, defaults to 8)
-                -- 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
-                given df and file_path, df will be uploaded.
-            data_datestamp (int): Data lag, in case submission is done using
-                data from the previous day(s).
-            timeout (float|tuple(float,float)): waiting time (connection timeout,
-                read timeout)
-
-        Returns:
-            str: submission_id
-
-        Example:
-            >>> api = NumerAPI(secret_key="..", public_id="..")
-            >>> model_id = api.get_models()['uuazed']
-            >>> api.upload_predictions("prediction.cvs", model_id=model_id)
-            '93c46857-fed9-4594-981e-82db2b358daf'
-            >>> # upload from pandas DataFrame directly:
-            >>> api.upload_predictions(df=predictions_df, model_id=model_id)
-        """
-        self.logger.info("uploading predictions...")
-
-        # write the pandas DataFrame as a binary buffer if provided
-        buffer_csv = None
-
-        if df is not None:
-            buffer_csv = BytesIO(df.to_csv(index=False).encode())
-            buffer_csv.name = file_path
-
-        upload_auth = self._upload_auth(
-            'submission_upload_auth', file_path, tournament, model_id)
-
-        # get compute id if available and pass it along
-        headers = {"x_compute_id": os.getenv("NUMERAI_COMPUTE_ID")}
-        with open(file_path, 'rb') if df is None else buffer_csv as file:
-            requests.put(
-                upload_auth['url'], data=file.read(), headers=headers,
-                timeout=timeout)
-        create_query = '''
-            mutation($filename: String!
-                     $tournament: Int!
-                     $modelId: String
-                     $triggerId: String,
-                     $dataDatestamp: Int) {
-                create_submission(filename: $filename
-                                  tournament: $tournament
-                                  modelId: $modelId
-                                  triggerId: $triggerId
-                                  source: "numerapi"
-                                  dataDatestamp: $dataDatestamp) {
-                    id
-                }
-            }
-            '''
-        arguments = {'filename': upload_auth['filename'],
-                     'tournament': tournament,
-                     'modelId': model_id,
-                     'triggerId': os.getenv('TRIGGER_ID', None),
-                     'dataDatestamp': data_datestamp}
-        create = self.raw_query(create_query, arguments, authorization=True)
-        submission_id = create['data']['create_submission']['id']
-        return submission_id
-
     def get_leaderboard(self, limit: int = 50, offset: int = 0) -> List[Dict]:
         """Get the current model leaderboard
 

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

@@ -82,7 +82,8 @@ class SignalsAPI(base_api.Api):
     def upload_predictions(self, file_path: str = "predictions.csv",
                            model_id: str = None,
                            df: pd.DataFrame = None,
-                           timeout: Union[None, float, Tuple[float, float]] = (10, 60),
+                           data_datestamp: int = None,
+                           timeout: Union[None, float, Tuple[float, float]] = (10, 600)
     ) -> str:
         """Upload predictions from file.
         Will read TRIGGER_ID from the environment if this model is enabled with
@@ -118,45 +119,35 @@ class SignalsAPI(base_api.Api):
             buffer_csv = BytesIO(df.to_csv(index=False).encode())
             buffer_csv.name = file_path
 
-        auth_query = '''
-            query($filename: String!
-                  $modelId: String) {
-              submissionUploadSignalsAuth(filename: $filename
-                                        modelId: $modelId) {
-                    filename
-                    url
-                }
-            }
-            '''
-
-        arguments = {'filename': os.path.basename(file_path),
-                     'modelId': model_id}
-        submission_resp = self.raw_query(auth_query, arguments,
-                                         authorization=True)
-        auth = submission_resp['data']['submissionUploadSignalsAuth']
+        upload_auth = self._upload_auth(
+            'submissionUploadSignalsAuth', file_path,
+            self.tournament_id, model_id)
 
         # get compute id if available and pass it along
         headers = {"x_compute_id": os.getenv("NUMERAI_COMPUTE_ID")}
 
         with open(file_path, 'rb') if df is None else buffer_csv as file:
-            requests.put(auth['url'], data=file.read(),
+            requests.put(upload_auth['url'], data=file.read(),
                          headers=headers, timeout=timeout)
         create_query = '''
             mutation($filename: String!
                      $modelId: String
-                     $triggerId: String) {
+                     $triggerId: String
+                     $dataDatestamp: Int) {
                 createSignalsSubmission(filename: $filename
                                         modelId: $modelId
                                         triggerId: $triggerId
-                                        source: "numerapi") {
+                                        source: "numerapi"
+                                        dataDatestamp: $dataDatestamp) {
                     id
                     firstEffectiveDate
                 }
             }
             '''
-        arguments = {'filename': auth['filename'],
+        arguments = {'filename': upload_auth['filename'],
                      'modelId': model_id,
-                     'triggerId': os.getenv('TRIGGER_ID', None)}
+                     'triggerId': os.getenv('TRIGGER_ID', None),
+                     'dataDatestamp': data_datestamp}
         create = self.raw_query(create_query, arguments, authorization=True)
         return create['data']['createSignalsSubmission']['id']
 
@@ -307,8 +298,8 @@ class SignalsAPI(base_api.Api):
             >>> SignalsAPI().ticker_universe()
             ["MSFT", "AMZN", "APPL", ...]
         """
-        path = self.download_dataset("signals/universe_public.csv")
-        return pd.read_csv(path).ticker.tolist()
+        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

numerapi-2.19.1/numerapi.egg-info/PKG-INFO

@@ -0,0 +1,172 @@
+Metadata-Version: 2.1
+Name: numerapi
+Version: 2.19.1
+Summary: Automatically download and upload data for the Numerai machine learning competition
+Home-page: https://github.com/uuazed/numerapi
+Maintainer: uuazed
+Maintainer-email: uuazed@gmail.com
+License: MIT License
+Platform: OS Independent
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+[![Build Status](https://app.travis-ci.com/uuazed/numerapi.svg)](https://app.travis-ci.com/uuazed/numerapi)
+[![codecov](https://codecov.io/gh/uuazed/numerapi/branch/master/graph/badge.svg)](https://codecov.io/gh/uuazed/numerapi)
+[![PyPI](https://img.shields.io/pypi/v/numerapi.svg)](https://pypi.python.org/pypi/numerapi)
+[![Downloads](https://pepy.tech/badge/numerapi/month)](https://pepy.tech/project/numerapi)
+[![Docs](https://readthedocs.org/projects/numerapi/badge/?version=stable)](http://numerapi.readthedocs.io/en/stable/?badge=stable)
+
+# Numerai Python API
+Automatically download and upload data for the Numerai machine learning
+competition.
+
+This library is a Python client to the Numerai API. The interface is programmed
+in Python and allows downloading the training data, uploading predictions, and
+accessing user, submission and competitions information. It works for both, the
+main competition and the newer Numerai Signals competition.
+
+If you encounter a problem or have suggestions, feel free to open an issue.
+
+# Installation
+`pip install --upgrade numerapi`
+
+# Usage
+
+Numerapi can be used as a regular, importable Python module or from the command
+line.
+
+Some actions (like uploading predictions or staking) require a token to verify
+that it is really you interacting with Numerai's API. These tokens consists of
+a `public_id` and `secret_key`. Both can be obtained by login in to Numer.ai and
+going to Account -> Custom API Keys. Tokens can be passed to the Python module
+as parameters or you can be set via environment variables (`NUMERAI_PUBLIC_ID`
+and `NUMERAI_SECRET_KEY`).
+
+## Python module
+
+### Usage example - main competition
+
+    import numerapi
+    # some API calls do not require logging in
+    napi = numerapi.NumerAPI(verbosity="info")
+    # download current dataset => also check `https://numer.ai/data`
+    napi.download_dataset("v4/train.parquet", "train.parquet")
+    # get current leaderboard
+    leaderboard = napi.get_leaderboard()
+    # check if a new round has started
+    if napi.check_new_round():
+        print("new round has started within the last 12hours!")
+    else:
+        print("no new round within the last 12 hours")
+
+    # provide api tokens
+    example_public_id = "somepublicid"
+    example_secret_key = "somesecretkey"
+    napi = numerapi.NumerAPI(example_public_id, example_secret_key)
+
+    # upload predictions
+    model_id = napi.get_models()['uuazed']
+    napi.upload_predictions("preds.csv", model_id=model_id)
+    # increase your stake by 1.2 NMR
+    napi.stake_increase(1.2)
+
+    # convert results to a pandas dataframe
+    import pandas as pd
+    df = pd.DataFrame(napi.daily_user_performances("uuazed"))
+
+
+### Usage example - Numerai Signals
+
+    import numerapi
+
+    napi = numerapi.SignalsAPI()
+    # get current leaderboard
+    leaderboard = napi.get_leaderboard()
+
+    # setup API with api tokens
+    example_public_id = "somepublicid"
+    example_secret_key = "somesecretkey"
+    napi = numerapi.SignalsAPI(example_public_id, example_secret_key)
+
+    # upload predictions
+    model_id = napi.get_models()['uuazed']
+    napi.upload_predictions("preds.csv", model_id=model_id)
+
+    # get daily performance as pandas dataframe
+    import pandas as pd
+    df = pd.DataFrame(napi.daily_user_performances("uuazed"))
+
+    # using the diagnostics tool
+    napi.upload_diagnostics("preds.csv", model_id=model_id)
+    # ... or using a pandas DataFrame directly
+    napi.upload_diagnostics(df=df, model_id=model_id)
+    # fetch results
+    napi.diagnostic(model_id)
+
+
+## Command line interface
+
+To get started with the cli interface, let's take a look at the help page:
+
+    $ numerapi --help
+    Usage: numerapi [OPTIONS] COMMAND [ARGS]...
+
+      Wrapper around the Numerai API
+
+      Options:
+        --help  Show this message and exit.
+
+      Commands:
+        account                         Get all information about your account!
+        check-new-round                 Check if a new round has started within...
+        competitions                    Retrieves information about all...
+        current-round                   Get number of the current active round.
+        daily-model-performances        Fetch daily performance of a model.
+        daily-submissions-performances  Fetch daily performance of a user's...
+        dataset-url                     Fetch url of the current dataset.
+        download-dataset                Download specified file for the given...
+        download-dataset-old            Download dataset for the current active...
+        leaderboard                     Get the leaderboard.
+        list-datasets                   List of available data files
+        models                          Get map of account models!
+        profile                         Fetch the public profile of a user.
+        stake-decrease                  Decrease your stake by `value` NMR.
+        stake-drain                     Completely remove your stake.
+        stake-get                       Get stake value of a user.
+        stake-increase                  Increase your stake by `value` NMR.
+        submission-filenames            Get filenames of your submissions
+        submit                          Upload predictions from file.
+        transactions                    List all your deposits and withdrawals.
+        user                            Get all information about you!...
+        version                         Installed numerapi version.
+
+
+Each command has it's own help page, for example:
+
+    $ numerapi submit --help
+    Usage: numerapi submit [OPTIONS] PATH
+
+      Upload predictions from file.
+
+    Options:
+      --tournament INTEGER  The ID of the tournament, defaults to 1
+      --model_id TEXT       An account model UUID (required for accounts with
+                            multiple models
+
+      --help                Show this message and exit.
+
+
+# API Reference
+
+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.18.0 → numerapi-2.19.1}/numerapi.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ setup.py
 numerapi/__init__.py
 numerapi/base_api.py
 numerapi/cli.py
+numerapi/cryptoapi.py
 numerapi/numerapi.py
 numerapi/signalsapi.py
 numerapi/utils.py

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

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

numerapi-2.18.0/PKG-INFO

@@ -1,169 +0,0 @@
-Metadata-Version: 2.1
-Name: numerapi
-Version: 2.18.0
-Summary: Automatically download and upload data for the Numerai machine learning competition
-Home-page: https://github.com/uuazed/numerapi
-Maintainer: uuazed
-Maintainer-email: uuazed@gmail.com
-License: MIT License
-Description: [![Build Status](https://app.travis-ci.com/uuazed/numerapi.svg)](https://app.travis-ci.com/uuazed/numerapi)
-        [![codecov](https://codecov.io/gh/uuazed/numerapi/branch/master/graph/badge.svg)](https://codecov.io/gh/uuazed/numerapi)
-        [![PyPI](https://img.shields.io/pypi/v/numerapi.svg)](https://pypi.python.org/pypi/numerapi)
-        [![Downloads](https://pepy.tech/badge/numerapi/month)](https://pepy.tech/project/numerapi)
-        [![Docs](https://readthedocs.org/projects/numerapi/badge/?version=stable)](http://numerapi.readthedocs.io/en/stable/?badge=stable)
-        
-        # Numerai Python API
-        Automatically download and upload data for the Numerai machine learning
-        competition.
-        
-        This library is a Python client to the Numerai API. The interface is programmed
-        in Python and allows downloading the training data, uploading predictions, and
-        accessing user, submission and competitions information. It works for both, the
-        main competition and the newer Numerai Signals competition.
-        
-        If you encounter a problem or have suggestions, feel free to open an issue.
-        
-        # Installation
-        `pip install --upgrade numerapi`
-        
-        # Usage
-        
-        Numerapi can be used as a regular, importable Python module or from the command
-        line.
-        
-        Some actions (like uploading predictions or staking) require a token to verify
-        that it is really you interacting with Numerai's API. These tokens consists of
-        a `public_id` and `secret_key`. Both can be obtained by login in to Numer.ai and
-        going to Account -> Custom API Keys. Tokens can be passed to the Python module
-        as parameters or you can be set via environment variables (`NUMERAI_PUBLIC_ID`
-        and `NUMERAI_SECRET_KEY`).
-        
-        ## Python module
-        
-        ### Usage example - main competition
-        
-            import numerapi
-            # some API calls do not require logging in
-            napi = numerapi.NumerAPI(verbosity="info")
-            # download current dataset => also check `https://numer.ai/data`
-            napi.download_dataset("v4/train.parquet", "train.parquet")
-            # get current leaderboard
-            leaderboard = napi.get_leaderboard()
-            # check if a new round has started
-            if napi.check_new_round():
-                print("new round has started within the last 12hours!")
-            else:
-                print("no new round within the last 12 hours")
-        
-            # provide api tokens
-            example_public_id = "somepublicid"
-            example_secret_key = "somesecretkey"
-            napi = numerapi.NumerAPI(example_public_id, example_secret_key)
-        
-            # upload predictions
-            model_id = napi.get_models()['uuazed']
-            napi.upload_predictions("preds.csv", model_id=model_id)
-            # increase your stake by 1.2 NMR
-            napi.stake_increase(1.2)
-        
-            # convert results to a pandas dataframe
-            import pandas as pd
-            df = pd.DataFrame(napi.daily_user_performances("uuazed"))
-        
-        
-        ### Usage example - Numerai Signals
-        
-            import numerapi
-        
-            napi = numerapi.SignalsAPI()
-            # get current leaderboard
-            leaderboard = napi.get_leaderboard()
-        
-            # setup API with api tokens
-            example_public_id = "somepublicid"
-            example_secret_key = "somesecretkey"
-            napi = numerapi.SignalsAPI(example_public_id, example_secret_key)
-        
-            # upload predictions
-            model_id = napi.get_models()['uuazed']
-            napi.upload_predictions("preds.csv", model_id=model_id)
-        
-            # get daily performance as pandas dataframe
-            import pandas as pd
-            df = pd.DataFrame(napi.daily_user_performances("uuazed"))
-        
-            # using the diagnostics tool
-            napi.upload_diagnostics("preds.csv", model_id=model_id)
-            # ... or using a pandas DataFrame directly
-            napi.upload_diagnostics(df=df, model_id=model_id)
-            # fetch results
-            napi.diagnostic(model_id)
-        
-        
-        ## Command line interface
-        
-        To get started with the cli interface, let's take a look at the help page:
-        
-            $ numerapi --help
-            Usage: numerapi [OPTIONS] COMMAND [ARGS]...
-        
-              Wrapper around the Numerai API
-        
-              Options:
-                --help  Show this message and exit.
-        
-              Commands:
-                account                         Get all information about your account!
-                check-new-round                 Check if a new round has started within...
-                competitions                    Retrieves information about all...
-                current-round                   Get number of the current active round.
-                daily-model-performances        Fetch daily performance of a model.
-                daily-submissions-performances  Fetch daily performance of a user's...
-                dataset-url                     Fetch url of the current dataset.
-                download-dataset                Download specified file for the given...
-                download-dataset-old            Download dataset for the current active...
-                leaderboard                     Get the leaderboard.
-                list-datasets                   List of available data files
-                models                          Get map of account models!
-                profile                         Fetch the public profile of a user.
-                stake-decrease                  Decrease your stake by `value` NMR.
-                stake-drain                     Completely remove your stake.
-                stake-get                       Get stake value of a user.
-                stake-increase                  Increase your stake by `value` NMR.
-                submission-filenames            Get filenames of your submissions
-                submit                          Upload predictions from file.
-                transactions                    List all your deposits and withdrawals.
-                user                            Get all information about you!...
-                version                         Installed numerapi version.
-        
-        
-        Each command has it's own help page, for example:
-        
-            $ numerapi submit --help
-            Usage: numerapi submit [OPTIONS] PATH
-        
-              Upload predictions from file.
-        
-            Options:
-              --tournament INTEGER  The ID of the tournament, defaults to 1
-              --model_id TEXT       An account model UUID (required for accounts with
-                                    multiple models
-        
-              --help                Show this message and exit.
-        
-        
-        # API Reference
-        
-        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.
-        
-Platform: OS Independent
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Environment :: Console
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Scientific/Engineering
-Description-Content-Type: text/markdown

numerapi-2.18.0/numerapi.egg-info/PKG-INFO

@@ -1,169 +0,0 @@
-Metadata-Version: 2.1
-Name: numerapi
-Version: 2.18.0
-Summary: Automatically download and upload data for the Numerai machine learning competition
-Home-page: https://github.com/uuazed/numerapi
-Maintainer: uuazed
-Maintainer-email: uuazed@gmail.com
-License: MIT License
-Description: [![Build Status](https://app.travis-ci.com/uuazed/numerapi.svg)](https://app.travis-ci.com/uuazed/numerapi)
-        [![codecov](https://codecov.io/gh/uuazed/numerapi/branch/master/graph/badge.svg)](https://codecov.io/gh/uuazed/numerapi)
-        [![PyPI](https://img.shields.io/pypi/v/numerapi.svg)](https://pypi.python.org/pypi/numerapi)
-        [![Downloads](https://pepy.tech/badge/numerapi/month)](https://pepy.tech/project/numerapi)
-        [![Docs](https://readthedocs.org/projects/numerapi/badge/?version=stable)](http://numerapi.readthedocs.io/en/stable/?badge=stable)
-        
-        # Numerai Python API
-        Automatically download and upload data for the Numerai machine learning
-        competition.
-        
-        This library is a Python client to the Numerai API. The interface is programmed
-        in Python and allows downloading the training data, uploading predictions, and
-        accessing user, submission and competitions information. It works for both, the
-        main competition and the newer Numerai Signals competition.
-        
-        If you encounter a problem or have suggestions, feel free to open an issue.
-        
-        # Installation
-        `pip install --upgrade numerapi`
-        
-        # Usage
-        
-        Numerapi can be used as a regular, importable Python module or from the command
-        line.
-        
-        Some actions (like uploading predictions or staking) require a token to verify
-        that it is really you interacting with Numerai's API. These tokens consists of
-        a `public_id` and `secret_key`. Both can be obtained by login in to Numer.ai and
-        going to Account -> Custom API Keys. Tokens can be passed to the Python module
-        as parameters or you can be set via environment variables (`NUMERAI_PUBLIC_ID`
-        and `NUMERAI_SECRET_KEY`).
-        
-        ## Python module
-        
-        ### Usage example - main competition
-        
-            import numerapi
-            # some API calls do not require logging in
-            napi = numerapi.NumerAPI(verbosity="info")
-            # download current dataset => also check `https://numer.ai/data`
-            napi.download_dataset("v4/train.parquet", "train.parquet")
-            # get current leaderboard
-            leaderboard = napi.get_leaderboard()
-            # check if a new round has started
-            if napi.check_new_round():
-                print("new round has started within the last 12hours!")
-            else:
-                print("no new round within the last 12 hours")
-        
-            # provide api tokens
-            example_public_id = "somepublicid"
-            example_secret_key = "somesecretkey"
-            napi = numerapi.NumerAPI(example_public_id, example_secret_key)
-        
-            # upload predictions
-            model_id = napi.get_models()['uuazed']
-            napi.upload_predictions("preds.csv", model_id=model_id)
-            # increase your stake by 1.2 NMR
-            napi.stake_increase(1.2)
-        
-            # convert results to a pandas dataframe
-            import pandas as pd
-            df = pd.DataFrame(napi.daily_user_performances("uuazed"))
-        
-        
-        ### Usage example - Numerai Signals
-        
-            import numerapi
-        
-            napi = numerapi.SignalsAPI()
-            # get current leaderboard
-            leaderboard = napi.get_leaderboard()
-        
-            # setup API with api tokens
-            example_public_id = "somepublicid"
-            example_secret_key = "somesecretkey"
-            napi = numerapi.SignalsAPI(example_public_id, example_secret_key)
-        
-            # upload predictions
-            model_id = napi.get_models()['uuazed']
-            napi.upload_predictions("preds.csv", model_id=model_id)
-        
-            # get daily performance as pandas dataframe
-            import pandas as pd
-            df = pd.DataFrame(napi.daily_user_performances("uuazed"))
-        
-            # using the diagnostics tool
-            napi.upload_diagnostics("preds.csv", model_id=model_id)
-            # ... or using a pandas DataFrame directly
-            napi.upload_diagnostics(df=df, model_id=model_id)
-            # fetch results
-            napi.diagnostic(model_id)
-        
-        
-        ## Command line interface
-        
-        To get started with the cli interface, let's take a look at the help page:
-        
-            $ numerapi --help
-            Usage: numerapi [OPTIONS] COMMAND [ARGS]...
-        
-              Wrapper around the Numerai API
-        
-              Options:
-                --help  Show this message and exit.
-        
-              Commands:
-                account                         Get all information about your account!
-                check-new-round                 Check if a new round has started within...
-                competitions                    Retrieves information about all...
-                current-round                   Get number of the current active round.
-                daily-model-performances        Fetch daily performance of a model.
-                daily-submissions-performances  Fetch daily performance of a user's...
-                dataset-url                     Fetch url of the current dataset.
-                download-dataset                Download specified file for the given...
-                download-dataset-old            Download dataset for the current active...
-                leaderboard                     Get the leaderboard.
-                list-datasets                   List of available data files
-                models                          Get map of account models!
-                profile                         Fetch the public profile of a user.
-                stake-decrease                  Decrease your stake by `value` NMR.
-                stake-drain                     Completely remove your stake.
-                stake-get                       Get stake value of a user.
-                stake-increase                  Increase your stake by `value` NMR.
-                submission-filenames            Get filenames of your submissions
-                submit                          Upload predictions from file.
-                transactions                    List all your deposits and withdrawals.
-                user                            Get all information about you!...
-                version                         Installed numerapi version.
-        
-        
-        Each command has it's own help page, for example:
-        
-            $ numerapi submit --help
-            Usage: numerapi submit [OPTIONS] PATH
-        
-              Upload predictions from file.
-        
-            Options:
-              --tournament INTEGER  The ID of the tournament, defaults to 1
-              --model_id TEXT       An account model UUID (required for accounts with
-                                    multiple models
-        
-              --help                Show this message and exit.
-        
-        
-        # API Reference
-        
-        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.
-        
-Platform: OS Independent
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Environment :: Console
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Scientific/Engineering
-Description-Content-Type: text/markdown