docstring-to-text 1.0.1__tar.gz → 1.0.2__tar.gz

{docstring_to_text-1.0.1 → docstring_to_text-1.0.2}/.github/workflows/publish-release-to-pypi.yml

@@ -31,7 +31,7 @@ on:
     branches:
       - main
     paths:
-      - "src/docstring_to_text/__package_meta.py"
+      - "src/docstring_to_text/___package_meta.py"
 
 # ====== CONCURRENCY ======
 
@@ -39,7 +39,7 @@ on:
 concurrency:
   group: pypi-publish
   # To group by version:
-  #group: pypi-publish-${{ github.ref }}-${{ hashFiles('src/docstring_to_text/__package_meta.py') }}
+  #group: pypi-publish-${{ github.ref }}-${{ hashFiles('src/docstring_to_text/___package_meta.py') }}
   cancel-in-progress: false  # the second pending run is put into a queue, the third one is cancelled (GitHub limitation)
 
 # ======= ENV VARS =======
@@ -47,8 +47,8 @@ concurrency:
 env:
   # The name on PyPI:
   PACKAGE_NAME: 'docstring-to-text'
-  VERSION_FILE: 'src/docstring_to_text/__package_meta.py'
-  VERSION_MODULE: 'src.docstring_to_text.__package_meta'
+  VERSION_FILE: 'src/docstring_to_text/___package_meta.py'
+  VERSION_MODULE: 'src.docstring_to_text.___package_meta'
   VERSION_VARIABLE: 'VERSION'
 
 # ========= JOBS =========
@@ -270,7 +270,7 @@ jobs:
   # --------------------------------------------------------
 
   github_release:
-    name: Create GitHub Tag 🏷️ and Release 🔄
+    name: GitHub Tag 🏷️ + Release 🔄
     needs: [build, detect-version]
     runs-on: ubuntu-latest
     permissions:

{docstring_to_text-1.0.1 → docstring_to_text-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docstring-to-text
-Version: 1.0.1
+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
@@ -60,7 +71,7 @@ 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.

{docstring_to_text-1.0.1 → docstring_to_text-1.0.2}/README.md

@@ -1,12 +1,23 @@
+<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
@@ -45,7 +56,7 @@ 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.

{docstring_to_text-1.0.1 → docstring_to_text-1.0.2}/pyproject.toml

@@ -29,4 +29,4 @@ classifiers = [
 Issues = "https://github.com/Lex-DRL/Py-docstring-to-text/issues"
 
 [tool.hatch.version]
-path = "src/docstring_to_text/__package_meta.py"
+path = "src/docstring_to_text/___package_meta.py"

docstring_to_text-1.0.1/src/docstring_to_text/__package_meta.py → docstring_to_text-1.0.2/src/docstring_to_text/___package_meta.py

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

{docstring_to_text-1.0.1 → docstring_to_text-1.0.2}/src/docstring_to_text/__init__.py

@@ -3,13 +3,17 @@
 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