Skip to content
This repository has been archived by the owner on May 31, 2023. It is now read-only.

Update readme to fit Solgate #9

Merged
merged 1 commit into from
Aug 10, 2020
Merged

Conversation

tumido
Copy link
Member

@tumido tumido commented Aug 6, 2020

Related Issues and Dependencies

#7

This introduces a breaking change

  • Yes
  • No

This Pull Request implements

A documentation change - updates the Readme to better fit solgate instead of dh-argo-workflows.

@tumido tumido added the documentation Improvements or additions to documentation label Aug 6, 2020
@sesheta
Copy link
Contributor

sesheta commented Aug 6, 2020

Pre-Commit Test failed! Click here
[INFO] Initializing environment for git://github.com/Lucas-C/pre-commit-hooks.
[INFO] Initializing environment for git://github.com/pre-commit/pre-commit-hooks.
[INFO] Initializing environment for git://github.com/pycqa/pydocstyle.git.
[INFO] Initializing environment for https://github.com/pre-commit/pre-commit-hooks.
[INFO] Initializing environment for https://github.com/pre-commit/mirrors-mypy.
[INFO] Initializing environment for https://github.com/psf/black.
[INFO] Initializing environment for https://gitlab.com/PyCQA/flake8.
[INFO] Initializing environment for https://gitlab.com/PyCQA/flake8:pep8-naming.
[INFO] Installing environment for git://github.com/Lucas-C/pre-commit-hooks.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for git://github.com/pre-commit/pre-commit-hooks.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for git://github.com/pycqa/pydocstyle.git.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/pre-commit/pre-commit-hooks.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/pre-commit/mirrors-mypy.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/psf/black.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://gitlab.com/PyCQA/flake8.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
Tabs remover.............................................................Passed
Trim Trailing Whitespace.................................................Passed
Check for merge conflicts................................................Passed
Fix End of Files.........................................................Passed
Tests should end in _test.py.........................(no files to check)Skipped
Check for added large files..............................................Passed
Check for byte-order marker..............................................Passed
Check for case conflicts.................................................Passed
Check docstring is first.................................................Passed
Check JSON...............................................................Passed
Check for broken symlinks............................(no files to check)Skipped
Detect Private Key.......................................................Passed
Check python ast.........................................................Passed
Debug Statements (Python)................................................Passed
pydocstyle...............................................................Passed
Check Toml...............................................................Passed
Check Yaml...............................................................Passed
Fix End of Files.........................................................Passed
Trim Trailing Whitespace.................................................Passed
mypy.....................................................................Failed
- hook id: mypy
- exit code: 1

solgate/utils/io.py:76: error: Name 're.Pattern' is not defined
solgate/utils/io.py:83: error: Argument 1 to "lru_cache" has incompatible type "Callable[[str], Any]"; expected "Optional[int]"
solgate/utils/io.py:142: error: Need type annotation for 'parser'
solgate/utils/io.py:142: error: Argument 1 to "_create_parser" has incompatible type "str"; expected "Callable[..., <nothing>]"
solgate/utils/io.py:144: error: "_lru_cache_wrapper[Any]" has no attribute "pattern"
solgate/utils/io.py:146: error: "_lru_cache_wrapper[Any]" has no attribute "pattern"
solgate/utils/io.py:152: error: "_lru_cache_wrapper[Any]" has no attribute "attributes"
Found 7 errors in 1 file (checked 10 source files)

black....................................................................Passed
flake8...................................................................Passed

@sesheta
Copy link
Contributor

sesheta commented Aug 6, 2020

Pytest Test failed! Click here
/opt/app-root/lib/python3.6/site-packages/setuptools/dist.py:398: UserWarning: Normalizing '2.0.0-alpha' to '2.0.0a0'
  normalized_version,
running test
running egg_info
creating solgate.egg-info
writing solgate.egg-info/PKG-INFO
writing dependency_links to solgate.egg-info/dependency_links.txt
writing entry points to solgate.egg-info/entry_points.txt
writing requirements to solgate.egg-info/requires.txt
writing top-level names to solgate.egg-info/top_level.txt
writing manifest file 'solgate.egg-info/SOURCES.txt'
reading manifest file 'solgate.egg-info/SOURCES.txt'
writing manifest file 'solgate.egg-info/SOURCES.txt'
running build_ext
solgate (unittest.loader._FailedTest) ... ERROR

======================================================================
ERROR: solgate (unittest.loader._FailedTest)
----------------------------------------------------------------------
ImportError: Failed to import test module: solgate
Traceback (most recent call last):
  File "/usr/lib64/python3.6/unittest/loader.py", line 462, in _find_test_path
    package = self._get_module_from_name(name)
  File "/usr/lib64/python3.6/unittest/loader.py", line 369, in _get_module_from_name
    __import__(name)
  File "/workspace/repo/solgate/__init__.py", line 5, in <module>
    from .lookup import lookup
  File "/workspace/repo/solgate/lookup.py", line 7, in <module>
    from .utils import S3FileSystem, logger
  File "/workspace/repo/solgate/utils/__init__.py", line 5, in <module>
    from .io import serialize, key_formatter
  File "/workspace/repo/solgate/utils/io.py", line 7, in <module>
    from dataclasses import dataclass
ModuleNotFoundError: No module named 'dataclasses'


----------------------------------------------------------------------
Ran 1 test in 0.000s

FAILED (errors=1)
Test failed: <unittest.runner.TextTestResult run=1 errors=1 failures=0>
error: Test failed: <unittest.runner.TextTestResult run=1 errors=1 failures=0>

@sesheta
Copy link
Contributor

sesheta commented Aug 6, 2020

Pre-Commit Test failed! Click here
[INFO] Initializing environment for git://github.com/Lucas-C/pre-commit-hooks.
[INFO] Initializing environment for git://github.com/pre-commit/pre-commit-hooks.
[INFO] Initializing environment for git://github.com/pycqa/pydocstyle.git.
[INFO] Initializing environment for https://github.com/pre-commit/pre-commit-hooks.
[INFO] Initializing environment for https://github.com/pre-commit/mirrors-mypy.
[INFO] Initializing environment for https://github.com/psf/black.
[INFO] Initializing environment for https://gitlab.com/PyCQA/flake8.
[INFO] Initializing environment for https://gitlab.com/PyCQA/flake8:pep8-naming.
[INFO] Installing environment for git://github.com/Lucas-C/pre-commit-hooks.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for git://github.com/pre-commit/pre-commit-hooks.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for git://github.com/pycqa/pydocstyle.git.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/pre-commit/pre-commit-hooks.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/pre-commit/mirrors-mypy.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/psf/black.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://gitlab.com/PyCQA/flake8.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
Tabs remover.............................................................Passed
Trim Trailing Whitespace.................................................Passed
Check for merge conflicts................................................Passed
Fix End of Files.........................................................Passed
Tests should end in _test.py.........................(no files to check)Skipped
Check for added large files..............................................Passed
Check for byte-order marker..............................................Passed
Check for case conflicts.................................................Passed
Check docstring is first.................................................Passed
Check JSON...............................................................Passed
Check for broken symlinks............................(no files to check)Skipped
Detect Private Key.......................................................Passed
Check python ast.........................................................Passed
Debug Statements (Python)................................................Passed
pydocstyle...............................................................Passed
Check Toml...............................................................Passed
Check Yaml...............................................................Passed
Fix End of Files.........................................................Passed
Trim Trailing Whitespace.................................................Passed
mypy.....................................................................Failed
- hook id: mypy
- exit code: 1

solgate/utils/io.py:76: error: Name 're.Pattern' is not defined
solgate/utils/io.py:83: error: Argument 1 to "lru_cache" has incompatible type "Callable[[str], Any]"; expected "Optional[int]"
solgate/utils/io.py:142: error: Need type annotation for 'parser'
solgate/utils/io.py:142: error: Argument 1 to "_create_parser" has incompatible type "str"; expected "Callable[..., <nothing>]"
solgate/utils/io.py:144: error: "_lru_cache_wrapper[Any]" has no attribute "pattern"
solgate/utils/io.py:146: error: "_lru_cache_wrapper[Any]" has no attribute "pattern"
solgate/utils/io.py:152: error: "_lru_cache_wrapper[Any]" has no attribute "attributes"
Found 7 errors in 1 file (checked 10 source files)

black....................................................................Passed
flake8...................................................................Passed

@sesheta
Copy link
Contributor

sesheta commented Aug 6, 2020

Pytest Test failed! Click here
/opt/app-root/lib/python3.6/site-packages/setuptools/dist.py:398: UserWarning: Normalizing '2.0.0-alpha' to '2.0.0a0'
  normalized_version,
running test
running egg_info
creating solgate.egg-info
writing solgate.egg-info/PKG-INFO
writing dependency_links to solgate.egg-info/dependency_links.txt
writing entry points to solgate.egg-info/entry_points.txt
writing requirements to solgate.egg-info/requires.txt
writing top-level names to solgate.egg-info/top_level.txt
writing manifest file 'solgate.egg-info/SOURCES.txt'
reading manifest file 'solgate.egg-info/SOURCES.txt'
writing manifest file 'solgate.egg-info/SOURCES.txt'
running build_ext
solgate (unittest.loader._FailedTest) ... ERROR

======================================================================
ERROR: solgate (unittest.loader._FailedTest)
----------------------------------------------------------------------
ImportError: Failed to import test module: solgate
Traceback (most recent call last):
  File "/usr/lib64/python3.6/unittest/loader.py", line 462, in _find_test_path
    package = self._get_module_from_name(name)
  File "/usr/lib64/python3.6/unittest/loader.py", line 369, in _get_module_from_name
    __import__(name)
  File "/workspace/repo/solgate/__init__.py", line 5, in <module>
    from .lookup import lookup
  File "/workspace/repo/solgate/lookup.py", line 7, in <module>
    from .utils import S3FileSystem, logger
  File "/workspace/repo/solgate/utils/__init__.py", line 5, in <module>
    from .io import serialize, key_formatter
  File "/workspace/repo/solgate/utils/io.py", line 7, in <module>
    from dataclasses import dataclass
ModuleNotFoundError: No module named 'dataclasses'


----------------------------------------------------------------------
Ran 1 test in 0.000s

FAILED (errors=1)
Test failed: <unittest.runner.TextTestResult run=1 errors=1 failures=0>
error: Test failed: <unittest.runner.TextTestResult run=1 errors=1 failures=0>

@4n4nd
Copy link

4n4nd commented Aug 6, 2020

@tumido can you add a bit of a description for the changes in s3.py?

@tumido
Copy link
Member Author

tumido commented Aug 6, 2020

@4n4nd Yeah, sure! 👍 I'll probably rather scrape it away from this PR and issue a more robust fix tomorrow. 🙂

@sesheta
Copy link
Contributor

sesheta commented Aug 6, 2020

Pre-Commit Test failed! Click here
[INFO] Initializing environment for git://github.com/Lucas-C/pre-commit-hooks.
[INFO] Initializing environment for git://github.com/pre-commit/pre-commit-hooks.
[INFO] Initializing environment for git://github.com/pycqa/pydocstyle.git.
[INFO] Initializing environment for https://github.com/pre-commit/pre-commit-hooks.
[INFO] Initializing environment for https://github.com/pre-commit/mirrors-mypy.
[INFO] Initializing environment for https://github.com/psf/black.
[INFO] Initializing environment for https://gitlab.com/PyCQA/flake8.
[INFO] Initializing environment for https://gitlab.com/PyCQA/flake8:pep8-naming.
[INFO] Installing environment for git://github.com/Lucas-C/pre-commit-hooks.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for git://github.com/pre-commit/pre-commit-hooks.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for git://github.com/pycqa/pydocstyle.git.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/pre-commit/pre-commit-hooks.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/pre-commit/mirrors-mypy.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/psf/black.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://gitlab.com/PyCQA/flake8.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
Tabs remover.............................................................Passed
Trim Trailing Whitespace.................................................Passed
Check for merge conflicts................................................Passed
Fix End of Files.........................................................Passed
Tests should end in _test.py.........................(no files to check)Skipped
Check for added large files..............................................Passed
Check for byte-order marker..............................................Passed
Check for case conflicts.................................................Passed
Check docstring is first.................................................Passed
Check JSON...............................................................Passed
Check for broken symlinks............................(no files to check)Skipped
Detect Private Key.......................................................Passed
Check python ast.........................................................Passed
Debug Statements (Python)................................................Passed
pydocstyle...............................................................Passed
Check Toml...............................................................Passed
Check Yaml...............................................................Passed
Fix End of Files.........................................................Passed
Trim Trailing Whitespace.................................................Passed
mypy.....................................................................Failed
- hook id: mypy
- exit code: 1

solgate/utils/io.py:76: error: Name 're.Pattern' is not defined
solgate/utils/io.py:83: error: Argument 1 to "lru_cache" has incompatible type "Callable[[str], Any]"; expected "Optional[int]"
solgate/utils/io.py:142: error: Need type annotation for 'parser'
solgate/utils/io.py:142: error: Argument 1 to "_create_parser" has incompatible type "str"; expected "Callable[..., <nothing>]"
solgate/utils/io.py:144: error: "_lru_cache_wrapper[Any]" has no attribute "pattern"
solgate/utils/io.py:146: error: "_lru_cache_wrapper[Any]" has no attribute "pattern"
solgate/utils/io.py:152: error: "_lru_cache_wrapper[Any]" has no attribute "attributes"
Found 7 errors in 1 file (checked 10 source files)

black....................................................................Passed
flake8...................................................................Passed

@sesheta
Copy link
Contributor

sesheta commented Aug 6, 2020

Pytest Test failed! Click here
/opt/app-root/lib/python3.6/site-packages/setuptools/dist.py:398: UserWarning: Normalizing '2.0.0-alpha' to '2.0.0a0'
  normalized_version,
running test
running egg_info
creating solgate.egg-info
writing solgate.egg-info/PKG-INFO
writing dependency_links to solgate.egg-info/dependency_links.txt
writing entry points to solgate.egg-info/entry_points.txt
writing requirements to solgate.egg-info/requires.txt
writing top-level names to solgate.egg-info/top_level.txt
writing manifest file 'solgate.egg-info/SOURCES.txt'
reading manifest file 'solgate.egg-info/SOURCES.txt'
writing manifest file 'solgate.egg-info/SOURCES.txt'
running build_ext
solgate (unittest.loader._FailedTest) ... ERROR

======================================================================
ERROR: solgate (unittest.loader._FailedTest)
----------------------------------------------------------------------
ImportError: Failed to import test module: solgate
Traceback (most recent call last):
  File "/usr/lib64/python3.6/unittest/loader.py", line 462, in _find_test_path
    package = self._get_module_from_name(name)
  File "/usr/lib64/python3.6/unittest/loader.py", line 369, in _get_module_from_name
    __import__(name)
  File "/workspace/repo/solgate/__init__.py", line 5, in <module>
    from .lookup import lookup
  File "/workspace/repo/solgate/lookup.py", line 7, in <module>
    from .utils import S3FileSystem, logger
  File "/workspace/repo/solgate/utils/__init__.py", line 5, in <module>
    from .io import serialize, key_formatter
  File "/workspace/repo/solgate/utils/io.py", line 7, in <module>
    from dataclasses import dataclass
ModuleNotFoundError: No module named 'dataclasses'


----------------------------------------------------------------------
Ran 1 test in 0.000s

FAILED (errors=1)
Test failed: <unittest.runner.TextTestResult run=1 errors=1 failures=0>
error: Test failed: <unittest.runner.TextTestResult run=1 errors=1 failures=0>

README.md Outdated Show resolved Hide resolved
@sesheta
Copy link
Contributor

sesheta commented Aug 6, 2020

Pre-Commit Test failed! Click here
[INFO] Initializing environment for git://github.com/Lucas-C/pre-commit-hooks.
[INFO] Initializing environment for git://github.com/pre-commit/pre-commit-hooks.
[INFO] Initializing environment for git://github.com/pycqa/pydocstyle.git.
[INFO] Initializing environment for https://github.com/pre-commit/pre-commit-hooks.
[INFO] Initializing environment for https://github.com/pre-commit/mirrors-mypy.
[INFO] Initializing environment for https://github.com/psf/black.
[INFO] Initializing environment for https://gitlab.com/PyCQA/flake8.
[INFO] Initializing environment for https://gitlab.com/PyCQA/flake8:pep8-naming.
[INFO] Installing environment for git://github.com/Lucas-C/pre-commit-hooks.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for git://github.com/pre-commit/pre-commit-hooks.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for git://github.com/pycqa/pydocstyle.git.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/pre-commit/pre-commit-hooks.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/pre-commit/mirrors-mypy.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/psf/black.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://gitlab.com/PyCQA/flake8.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
Tabs remover.............................................................Passed
Trim Trailing Whitespace.................................................Passed
Check for merge conflicts................................................Passed
Fix End of Files.........................................................Passed
Tests should end in _test.py.........................(no files to check)Skipped
Check for added large files..............................................Passed
Check for byte-order marker..............................................Passed
Check for case conflicts.................................................Passed
Check docstring is first.................................................Passed
Check JSON...............................................................Passed
Check for broken symlinks............................(no files to check)Skipped
Detect Private Key.......................................................Passed
Check python ast.........................................................Passed
Debug Statements (Python)................................................Passed
pydocstyle...............................................................Passed
Check Toml...............................................................Passed
Check Yaml...............................................................Passed
Fix End of Files.........................................................Passed
Trim Trailing Whitespace.................................................Passed
mypy.....................................................................Failed
- hook id: mypy
- exit code: 1

solgate/utils/io.py:76: error: Name 're.Pattern' is not defined
solgate/utils/io.py:83: error: Argument 1 to "lru_cache" has incompatible type "Callable[[str], Any]"; expected "Optional[int]"
solgate/utils/io.py:142: error: Need type annotation for 'parser'
solgate/utils/io.py:142: error: Argument 1 to "_create_parser" has incompatible type "str"; expected "Callable[..., <nothing>]"
solgate/utils/io.py:144: error: "_lru_cache_wrapper[Any]" has no attribute "pattern"
solgate/utils/io.py:146: error: "_lru_cache_wrapper[Any]" has no attribute "pattern"
solgate/utils/io.py:152: error: "_lru_cache_wrapper[Any]" has no attribute "attributes"
Found 7 errors in 1 file (checked 10 source files)

black....................................................................Passed
flake8...................................................................Passed

@sesheta
Copy link
Contributor

sesheta commented Aug 6, 2020

Pytest Test failed! Click here
/opt/app-root/lib/python3.6/site-packages/setuptools/dist.py:398: UserWarning: Normalizing '2.0.0-alpha' to '2.0.0a0'
  normalized_version,
running test
running egg_info
creating solgate.egg-info
writing solgate.egg-info/PKG-INFO
writing dependency_links to solgate.egg-info/dependency_links.txt
writing entry points to solgate.egg-info/entry_points.txt
writing requirements to solgate.egg-info/requires.txt
writing top-level names to solgate.egg-info/top_level.txt
writing manifest file 'solgate.egg-info/SOURCES.txt'
reading manifest file 'solgate.egg-info/SOURCES.txt'
writing manifest file 'solgate.egg-info/SOURCES.txt'
running build_ext
solgate (unittest.loader._FailedTest) ... ERROR

======================================================================
ERROR: solgate (unittest.loader._FailedTest)
----------------------------------------------------------------------
ImportError: Failed to import test module: solgate
Traceback (most recent call last):
  File "/usr/lib64/python3.6/unittest/loader.py", line 462, in _find_test_path
    package = self._get_module_from_name(name)
  File "/usr/lib64/python3.6/unittest/loader.py", line 369, in _get_module_from_name
    __import__(name)
  File "/workspace/repo/solgate/__init__.py", line 5, in <module>
    from .lookup import lookup
  File "/workspace/repo/solgate/lookup.py", line 7, in <module>
    from .utils import S3FileSystem, logger
  File "/workspace/repo/solgate/utils/__init__.py", line 5, in <module>
    from .io import serialize, key_formatter
  File "/workspace/repo/solgate/utils/io.py", line 7, in <module>
    from dataclasses import dataclass
ModuleNotFoundError: No module named 'dataclasses'


----------------------------------------------------------------------
Ran 1 test in 0.000s

FAILED (errors=1)
Test failed: <unittest.runner.TextTestResult run=1 errors=1 failures=0>
error: Test failed: <unittest.runner.TextTestResult run=1 errors=1 failures=0>

Copy link

@4n4nd 4n4nd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍
Do you think it would be a good idea to add an example Configuration file?

@4n4nd
Copy link

4n4nd commented Aug 7, 2020

/approve

@tumido
Copy link
Member Author

tumido commented Aug 10, 2020

LGTM
Do you think it would be a good idea to add an example Configuration file?

@4n4nd good idea. 👍 I've added an issue for that and will solve it in another PR. 🙂 #11

@tumido tumido merged commit ef1e466 into aicoe-aiops:master Aug 10, 2020
@tumido tumido deleted the update-readme branch October 19, 2020 12:41
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants