nkantar/mdut

Markdown URL tag generator

Hi, I’m Nik.

What have you broken today? 🔥

Jokes aside, there’s more from me on 🏡 nkantar.com (namely the 🖋️ blog), and I sometimes toot as 🐘 @[email protected]. What follows here is just a v. quick rundown of what I’m working on in my spare time these days.

I maintain a few projects (in no particular order):

• 🐘 emojidon is an emoji synchronizer for Mastodon.
• 📓 mdut (package, intro) is a tiny utilty for Markdown URL tag generation.
• 🐍 Parsenvy (docs, package, intro) is a Python environment variable parsing library.
• Autohook (intro) is a tiny Git hook manager.
• 🔗 sus (package, intro) is a static redirect generator.
• 🏛️ pep20.org (site) is a website dedicated to one of my favorite things about Python.

There’s more here, but it’s probably not really all that interesting. 😁

mdut's Issues

Add piping support + rethink copying

Currently mdut CLI puts the result into the system clipboard, which is super handy.

However, it may make more sense for it to just pipe it to stdout, and have a -c flag for copying as well, or even do that by default.

Add CD

Maybe publish to PyPI based on a git tag? TBD

Add CI

Just run errythang modd does, basically.

Handle httpx errors better

Some helpful error messages would be lovely, as currently they all just fall right through, like so:

❯ poetry run python src/mdut.py foo://bar
Traceback (most recent call last):
  File "/Users/nik/Library/Caches/pypoetry/virtualenvs/mdut-kQOfudX7-py3.10/lib/python3.10/site-packages/httpx/_transports/default.py", line 60, in map_httpcore_exceptions
    yield
  File "/Users/nik/Library/Caches/pypoetry/virtualenvs/mdut-kQOfudX7-py3.10/lib/python3.10/site-packages/httpx/_transports/default.py", line 187, in handle_request
    resp = self._pool.handle_request(req)
  File "/Users/nik/Library/Caches/pypoetry/virtualenvs/mdut-kQOfudX7-py3.10/lib/python3.10/site-packages/httpcore/_sync/connection_pool.py", line 216, in handle_request
    raise UnsupportedProtocol(
httpcore.UnsupportedProtocol: Request URL has an unsupported protocol 'foo://'.

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/Users/nik/src/nkantar/mdut/src/mdut.py", line 68, in <module>
    mdut()
  File "/Users/nik/Library/Caches/pypoetry/virtualenvs/mdut-kQOfudX7-py3.10/lib/python3.10/site-packages/click/core.py", line 1128, in __call__
    return self.main(*args, **kwargs)
  File "/Users/nik/Library/Caches/pypoetry/virtualenvs/mdut-kQOfudX7-py3.10/lib/python3.10/site-packages/click/core.py", line 1053, in main
    rv = self.invoke(ctx)
  File "/Users/nik/Library/Caches/pypoetry/virtualenvs/mdut-kQOfudX7-py3.10/lib/python3.10/site-packages/click/core.py", line 1395, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/Users/nik/Library/Caches/pypoetry/virtualenvs/mdut-kQOfudX7-py3.10/lib/python3.10/site-packages/click/core.py", line 754, in invoke
    return __callback(*args, **kwargs)
  File "/Users/nik/src/nkantar/mdut/src/mdut.py", line 61, in mdut
    tag = markdown_url_tag(url, style)
  File "/Users/nik/src/nkantar/mdut/src/mdut.py", line 39, in markdown_url_tag
    html = fetch_html(url)
  File "/Users/nik/src/nkantar/mdut/src/mdut.py", line 20, in fetch_html
    return httpx.get(url).text
  File "/Users/nik/Library/Caches/pypoetry/virtualenvs/mdut-kQOfudX7-py3.10/lib/python3.10/site-packages/httpx/_api.py", line 189, in get
    return request(
  File "/Users/nik/Library/Caches/pypoetry/virtualenvs/mdut-kQOfudX7-py3.10/lib/python3.10/site-packages/httpx/_api.py", line 100, in request
    return client.request(
  File "/Users/nik/Library/Caches/pypoetry/virtualenvs/mdut-kQOfudX7-py3.10/lib/python3.10/site-packages/httpx/_client.py", line 802, in request
    return self.send(request, auth=auth, follow_redirects=follow_redirects)
  File "/Users/nik/Library/Caches/pypoetry/virtualenvs/mdut-kQOfudX7-py3.10/lib/python3.10/site-packages/httpx/_client.py", line 889, in send
    response = self._send_handling_auth(
  File "/Users/nik/Library/Caches/pypoetry/virtualenvs/mdut-kQOfudX7-py3.10/lib/python3.10/site-packages/httpx/_client.py", line 917, in _send_handling_auth
    response = self._send_handling_redirects(
  File "/Users/nik/Library/Caches/pypoetry/virtualenvs/mdut-kQOfudX7-py3.10/lib/python3.10/site-packages/httpx/_client.py", line 954, in _send_handling_redirects
    response = self._send_single_request(request)
  File "/Users/nik/Library/Caches/pypoetry/virtualenvs/mdut-kQOfudX7-py3.10/lib/python3.10/site-packages/httpx/_client.py", line 990, in _send_single_request
    response = transport.handle_request(request)
  File "/Users/nik/Library/Caches/pypoetry/virtualenvs/mdut-kQOfudX7-py3.10/lib/python3.10/site-packages/httpx/_transports/default.py", line 186, in handle_request
    with map_httpcore_exceptions():
  File "/opt/homebrew/Cellar/[email protected]/3.10.1/Frameworks/Python.framework/Versions/3.10/lib/python3.10/contextlib.py", line 153, in __exit__
    self.gen.throw(typ, value, traceback)
  File "/Users/nik/Library/Caches/pypoetry/virtualenvs/mdut-kQOfudX7-py3.10/lib/python3.10/site-packages/httpx/_transports/default.py", line 77, in map_httpcore_exceptions
    raise mapped_exc(message) from exc
httpx.UnsupportedProtocol: Request URL has an unsupported protocol 'foo://'.

copy shortcut

as a user: i want to see a link and press a special keyboard shortcut to activate mdut and copy the link, then go to my .md and paste it in there with all the syntax

Add contributing deets

• CONTRIBUTING file
• README section

Handle httpx.UnsupportedProtocol

Only http and https are supported, so catching all other protocols and showing a user friendly error message would be great.

Add support for older Pythons

But keep the list to officially actively maintained ones, plz

Add license file

Add dev setup instructions

Add trove classifiers to pyproject.toml

Add Python 3.11 (dev) to CI

Add changelog

Whitespace in titles can create problems

URL: https://www.yamahamotorsports.com/sport-heritage/models/2018/xsr700
Example output:

$ mdut -s reference https://www.yamahamotorsports.com/sport-heritage/models/2018/xsr700
Copied to clipboard:
[TODO]: https://www.yamahamotorsports.com/sport-heritage/models/2018/xsr700 "
	
    2018 Yamaha XSR700 Sport Heritage Motorcycle - Model Home

"

Add CoC

Add Slack style tag format

Slack supports only inline but without the title.

Escape double quotes in title

Add support for TODO overriding

• text
• title