Current File : /home/inlingua/miniconda3/lib/python3.12/site-packages/mdurl-0.1.0.dist-info/METADATA

Metadata-Version: 2.1
Name: mdurl
Version: 0.1.0
Summary: Markdown URL utilities
Keywords: markdown,commonmark
Author-email: Taneli Hukkinen <hukkin@users.noreply.github.com>
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Project-URL: Homepage, https://github.com/hukkin/mdurl

# mdurl

[![Build Status](https://github.com/hukkin/mdurl/workflows/Tests/badge.svg?branch=master)](https://github.com/hukkin/mdurl/actions?query=workflow%3ATests+branch%3Amaster+event%3Apush)
[![codecov.io](https://codecov.io/gh/hukkin/mdurl/branch/master/graph/badge.svg)](https://codecov.io/gh/hukkin/mdurl)
[![PyPI version](https://img.shields.io/pypi/v/mdurl)](https://pypi.org/project/mdurl)

TODO: Update the README below this point. Explain that this is a Python port etc.

> URL utilities for [markdown-it](https://github.com/markdown-it/markdown-it) parser.

## API

### .encode(str \[, exclude, keepEncoded\]) -> String

Percent-encode a string, avoiding double encoding. Don't touch `/a-zA-Z0-9/` +
excluded chars + `/%[a-fA-F0-9]{2}/` (if not disabled). Broken surrorates are
replaced with `U+FFFD`.

Params:

- __str__ - input string.
- __exclude__ - optional, `;/?:@&=+$,-_.!~*'()#`. Additional chars to keep intact
  (except `/a-zA-Z0-9/`).
- __keepEncoded__ - optional, `true`. By default it skips already encoded sequences
  (`/%[a-fA-F0-9]{2}/`). If set to `false`, `%` will be encoded.

### encode.defaultChars, encode.componentChars

You can use these constants as second argument to `encode` function.

- `encode.defaultChars` is the same exclude set as in the standard `encodeURI()` function
- `encode.componentChars` is the same exclude set as in the `encodeURIComponent()` function

For example, `encode('something', encode.componentChars, true)` is roughly the equivalent of
the `encodeURIComponent()` function (except `encode()` doesn't throw).

### .decode(str \[, exclude\]) -> String

Decode percent-encoded string. Invalid percent-encoded sequences (e.g. `%2G`)
are left as is. Invalid UTF-8 characters are replaced with `U+FFFD`.

Params:

- __str__ - input string.
- __exclude__ - set of characters to leave encoded, optional, `;/?:@&=+$,#`.

### decode.defaultChars, decode.componentChars

You can use these constants as second argument to `decode` function.

- `decode.defaultChars` is the same exclude set as in the standard `decodeURI()` function
- `decode.componentChars` is the same exclude set as in the `decodeURIComponent()` function

For example, `decode('something', decode.defaultChars)` has the same behavior as
`decodeURI('something')` on a correctly encoded input.

### .parse(url, slashesDenoteHost) -> urlObs

Parse url string. Similar to node's [url.parse](http://nodejs.org/api/url.html#url_url_parse_urlstr_parsequerystring_slashesdenotehost), but without any
normalizations and query string parse.

- __url__ - input url (string)
- __slashesDenoteHost__ - if url starts with `//`, expect a hostname after it. Optional, `false`.

Result (hash):

- protocol
- slashes
- auth
- port
- hostname
- hash
- search
- pathname

Difference with node's `url`:

1. No leading slash in paths, e.g. in `url.parse('http://foo?bar')` pathname is
   `""` (empty string), not `"/"`
1. Backslashes are not replaced with slashes, so `http:\\example.org\` is
   treated like a relative path
1. Trailing colon is treated like a part of the path, i.e. in
   `http://example.org:foo` pathname is `:foo`
1. Nothing is URL-encoded in the resulting object, (in joyent/node some chars
   in auth and paths are encoded)
1. `url.parse()` does not have `parseQueryString` argument
1. Removed extraneous result properties: `host`, `path`, `query`, etc.,
   which can be constructed using other parts of the url.

### .format(urlObject)

Format an object previously obtained with `.parse()` function. Similar to node's
[url.format](http://nodejs.org/api/url.html#url_url_format_urlobj).

## License

[MIT](https://github.com/markdown-it/mdurl/blob/master/LICENSE)