md2linkedin 0.2.2__tar.gz → 0.2.3__tar.gz

{md2linkedin-0.2.2 → md2linkedin-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: md2linkedin
-Version: 0.2.2
+Version: 0.2.3
 Summary: Convert Markdown to LinkedIn-friendly Unicode text
 Keywords: markdown,linkedin,unicode,formatting,conversion
 Author: Indrajeet Patil
@@ -21,7 +21,7 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Text Processing :: Markup
 Classifier: Topic :: Utilities
-Requires-Dist: click>=8.3.3
+Requires-Dist: click>=8.4.0
 Requires-Python: >=3.10
 Project-URL: Homepage, https://github.com/IndrajeetPatil/md2linkedin
 Project-URL: Documentation, https://www.indrapatil.com/md2linkedin/
@@ -53,6 +53,9 @@ natively.
 | pip             | `pip install md2linkedin` |
 | uv              | `uv add md2linkedin`      |
 
+> **Tip:** Run the CLI without installing it with
+> `uvx md2linkedin post.md`.
+
 ## Usage
 
 ### Python API
@@ -85,6 +88,7 @@ print(convert(md))
     I'm thrilled to share that 𝘄𝗲 𝗷𝘂𝘀𝘁 𝗹𝗮𝘂𝗻𝗰𝗵𝗲𝗱 a new product!
 
     Key highlights:
+
     • 𝗣𝗲𝗿𝗳𝗼𝗿𝗺𝗮𝗻𝗰𝗲: 3𝘹 𝘧𝘢𝘴𝘵𝘦𝘳 than the previous version
     • 𝗥𝗲𝗹𝗶𝗮𝗯𝗶𝗹𝗶𝘁𝘆: 𝙯𝙚𝙧𝙤 𝙙𝙤𝙬𝙣𝙩𝙞𝙢𝙚 deployments
     • 𝗗𝗲𝘃𝗲𝗹𝗼𝗽𝗲𝗿 𝗨𝗫: clean, intuitive API
@@ -158,6 +162,10 @@ notable limitations:
 For more examples, check out the package documentation at:
 <https://www.indrapatil.com/md2linkedin/>
 
+## See Also
+
+- [md2linkedin Web App](https://019d695e-8448-ee38-5db3-7ca4acf2ce2c.share.connect.posit.cloud/) — an interactive web interface for `md2linkedin`, built by [Yann Cohen](https://github.com/iamYannC).
+
 ## License
 
 This project is licensed under the MIT License.

{md2linkedin-0.2.2 → md2linkedin-0.2.3}/README.md

@@ -21,6 +21,9 @@ natively.
 | pip             | `pip install md2linkedin` |
 | uv              | `uv add md2linkedin`      |
 
+> **Tip:** Run the CLI without installing it with
+> `uvx md2linkedin post.md`.
+
 ## Usage
 
 ### Python API
@@ -53,6 +56,7 @@ print(convert(md))
     I'm thrilled to share that 𝘄𝗲 𝗷𝘂𝘀𝘁 𝗹𝗮𝘂𝗻𝗰𝗵𝗲𝗱 a new product!
 
     Key highlights:
+
     • 𝗣𝗲𝗿𝗳𝗼𝗿𝗺𝗮𝗻𝗰𝗲: 3𝘹 𝘧𝘢𝘴𝘵𝘦𝘳 than the previous version
     • 𝗥𝗲𝗹𝗶𝗮𝗯𝗶𝗹𝗶𝘁𝘆: 𝙯𝙚𝙧𝙤 𝙙𝙤𝙬𝙣𝙩𝙞𝙢𝙚 deployments
     • 𝗗𝗲𝘃𝗲𝗹𝗼𝗽𝗲𝗿 𝗨𝗫: clean, intuitive API
@@ -126,6 +130,10 @@ notable limitations:
 For more examples, check out the package documentation at:
 <https://www.indrapatil.com/md2linkedin/>
 
+## See Also
+
+- [md2linkedin Web App](https://019d695e-8448-ee38-5db3-7ca4acf2ce2c.share.connect.posit.cloud/) — an interactive web interface for `md2linkedin`, built by [Yann Cohen](https://github.com/iamYannC).
+
 ## License
 
 This project is licensed under the MIT License.

md2linkedin-0.2.3/pyproject.toml

@@ -0,0 +1,139 @@
+[project]
+name = "md2linkedin"
+version = "0.2.3"
+description = "Convert Markdown to LinkedIn-friendly Unicode text"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+license-files = ["LICENSE.md"]
+keywords = [
+    "markdown",
+    "linkedin",
+    "unicode",
+    "formatting",
+    "conversion",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: End Users/Desktop",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Text Processing :: Markup",
+    "Topic :: Utilities",
+]
+dependencies = ["click>=8.4.0"]
+
+[[project.authors]]
+name = "Indrajeet Patil"
+email = "patilindrajeet.science@gmail.com"
+
+[project.scripts]
+md2linkedin = "md2linkedin._cli:main"
+
+[project.urls]
+Homepage = "https://github.com/IndrajeetPatil/md2linkedin"
+Documentation = "https://www.indrapatil.com/md2linkedin/"
+Repository = "https://github.com/IndrajeetPatil/md2linkedin"
+Issues = "https://github.com/IndrajeetPatil/md2linkedin/issues"
+Changelog = "https://github.com/IndrajeetPatil/md2linkedin/blob/main/CHANGELOG.md"
+
+[dependency-groups]
+dev = [
+    "coverage>=7.14.0",
+    "jupyter>=1.1.1",
+    "zensical>=0.0.43",
+    "mkdocstrings-python>=2.0.3",
+    "ty>=0.0.47",
+    "prek>=0.4.1",
+    "pytest>=9.0.3",
+    "pytest-cov>=7.1.0",
+    "pytest-random-order>=1.2.0",
+    "ruff>=0.15.13",
+    "add-trailing-comma>=4.0.0",
+]
+
+[build-system]
+requires = ["uv_build>=0.12.0,<0.13"]
+build-backend = "uv_build"
+
+[tool.ruff]
+fix = true
+preview = true
+unsafe-fixes = true
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "missing-trailing-comma",
+    "incorrect-blank-line-before-class",
+    "multi-line-summary-second-line",
+    "CPY",
+    "ambiguous-unicode-character-docstring",
+    "ambiguous-unicode-character-comment",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = [
+    "D",
+    "assert",
+    "import-private-name",
+    "no-self-use",
+    "ambiguous-unicode-character-string",
+    "magic-value-comparison",
+    "too-many-public-methods",
+]
+
+[tool.ruff.format]
+preview = true
+docstring-code-format = true
+
+[tool.pytest.ini_options]
+addopts = [
+    "--strict-config",
+    "--strict-markers",
+    "-ra",
+    "--verbose",
+    "--random-order",
+]
+testpaths = ["tests"]
+filterwarnings = ["error"]
+xfail_strict = true
+python_files = [
+    "test_*.py",
+    "test-*.py",
+    "tests.py",
+    "test.py",
+]
+
+[tool.coverage.run]
+branch = true
+source = ["md2linkedin"]
+
+[tool.coverage.report]
+fail_under = 100
+format = "markdown"
+sort = "-Cover"
+show_missing = true
+skip_empty = true
+
+[tool.ty.src]
+exclude = [
+    ".venv",
+    "build",
+    "dist",
+    "docs",
+]
+
+[tool.ty.environment]
+python-version = "3.10"
+
+[tool.uv]
+required-version = ">=0.12.0"

md2linkedin-0.2.2/pyproject.toml → md2linkedin-0.2.3/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "md2linkedin"
-version = "0.2.2"
+version = "0.2.3"
 description = "Convert Markdown to LinkedIn-friendly Unicode text"
 readme = "README.md"
 authors = [
@@ -26,7 +26,9 @@ classifiers = [
     "Topic :: Text Processing :: Markup",
     "Topic :: Utilities",
 ]
-dependencies = ["click>=8.3.3"]
+dependencies = [
+    "click>=8.4.0",
+]
 
 [project.scripts]
 md2linkedin = "md2linkedin._cli:main"
@@ -40,21 +42,21 @@ Changelog = "https://github.com/IndrajeetPatil/md2linkedin/blob/main/CHANGELOG.m
 
 [dependency-groups]
 dev = [
-    "coverage>=7.13.5",
+    "coverage>=7.14.0",
     "jupyter>=1.1.1",
-    "zensical>=0.0.36",
+    "zensical>=0.0.43",
     "mkdocstrings-python>=2.0.3",
-    "ty>=0.0.32",
-    "prek>=0.3.10",
+    "ty>=0.0.47",
+    "prek>=0.4.1",
     "pytest>=9.0.3",
     "pytest-cov>=7.1.0",
     "pytest-random-order>=1.2.0",
-    "ruff>=0.15.11",
+    "ruff>=0.15.13",
     "add-trailing-comma>=4.0.0",
 ]
 
 [build-system]
-requires = ["uv_build>=0.11.2,<0.12"]
+requires = ["uv_build>=0.12.0,<0.13"]
 build-backend = "uv_build"
 
 [tool.ruff]
@@ -65,39 +67,35 @@ unsafe-fixes = true
 [tool.ruff.lint]
 select = ["ALL"]
 ignore = [
-    "COM812",
+    # Required for compatibility with Ruff's formatter.
+    "missing-trailing-comma",
+    # Mutually exclusive with D211 and D212, respectively.
+    "incorrect-blank-line-before-class",
+    "multi-line-summary-second-line",
+    # This project uses a repository-level LICENSE instead of per-file notices.
     "CPY",
-    # Docstring content rules — we intentionally omit Returns/Raises sections
-    # in internal helpers, consistent with ignoring D (pydocstyle) above.
-    "D",
-    "DOC",
     # This package's output IS Unicode Mathematical characters; having them in
     # docstring examples and block-comment separators is intentional.
-    "RUF002",
-    "RUF003",
+    "ambiguous-unicode-character-docstring",
+    "ambiguous-unicode-character-comment",
 ]
 
 [tool.ruff.lint.per-file-ignores]
 "tests/*" = [
     # docstring requirements
     "D",
-    "DOC",
     # tests can use asserts
-    "S101",
-    # pytest fixtures (e.g. tmp_path) don't need type annotations
-    "ANN001",
+    "assert",
     # tests legitimately import private internals to test them directly
-    "PLC2701",
+    "import-private-name",
     # test methods inside classes don't need @staticmethod — class grouping is intentional
-    "PLR6301",
+    "no-self-use",
     # test assertions for Unicode output use the literal Unicode chars (intentional)
-    "RUF001",
-    # `== ""` vs `not x` — both forms are acceptable in assertions
-    "PLC1901",
+    "ambiguous-unicode-character-string",
     # magic numbers in assertions are fine (e.g. expected count == 3)
-    "PLR2004",
+    "magic-value-comparison",
     # large test classes are fine when grouping related cases
-    "PLR0904",
+    "too-many-public-methods",
 ]
 
 [tool.ruff.format]
@@ -140,4 +138,4 @@ exclude = [".venv", "build", "dist", "docs"]
 python-version = "3.10"
 
 [tool.uv]
-required-version = ">=0.11.2"
+required-version = ">=0.12.0"

{md2linkedin-0.2.2 → md2linkedin-0.2.3}/src/md2linkedin/_cli.py

@@ -1,4 +1,4 @@
-"""Command-line interface for md2linkedin."""
+"""Command-line interface for converting Markdown with md2linkedin."""
 
 from __future__ import annotations
 
@@ -54,7 +54,7 @@ def main(
     preserve_links: bool,
     no_monospace_code: bool,
 ) -> None:
-    """Convert Markdown to LinkedIn-friendly Unicode text.
+    r"""Convert Markdown to LinkedIn-friendly Unicode text.
 
     Reads from INPUT_FILE (or stdin when INPUT_FILE is omitted) and writes
     LinkedIn-compatible plain text in which bold and italic formatting is
@@ -80,6 +80,10 @@ def main(
 
       # Disable monospace code rendering
       md2linkedin README.md --no-monospace-code
+
+    Raises:
+        click.UsageError: If neither an input file nor piped stdin is provided.
+
     """
     monospace_code = not no_monospace_code
     if input_file is not None:
@@ -112,5 +116,9 @@ def _stdin_is_tty() -> bool:
 
     Extracted into its own function so tests can mock it cleanly without
     fighting Click's own stdin-swapping inside ``CliRunner.invoke``.
+
+    Returns:
+        Whether stdin is connected to an interactive terminal.
+
     """
     return sys.stdin.isatty()

{md2linkedin-0.2.2 → md2linkedin-0.2.3}/src/md2linkedin/_converter.py

@@ -21,7 +21,12 @@ _NESTED_BULLET_MIN_INDENT = 2  # spaces of indentation that triggers a nested bu
 
 
 def _normalize_line_endings(text: str) -> str:
-    """Normalize Windows (\\r\\n) and classic Mac (\\r) line endings to \\n."""
+    r"""Normalize Windows (\\r\\n) and classic Mac (\\r) line endings to \\n.
+
+    Returns:
+        Text containing only Unix-style line endings.
+
+    """
     return text.replace("\r\n", "\n").replace("\r", "\n")
 
 
@@ -37,6 +42,7 @@ def _protect_code(text: str) -> tuple[str, dict[str, str]]:
     Returns:
         A ``(modified_text, placeholder_map)`` tuple where *placeholder_map*
         maps each placeholder back to its original code string.
+
     """
     placeholders: dict[str, str] = {}
 
@@ -76,6 +82,7 @@ def _restore_code(
 
     Returns:
         Text with all placeholders replaced by their original code content.
+
     """
     for key, original in placeholders.items():
         if original.startswith(("```", "~~~")):
@@ -112,6 +119,7 @@ def _strip_html_spans(text: str) -> str:
 
     Returns:
         Text with all span elements removed and their inner content preserved.
+
     """
     prev = None
     while prev != text:
@@ -121,7 +129,7 @@ def _strip_html_spans(text: str) -> str:
 
 
 def _convert_bold_italic(text: str) -> str:
-    """Replace ``***text***`` (or ``___text___``) with bold-italic Unicode.
+    r"""Replace ``***text***`` (or ``___text___``) with bold-italic Unicode.
 
     Must run before :func:`_convert_bold` and :func:`_convert_italic` to
     prevent the triple markers from being consumed piecemeal.
@@ -133,6 +141,7 @@ def _convert_bold_italic(text: str) -> str:
 
     Returns:
         Text with bold-italic markers replaced.
+
     """
     text = re.sub(
         r"(?<!\\)\*{3}(.+?)(?<!\\)\*{3}",
@@ -147,7 +156,7 @@ def _convert_bold_italic(text: str) -> str:
 
 
 def _convert_bold(text: str) -> str:
-    """Replace ``**text**`` (or ``__text__``) with bold Unicode.
+    r"""Replace ``**text**`` (or ``__text__``) with bold Unicode.
 
     Backslash-escaped markers (``\\**``) are not matched.
 
@@ -156,6 +165,7 @@ def _convert_bold(text: str) -> str:
 
     Returns:
         Text with bold markers replaced.
+
     """
     text = re.sub(
         r"(?<!\\)\*{2}(.+?)(?<!\\)\*{2}",
@@ -170,7 +180,7 @@ def _convert_bold(text: str) -> str:
 
 
 def _convert_italic(text: str) -> str:
-    """Replace ``*text*`` or ``_text_`` with italic Unicode.
+    r"""Replace ``*text*`` or ``_text_`` with italic Unicode.
 
     Uses negative look-around to avoid matching asterisks that are part of
     bold (``**``) or bold-italic (``***``) markers already consumed by
@@ -182,6 +192,7 @@ def _convert_italic(text: str) -> str:
 
     Returns:
         Text with italic markers replaced.
+
     """
     # *text* — negative look-around prevents matching residual ** markers or \* escapes
     text = re.sub(
@@ -208,6 +219,7 @@ def _convert_headers(text: str) -> str:
 
     Returns:
         Text with headers replaced by styled plain text.
+
     """
     separator = "━" * 40
 
@@ -269,6 +281,7 @@ def _strip_links(text: str, *, preserve: bool = False) -> str:
 
     Returns:
         Text with links handled according to *preserve*.
+
     """
     if preserve:
         return text
@@ -290,6 +303,7 @@ def _strip_images(text: str) -> str:
 
     Returns:
         Text with image syntax replaced by alt text.
+
     """
     # ![alt](url) → alt  (empty alt → removed)
     return re.sub(
@@ -311,6 +325,7 @@ def _convert_bullets(text: str) -> str:
 
     Returns:
         Text with list markers replaced.
+
     """
 
     def _bullet(m: re.Match[str]) -> str:
@@ -328,6 +343,7 @@ def _strip_blockquotes(text: str) -> str:
 
     Returns:
         Text with blockquote markers stripped from line beginnings.
+
     """
     return re.sub(r"^> ?", "", text, flags=re.MULTILINE)
 
@@ -341,6 +357,7 @@ def _clean_entities(text: str) -> str:
     Returns:
         Text with ``&gt;``, ``&lt;``, ``&amp;``, ``&nbsp;``, ``&quot;``
         replaced by their literal equivalents.
+
     """
     replacements = {
         "&gt;": ">",
@@ -356,13 +373,14 @@ def _clean_entities(text: str) -> str:
 
 
 def _clean_escaped_chars(text: str) -> str:
-    """Remove Markdown backslash escapes (e.g. ``\\*`` → ``*``).
+    r"""Remove Markdown backslash escapes (e.g. ``\\*`` → ``*``).
 
     Args:
         text: Input text.
 
     Returns:
         Text with backslash escapes resolved.
+
     """
     return re.sub(r"\\([\\`*_{}\[\]()#+\-.!])", r"\1", text)
 
@@ -378,6 +396,7 @@ def _normalize_whitespace(text: str) -> str:
 
     Returns:
         Normalized text with a single trailing newline.
+
     """
     text = re.sub(r"\n{3,}", "\n\n", text)
     return text.strip() + "\n"
@@ -392,7 +411,7 @@ def convert(
     preserve_links: bool = False,
     monospace_code: bool = True,
 ) -> str:
-    """Convert Markdown text to LinkedIn-compatible Unicode plain text.
+    r"""Convert Markdown text to LinkedIn-compatible Unicode plain text.
 
     Bold (``**text**`` / ``__text__``), italic (``*text*`` / ``_text_``), and
     bold-italic (``***text***`` / ``___text___``) markers are replaced with
@@ -433,6 +452,7 @@ def convert(
 
         >>> convert("")
         ''
+
     """
     if not text or not text.strip():
         return ""
@@ -461,7 +481,7 @@ def convert_file(
     preserve_links: bool = False,
     monospace_code: bool = True,
 ) -> Path:
-    """Convert a Markdown file and write the result to a ``.txt`` file.
+    r"""Convert a Markdown file and write the result to a ``.txt`` file.
 
     Args:
         input_path: Path to the Markdown source file (``.md`` or any text
@@ -489,6 +509,7 @@ def convert_file(
         '𝗯𝗼𝗹𝗱 and 𝘪𝘵𝘢𝘭𝘪𝘤\\n'
         >>> os.unlink(tmp)
         ... os.unlink(str(out))
+
     """
     input_path = Path(input_path)
     if not input_path.exists():

{md2linkedin-0.2.2 → md2linkedin-0.2.3}/src/md2linkedin/_unicode.py

@@ -61,6 +61,7 @@ def to_sans_bold(text: str) -> str:
 
         >>> to_sans_bold("")
         ''
+
     """
     out: list[str] = []
     for c in text:
@@ -98,6 +99,7 @@ def to_sans_italic(text: str) -> str:
 
         >>> to_sans_italic("")
         ''
+
     """
     out: list[str] = []
     for c in text:
@@ -130,6 +132,7 @@ def to_sans_bold_italic(text: str) -> str:
 
         >>> to_sans_bold_italic("")
         ''
+
     """
     out: list[str] = []
     for c in text:
@@ -165,6 +168,7 @@ def to_monospace(text: str) -> str:
 
         >>> to_monospace("")
         ''
+
     """
     out: list[str] = []
     for c in text:
@@ -205,6 +209,7 @@ def apply_style(text: str, style: Literal["bold", "italic", "bold_italic"]) -> s
 
         >>> apply_style("hello", "bold_italic")
         '𝙝𝙚𝙡𝙡𝙤'
+
     """
     if style == "bold":
         return to_sans_bold(text)