File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 11graft src
22
3- include AUTHORS.rst
4- include CHANGELOG.rst
5- include README.md
6- include MANIFEST.in
7-
8- exclude example.ipynb
3+ include *.rst
4+ include LICENSE
95
106prune docs
117prune examples
128prune tests
139prune developer
1410prune .tox
1511
12+ exclude .codecov.yml
1613exclude .gitattributes
1714exclude .gitignore
15+ exclude .readthedocs.yml
1816exclude tox.ini
1917
2018global-exclude *.py[cod] __pycache__/* *.so *.dylib
Original file line number Diff line number Diff line change @@ -132,27 +132,3 @@ def render_docs(func: Callable) -> Callable:
132132
133133 """
134134 return _render_docs (func , doc_dict = DOC_DICT )
135-
136-
137- def scatterkit_banner (version : str = "" , frame_char : str = "-" ) -> str :
138- """Prints ASCII banner resembling the MAICoS Logo with 80 chars width.
139-
140- Parameters
141- ----------
142- version : str
143- Version string to add to the banner.
144- frame_char : str
145- Character used to as framing around the banner.
146-
147- Returns
148- -------
149- banner : str
150- formatted banner
151-
152- """
153- banner = rf"""
154- @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
155- @ SCATTERKIT { version :^8} @
156- @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
157- """
158- return banner .replace ("@" , frame_char )
Original file line number Diff line number Diff line change 1717sys .path .append (str (Path (__file__ ).parents [1 ]))
1818
1919
20- def test_banner ():
21- """Test banner string by checking some necesarry features.
22-
23- The banner is not tested for exact string equality. We just check the necessary
24- features. Everything else is up to the developers to get creative.
25- """
26- # Test the character replacement
27- assert scatterkit .lib .util .scatterkit_banner (frame_char = "%" )[1 ] == "%"
28- # Check for correct number of lines as a sanity check
29- assert scatterkit .lib .util .scatterkit_banner ().count ("\n " ) == 4
30- # Check that newlines are added top and bottom
31- assert scatterkit .lib .util .scatterkit_banner ().startswith ("\n " )
32- assert scatterkit .lib .util .scatterkit_banner ().endswith ("\n " )
33- # Check for correct length of lines (80 characters excluding top and bottom)
34- # Also add in a long version string to check that it doesn't overflow
35- for line in scatterkit .lib .util .scatterkit_banner (version = "v1.10.11" ).split ("\n " )[
36- 1 :- 1
37- ]:
38- assert len (line ) == 80
39- # Check that the version is correctly inserted
40- assert "v0.0.1" in scatterkit .lib .util .scatterkit_banner (version = "v0.0.1" )
41-
42-
4320@pytest .mark .parametrize (
4421 ("doc" , "new_doc" ),
4522 [
You can’t perform that action at this time.
0 commit comments