dropped get_filepaths from docs, added deprecation warning (#59)

neptune-ai · Oct 7, 2019 · 9d979d5 · 9d979d5
1 parent 0e1b50c
commit 9d979d5
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 75 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -49,7 +49,7 @@
 # The short X.Y version
 version = '0.13'
 # The full version, including alpha/beta/rc tags
-release = '0.13.4'
+release = '0.13.5'
 
 # -- General configuration ---------------------------------------------------
 

diff --git a/docs/examples/code_snapshots.ipynb b/docs/examples/code_snapshots.ipynb
diff --git a/docs/examples/examples_index.rst b/docs/examples/examples_index.rst
@@ -1,7 +1,6 @@
 .. toctree::
    Data versioning <data_versioning>
    Interactive experiment run comparison <interactive_compare_experiments>
-   Code snapshoting <code_snapshots>
    Image directory snapshoting <image_dir_snapshots>
    Hyper parameter comparison <explore_hyperparams_skopt>
    Log binary classification metrics <log_binary_metrics>

diff --git a/neptunecontrib/api/utils.py b/neptunecontrib/api/utils.py
@@ -221,6 +221,14 @@ def get_filepaths(dirpath='.', extensions=None):
                  neptune.send_metric('score', 0.97)
 
     """
+
+    msg = """get_filepaths() is deprecated.
+    Starting from neptune-client==4.9 you can pass ['**/*.py*', '**/*.yaml*', '**/*.yml*']
+    to upload_source_files argument to upload all files with given extensions recursively.
+    Read more https://docs.neptune.ml/neptune-client/docs/project.html
+    """
+    warnings.warn(msg, DeprecationWarning)
+
     if not extensions:
         extensions = ['.py', '.yaml', 'yml']
     files = []

diff --git a/setup.py b/setup.py
@@ -20,7 +20,7 @@ def main():
 
     setup(
         name='neptune-contrib',
-        version='0.13.4',
+        version='0.13.5',
         description='Neptune Python library contributions',
         author='neptune.ml',
         author_email='[email protected]',