docstring-to-text 1.0.0__py3-none-any.whl → 1.0.2__py3-none-any.whl

docstring_to_text/{__package_meta.py → ___package_meta.py}

@@ -1,3 +1,3 @@
 # encoding: utf-8
 
-VERSION = "1.0.0"
+VERSION = "1.0.2"

docstring_to_text/__init__.py

@@ -3,13 +3,32 @@
 A simple pip package converting docstrings into clean text (proper paragraphs and indents).
 """
 
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
 import typing as _t
 
 from inspect import cleandoc, getdoc
 import re as _re
 
-from .__package_meta import VERSION
-from .__package_meta import VERSION as __version__
+from .___package_meta import VERSION
+from .___package_meta import VERSION as __version__
+
+# TODO:
+# - lists
+#   formatted with indents
+#   in all lines except for the first one
+#
+# Also...
+#   - preserve indents
+#   - of the entire list
+#
+# And...
+#   - ensure
+#     that
+#     - it all works
+#       with nested lists
 
 
 _re_indent_match = _re.compile(r"(\t*)( +)(\t*)(.*?)$").match

{docstring_to_text-1.0.0.dist-info → docstring_to_text-1.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docstring-to-text
-Version: 1.0.0
+Version: 1.0.2
 Summary: A simple pip package converting docstrings into clean text (proper paragraphs and indents)
 Project-URL: Source Code, https://github.com/Lex-DRL/Py-docstring-to-text
 Project-URL: Issues, https://github.com/Lex-DRL/Py-docstring-to-text/issues
@@ -13,15 +13,26 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 
+<div align="center">
+  
 # docstring-to-text
 
+[![PyPI][pypi-shield]][pypi-url]
+[![][github-release-shield]][github-release-url]
+
+[pypi-shield]: https://img.shields.io/pypi/v/docstring-to-text?logo=pypi
+[pypi-url]: https://pypi.org/p/docstring-to-text
+[github-release-shield]: https://img.shields.io/github/v/release/Lex-DRL/Py-docstring-to-text?logo=github
+[github-release-url]: https://github.com/Lex-DRL/Py-docstring-to-text/releases/latest
+</div>
+
 A simple pip package converting docstrings into clean text (proper paragraphs and indents).
 
 For example, here's a class docstring:
 ```python
 class MyClass:
   """
-  Here's a class.
+  This is a class docstring.
   
   
   It has sphinx-like paragraphs, which can
@@ -34,12 +45,14 @@ class MyClass:
   to preserve paragraphs themselves.
   
   Also, when it comes to lists:
-  - You probably want to separate items
+    - You probably want to separate items
     with new lines.
-  - However, you don't want to preserve
+    - However, you don't want to preserve
     lines inside each item.
-  * And you might need various bullet
-    characters.
+  
+  And...
+  * ... you might need various bullet
+  characters.
   • Including unicode ones.
   
   And don't forget that the list still needs
@@ -58,14 +71,15 @@ clean_text = format_object_docstring(MyClass)
 
 Then, the resulting string would be:
 ```text
-Here's a class.
+This is a class docstring.
 
 It has sphinx-like paragraphs, which can span multiple lines. Any modern IDE would display them as a single line, that wraps the given width.
 You can't just remove all the new lines in the entire string, because you want to preserve paragraphs themselves.
 Also, when it comes to lists:
 - You probably want to separate items with new lines.
 - However, you don't want to preserve lines inside each item.
-* And you might need various bullet characters.
+And...
+* ... you might need various bullet characters.
 • Including unicode ones.
 And don't forget that the list still needs to be separated from the following text.
 ```

docstring_to_text-1.0.2.dist-info/RECORD

@@ -0,0 +1,6 @@
+docstring_to_text/___package_meta.py,sha256=FUBADIvPxuLvXBzbXbL6C1ybLYS24VOYEd_RcSq76tQ,37
+docstring_to_text/__init__.py,sha256=BDcfU7T33sckZzEZFZn2GPezDtb9fkv1A2uo2mPYZas,5000
+docstring_to_text-1.0.2.dist-info/METADATA,sha256=x73dRgwjxhTFwd8D-znLYo7mYL61OdF6UwG9H0ky7VI,2748
+docstring_to_text-1.0.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+docstring_to_text-1.0.2.dist-info/licenses/LICENSE.md,sha256=quBniO1Sk1aqYUzwRO5adu_nnqOKV_4UVU4JVfnWiS0,15373
+docstring_to_text-1.0.2.dist-info/RECORD,,

docstring_to_text-1.0.0.dist-info/RECORD

@@ -1,6 +0,0 @@
-docstring_to_text/__init__.py,sha256=2MJG9bHcgcFFLi5inNMPrX5jK0d5HVyQbQa7UCV1qK4,4568
-docstring_to_text/__package_meta.py,sha256=oj-ODmFPhzd3LWRxF98TKGvRXngna0diWblm3bsLhKQ,37
-docstring_to_text-1.0.0.dist-info/METADATA,sha256=Bl4mySaWiEnpNqTKnsP4m80J0x6KFzdrsHqVCG4Ou7Q,2276
-docstring_to_text-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-docstring_to_text-1.0.0.dist-info/licenses/LICENSE.md,sha256=quBniO1Sk1aqYUzwRO5adu_nnqOKV_4UVU4JVfnWiS0,15373
-docstring_to_text-1.0.0.dist-info/RECORD,,