Merge pull request #1746 from dbcli/RW/move-screenshots-to-doc-dir

Move screenshots directory to docs directory

Author: rolandwalker

MANIFEST.in

@@ -1,4 +1,4 @@
-include LICENSE.txt *.md *.rst screenshots/*
+include LICENSE.txt *.md *.rst doc/screenshots/*
 recursive-include test *.cnf
 recursive-include test *.feature
 recursive-include test *.py

README.md

@@ -7,8 +7,8 @@ A command line client for MySQL that can do auto-completion and syntax highlight
 Homepage: [https://mycli.net](https://mycli.net)
 Documentation: [https://mycli.net/docs](https://mycli.net/docs)
 
-![Completion](screenshots/tables.png)
-![CompletionGif](screenshots/main.gif)
+![Completion](doc/screenshots/tables.png)
+![CompletionGif](doc/screenshots/main.gif)
 
 Postgres Equivalent: [https://pgcli.com](https://pgcli.com)
 

changelog.md

@@ -18,6 +18,7 @@ Internal
 * Collect CLI arguments into a dataclass.
 * Clean up generated files after test runs.
 * Migrate toplevel tool configurations to `pyproject.toml`.
+* Migrate other toplevel files to subdirectories.
 * Gather `pytest` files into a subdirectory, separated from `behave` tests.
 * Refactor: better naming for `prompt_toolkit` utilities.
 

screenshots/main.gif doc/screenshots/main.gifscreenshots/main.gif renamed to doc/screenshots/main.gif

@@ -682,9 +682,9 @@ def test_create_table_like_completion(completer, complete_event):
 
 
 def test_source_eager_completion(completer, complete_event):
-    text = "source sc"
+    text = "source do"
     position = len(text)
-    script_filename = 'script_for_test_suite.sql'
+    script_filename = 'do_these_statements.sql'
     f = open(script_filename, 'w')
     f.close()
     special.register_special_command(..., 'source', '\\. <filename>', 'Execute commands from file.', aliases=['\\.'])
@@ -694,7 +694,7 @@ def test_source_eager_completion(completer, complete_event):
     try:
         assert [x.text for x in result] == [
             script_filename,
-            'screenshots/',
+            'doc/',
         ]
     except AssertionError as e:
         success = False
@@ -706,9 +706,9 @@ def test_source_eager_completion(completer, complete_event):
 
 
 def test_source_leading_dot_suggestions_completion(completer, complete_event):
-    text = "source ./sc"
+    text = "source ./do"
     position = len(text)
-    script_filename = 'script_for_test_suite.sql'
+    script_filename = 'do_these_statements.sql'
     f = open(script_filename, 'w')
     f.close()
     special.register_special_command(..., 'source', '\\. <filename>', 'Execute commands from file.', aliases=['\\.'])
@@ -718,7 +718,7 @@ def test_source_leading_dot_suggestions_completion(completer, complete_event):
     try:
         assert [x.text for x in result] == [
             script_filename,
-            'screenshots/',
+            'doc/',
         ]
     except AssertionError as e:
         success = False

screenshots/tables.png doc/screenshots/tables.pngscreenshots/tables.png renamed to doc/screenshots/tables.png

@@ -288,7 +288,7 @@ def test_cd_command_with_one_nonexistent_folder_name(executor):
 
 @dbtest
 def test_cd_command_with_one_real_folder_name(executor):
-    results = run(executor, 'system cd screenshots')
+    results = run(executor, 'system cd doc')
     # todo would be better to capture stderr but there was a problem with capsys
     assert results[0]['status_plain'] is None