fixing requirements and imports

fidelity · Jul 12, 2021 · 50ae500 · 50ae500
1 parent b7c5434
commit 50ae500
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 14 deletions.
diff --git a/.github/workflows/python-coverage.yaml b/.github/workflows/python-coverage.yaml
@@ -29,6 +29,7 @@ jobs:
     - name: Install dependencies and dev dependencies
       run: |
         python -m pip install --upgrade pip
+        pip install -r REQUIREMENTS.txt
         pip install -r ./requirements/DEV_REQUIREMENTS.txt
         pip install -r ./requirements/S3_REQUIREMENTS.txt
 

diff --git a/docs/addons/S3.md b/docs/addons/S3.md
@@ -46,11 +46,11 @@ session = boto3.Session(
 
 ### Using the S3Config Object
 
-As an example let's create a basic `@spock` decorated class, instantiate a `S3Config` object from `spock.addons` with
+As an example let's create a basic `@spock` decorated class, instantiate a `S3Config` object from `spock.addons.s3` with
 the `boto3.session.Session` we created above, and pass it to the `ConfigArgBuilder`.
 
 ```python
-from spock.addons import S3Config
+from spock.addons.s3 import S3Config
 from spock.builder import ConfigArgBuilder
 from spock.config import spock
 from typing import List
@@ -123,8 +123,8 @@ With a `S3Config` object passed into the `ConfigArgBuilder` the S3 URI will auto
 If you require any other settings for uploading or downloading files from S3 the `S3Config` class has two extra 
 attributes:
 
-`download_config` which takes a `S3DownloadConfig` object from `spock.addons` which supports all ExtraArgs from
+`download_config` which takes a `S3DownloadConfig` object from `spock.addons.s3` which supports all ExtraArgs from
 [S3Transfer.ALLOWED_DOWNLOAD_ARGS](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/customizations/s3.html#boto3.s3.transfer.S3Transfer.ALLOWED_DOWNLOAD_ARGS)
 
-`upload_config` which takes a `S3UploadConfig` object from `spock.addons` which supports all ExtraArgs from
+`upload_config` which takes a `S3UploadConfig` object from `spock.addons.s3` which supports all ExtraArgs from
 [S3Transfer.ALLOWED_UPLOAD_ARGS](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/customizations/s3.html#boto3.s3.transfer.S3Transfer.ALLOWED_UPLOAD_ARGS)
diff --git a/examples/tune/optuna/tune.py b/examples/tune/optuna/tune.py
@@ -6,12 +6,11 @@
 # https://optuna.readthedocs.io/en/stable/tutorial/20_recipes/009_ask_and_tell.html#define-and-run
 
 
-import optuna
 from sklearn.datasets import load_iris
 from sklearn.linear_model import LogisticRegression
 from sklearn.model_selection import train_test_split
 
-from spock.addons import spockTuner
+from spock.addons.tune import spockTuner
 from spock.addons.tune.config import (
     ChoiceHyperParameter,
     OptunaTunerConfig,

diff --git a/requirements/DEV_REQUIREMENTS.txt b/requirements/DEV_REQUIREMENTS.txt
@@ -1,5 +1,7 @@
+black
 coveralls
 coverage
+isort
 moto
 portray
 pytest

diff --git a/spock/addons/__init__.py b/spock/addons/__init__.py
@@ -8,8 +8,6 @@
 
 Please refer to the documentation provided in the README.md
 """
-from spock.addons.s3.configs import S3DownloadConfig, S3UploadConfig
-from spock.addons.s3.utils import S3Config
-from spock.addons.tune.config import spockTuner
 
-__all__ = ["s3", "S3Config", "S3DownloadConfig", "S3UploadConfig", "spockTuner"]
+
+__all__ = ["s3", "tune"]
diff --git a/spock/addons/s3/__init__.py b/spock/addons/s3/__init__.py
@@ -9,4 +9,7 @@
 Please refer to the documentation provided in the README.md
 """
 
-__all__ = ["configs", "utils"]
+from spock.addons.s3.configs import S3DownloadConfig, S3UploadConfig
+from spock.addons.s3.configs import S3Config
+
+__all__ = ["configs", "utils", "S3Config", "S3DownloadConfig", "S3UploadConfig"]
diff --git a/spock/addons/tune/__init__.py b/spock/addons/tune/__init__.py
@@ -9,5 +9,6 @@
 Please refer to the documentation provided in the README.md
 """
 
+from spock.addons.tune.config import spockTuner
 
-__all__ = ["builder", "config"]
+__all__ = ["builder", "config", "spockTuner"]
diff --git a/tests/s3/test_io.py b/tests/s3/test_io.py
@@ -2,7 +2,7 @@
 import datetime
 from tests.base.base_asserts_test import *
 from spock.builder import ConfigArgBuilder
-from spock.addons import S3Config
+from spock.addons.s3 import S3Config
 from tests.base.attr_configs_test import *
 from tests.s3.fixtures_test import *
 import re

diff --git a/tests/s3/test_raises.py b/tests/s3/test_raises.py
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 import datetime
 from spock.builder import ConfigArgBuilder
-from spock.addons import S3Config
+from spock.addons.s3 import S3Config
 from tests.base.attr_configs_test import *
 from tests.s3.fixtures_test import *
 import sys