| Name | mdreftidy JSON |
| Version |
0.6.1
JSON |
| download |
| home_page | None |
| Summary | CLI to tidy ({renumber,move-to-bottom,sort,clean}) up {image,link} references for markdown. |
| upload_time | 2024-08-08 22:02:50 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Azriel Fasten. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
github
markdown
readme
documentation
preprocessor
documentation-tool
readme-md
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<!--
WARNING: This file is auto-generated by snipinator. Do not edit directly.
SOURCE: `.github/README.md.jinja2`.
-->
<!--
-->
# <div align="center">![mdreftidy][1]</div>
<div align="center">
</div>
<div align="center">
<!-- Icons from https://lucide.dev/icons/users -->
<!-- Icons from https://lucide.dev/icons/laptop-minimal -->
![**Audience:** Developers][2] ![**Platform:** Linux][3]
</div>
<p align="center">
<strong>
<a href="#-features">🎇Features</a>
•
<a href="#-installation">🏠Installation</a>
•
<a href="#-usage">🚜Usage</a>
•
<a href="#-command-line-options">💻CLI</a>
•
<a href="#-examples">💡Examples</a>
</strong>
</p>
<p align="center">
<strong>
<a href="#-requirements">✅Requirements</a>
•
<a href="#-docker-image">🐳Docker</a>
</strong>
</p>
<div align="center">
![Top language][4] [![GitHub License][5]][6] [![PyPI - Version][7]][8]
[![Python Version][9]][8]
**CLI to tidy ({renumber,move-to-bottom,sort,clean}) up {image,link} references
for markdown**
</div>
---
<div align="center">
| | Status | Stable | Unstable | |
| ----------------- | --------------------------- | ------------------------- | ------------------------- | ------------------ |
| **[Master][10]** | [![Build and Test][11]][12] | [![since tagged][13]][14] | | ![last commit][15] |
| **[Develop][16]** | [![Build and Test][17]][12] | [![since tagged][18]][19] | [![since tagged][20]][21] | ![last commit][22] |
</div>
<img alt="Demo" src="https://raw.githubusercontent.com/realazthat/mdreftidy/v0.6.1/.github/demo.gif" width="100%"/>
## ❔ What
What mdreftidy does:
Turn this ([./mdreftidy/examples/SIMPLE.md](https://github.com/realazthat/mdreftidy/blob/v0.6.1/mdreftidy/examples/SIMPLE.md)):
<!---->
```md
# Example markdown file
## Reference link: Out of order
[Reference link: Out of order 1][3], [Reference link: Out of order 2][2].
[2]: ./reference-link-out-of-order-2
## Footnotes
[6]: ./unused-reference-link-6
[3]: ./reference-link-out-of-order-3
[1]: ./unused-reference-link-1
```
<!---->
Into this ([./mdreftidy/examples/SIMPLE.tidied.md](https://github.com/realazthat/mdreftidy/blob/v0.6.1/mdreftidy/examples/SIMPLE.tidied.md)):
<!---->
```md
# Example markdown file
## Reference link: Out of order
[Reference link: Out of order 1][1], [Reference link: Out of order 2][2].
## Footnotes
[1]: ./reference-link-out-of-order-3
[2]: ./reference-link-out-of-order-2
```
<!---->
## 🎇 Features
- Renumbers references by order used.
- Optionally removes unused references.
- Optionally moves references to the bottom.
- Optionally sorts reference blocks.
## 🏠 Installation
```bash
# Install from pypi (https://pypi.org/project/mdreftidy/)
pip install mdreftidy
# Install from git (https://github.com/realazthat/mdreftidy)
pip install git+https://github.com/realazthat/mdreftidy.git@v0.6.1
```
## 🚜 Usage
Example README: ([./mdreftidy/examples/SIMPLE.md](https://github.com/realazthat/mdreftidy/blob/v0.6.1/mdreftidy/examples/SIMPLE.md)):
<!---->
```md
# Example markdown file
## Reference link: Out of order
[Reference link: Out of order 1][3], [Reference link: Out of order 2][2].
[2]: ./reference-link-out-of-order-2
## Footnotes
[6]: ./unused-reference-link-6
[3]: ./reference-link-out-of-order-3
[1]: ./unused-reference-link-1
```
<!---->
Generating the README:
<!---->
```bash
$ python -m mdreftidy.cli ./mdreftidy/examples/SIMPLE.md --move-to-bottom --remove-unused --sort-ref-blocks --renumber -o - 2>/dev/null
# Example markdown file
## Reference link: Out of order
[Reference link: Out of order 1][1], [Reference link: Out of order 2][2].
## Footnotes
[1]: ./reference-link-out-of-order-3
[2]: ./reference-link-out-of-order-2
```
<!---->
All together now:
<!---->
<img alt="Output of `bash ./snipinator/examples/simple_example.sh`" src="https://raw.githubusercontent.com/realazthat/mdreftidy/v0.6.1/.github/README.simple-output.generated.svg"/>
<!-- -->
## 💻 Command Line Options
<!---->
<img alt="Output of `python -m mdreftidy.cli --help`" src="https://raw.githubusercontent.com/realazthat/mdreftidy/v0.6.1/.github/README.help.generated.svg"/>
<!-- -->
## 💡 Examples
- Example:
- Original: [./mdreftidy/examples/SIMPLE.md](https://github.com/realazthat/mdreftidy/blob/v0.6.1/mdreftidy/examples/SIMPLE.md).
- Tidied: [./mdreftidy/examples/SIMPLE.tidied.md](https://github.com/realazthat/mdreftidy/blob/v0.6.1/mdreftidy/examples/SIMPLE.tidied.md).
- Generation script:
[./mdreftidy/examples/simple_example.sh](https://github.com/realazthat/mdreftidy/blob/v0.6.1/mdreftidy/examples/simple_example.sh).
<!-- TODO: Rebuild this for mdreftidy
- Projects using mdreftidy:
- [realazthat/snipinator](https://github.com/realazthat/snipinator), See
[snipinator/README.md.jinja2](https://github.com/realazthat/snipinator/blob/61cb88593baa099dc375cf5fd40679e4be673fc5/README.md.jinja2).
- [github.com/realazthat/changeguard](https://github.com/realazthat/changeguard),
See
[changeguard/README.md.jinja2](https://github.com/realazthat/changeguard/blob/87d5104b52e651bb9195a3d46dd7f050acbcb534/README.md.jinja2).
- [github.com/realazthat/comfy-catapult](https://github.com/realazthat/comfy-catapult),
See
[comfy-catapult/README.md.jinja2](https://github.com/realazthat/comfy-catapult/blob/ff353d48b25fa7b9c35fa11b31d5f2b3039c41c8/README.md.jinja2).
- [github.com/realazthat/comfylowda](https://github.com/realazthat/comfylowda),
See
[comfylowda/README.md.jinja2](https://github.com/realazthat/comfylowda/blob/e01a32c38107aa0b89ccea21c4678d193a186a78/README.md.jinja2).
- [github.com/realazthat/excalidraw-brute-export-cli](https://github.com/realazthat/excalidraw-brute-export-cli),
See
[excalidraw-brute-export-cli/README.md.jinja2](https://github.com/realazthat/excalidraw-brute-export-cli/blob/54a3b5b08b644e61c721ab565c576094234c5cc7/README.md.jinja2).
-->
## ✅ Requirements
- Linux-like environment
- Why: Uses pexpect.spawn().
- Python 3.8+
- Why: Some dev dependencies require Python 3.8+.
### Tested Platforms
- WSL2 Ubuntu 20.04, Python `3.8.0`.
- Ubuntu 20.04, Python `3.8.0, 3.9.0, 3.10.0, 3.11.0, 3.12.0`, tested in GitHub Actions
workflow ([build-and-test.yml](https://github.com/realazthat/mdreftidy/blob/v0.6.1/.github/workflows/build-and-test.yml)).
## 🐳 Docker Image
Docker images are published to [ghcr.io/realazthat/mdreftidy][23] at each
tag.
<!---->
```bash
# View the template file.
cat "mdreftidy/examples/SIMPLE.md"
# Use the published images at ghcr.io/realazthat/mdreftidy.
# /data in the docker image is the working directory, so paths are simpler.
docker run --rm --tty \
-v "${PWD}:/data" \
ghcr.io/realazthat/mdreftidy:v0.6.1 \
"mdreftidy/examples/SIMPLE.md" \
-o "mdreftidy/examples/SIMPLE.tidied.md" \
--move-to-bottom --remove-unused --sort-ref-blocks --renumber
# Now --check to verify:
docker run --rm --tty \
-v "${PWD}:/data" \
ghcr.io/realazthat/mdreftidy:v0.6.1 \
--check \
"mdreftidy/examples/SIMPLE.tidied.md" \
--move-to-bottom --remove-unused --sort-ref-blocks --renumber
# View the remotified file.
cat "mdreftidy/examples/SIMPLE.tidied.md"
```
<!---->
If you want to build the image yourself, you can use the Dockerfile in the
repository.
<!---->
```bash
docker build -t my-mdreftidy-image .
# View the template file.
cat "mdreftidy/examples/SIMPLE.md"
# /data in the docker image is the working directory, so paths are simpler.
docker run --rm --tty \
-v "${PWD}:/data" \
my-mdreftidy-image \
"mdreftidy/examples/SIMPLE.md" \
-o "mdreftidy/examples/SIMPLE.tidied.md" \
--move-to-bottom --remove-unused --sort-ref-blocks --renumber
# Now --check to verify:
docker run --rm --tty \
-v "${PWD}:/data" \
my-mdreftidy-image \
--check \
"mdreftidy/examples/SIMPLE.tidied.md" \
--move-to-bottom --remove-unused --sort-ref-blocks --renumber
# View the remotified file.
cat "mdreftidy/examples/SIMPLE.tidied.md"
```
<!---->
## 🤏 Versioning
We use SemVer for versioning. For the versions available, see the tags on this
repository.
## 🔑 License
This project is licensed under the MIT License - see the
[./LICENSE.md](https://github.com/realazthat/mdreftidy/blob/v0.6.1/LICENSE.md) file for details.
## 🙏 Thanks
Main libraries used in mdreftidy are:
- Markdown AST: [mistletoe](https://github.com/miyuchina/mistletoe).
- Colorful CLI help: [rich-argparse](https://github.com/hamdanal/rich-argparse).
## 🤝 Related Projects
Not complete, and not necessarily up to date. Make a PR
([contributions](#-contributions)) to insert/modify.
| Project | Stars | Last Update | Language | Platform | Similarity X Obviousness |
| ------------------- | ----- | ------------ | ---------------- | -------- | ------------------------ |
| [dce/mdrenum][24] | 2 | `2023/11/16` | JS | CLI | ⭐⭐⭐⭐⭐ |
| [unified-utils][25] | 4 | JS | [remark][26]/CLI | ⭐⭐⭐⭐⭐ | |
## 🫡 Contributions
### Development environment: Linux-like
- For running `pre.sh` (Linux-like environment).
- From [./.github/dependencies.yml](https://github.com/realazthat/mdreftidy/blob/v0.6.1/.github/dependencies.yml), which is used for
the GH Action to do a fresh install of everything:
```yaml
bash: scripts.
findutils: scripts.
grep: tests.
xxd: tests.
git: scripts, tests.
xxhash: scripts (changeguard).
rsync: out-of-directory test.
expect: for `unbuffer`, useful to grab and compare ansi color symbols.
jq: dependency for [yq](https://github.com/kislyuk/yq), which is used to generate
the README; the README generator needs to use `tomlq` (which is a part of `yq`)
to query `pyproject.toml`.
```
- Requires `pyenv`, or an exact matching version of python as in
[.python-version](https://github.com/realazthat/mdreftidy/blob/v0.6.1/.python-version) (which is currently
`3.8.0 `).
- `jq`, ([installation](https://jqlang.github.io/jq/)) required for
[yq](https://github.com/kislyuk/yq), which is itself required for our
[./README.md](https://github.com/realazthat/mdreftidy/blob/v0.6.1/README.md) generation, which uses `tomlq` (from the
[yq](https://github.com/kislyuk/yq) package) to include version strings from
[./pyproject.toml](https://github.com/realazthat/mdreftidy/blob/v0.6.1/pyproject.toml).
- act (to run the GH Action locally):
- Requires nodejs.
- Requires Go.
- docker.
- Generate animation:
- docker
- docker (for building the docker image).
### Commit Process
1. (Optionally) Fork the `develop` branch.
2. Stage your files: `git add path/to/file.py`.
3. `bash ./scripts/pre.sh`, this will format, lint, and test the code.
4. `git status` check if anything changed (generated
[./README.md](https://github.com/realazthat/mdreftidy/blob/v0.6.1/README.md) for example), if so, `git add` the
changes, and go back to the previous step.
5. `git commit -m "..."`.
6. Make a PR to `develop` (or push to develop if you have the rights).
## 🔄🚀 Release Process
These instructions are for maintainers of the project.
1. In the `develop` branch, run `bash ./scripts/pre.sh` to ensure
everything is in order.
2. In the `develop` branch, bump the version in
[./pyproject.toml](https://github.com/realazthat/mdreftidy/blob/v0.6.1/pyproject.toml), following semantic versioning
principles. Also modify the `last_release` and `last_stable_release` in the
`[tool.mdreftidy-project-metadata]` table as appropriate. Run
`bash ./scripts/pre.sh` to ensure everything is in order.
3. In the `develop` branch, commit these changes with a message like
`"Prepare release X.Y.Z"`. (See the contributions section
[above](#commit-process)).
4. Merge the `develop` branch into the `master` branch:
`git checkout master && git merge develop --no-ff`.
5. `master` branch: Tag the release: Create a git tag for the release with
`git tag -a vX.Y.Z -m "Version X.Y.Z"`.
6. Publish to PyPI: Publish the release to PyPI with
`bash ./scripts/deploy-to-pypi.sh`.
7. Push to GitHub: Push the commit and tags to GitHub with
`git push && git push --tags`.
8. The `--no-ff` option adds a commit to the master branch for the merge, so
refork the develop branch from the master branch:
`git checkout develop && git merge master`.
9. Push the develop branch to GitHub: `git push origin develop`.
<!-- Logo from https://lucide.dev/icons/users -->
<!-- Logo from https://lucide.dev/icons/laptop-minimal -->
[1]: https://raw.githubusercontent.com/realazthat/mdreftidy/v0.6.1/.github/logo-exported.svg
[2]: https://img.shields.io/badge/Audience-Developers-0A1E1E?style=plastic&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJsdWNpZGUgbHVjaWRlLXVzZXJzIj48cGF0aCBkPSJNMTYgMjF2LTJhNCA0IDAgMCAwLTQtNEg2YTQgNCAwIDAgMC00IDR2MiIvPjxjaXJjbGUgY3g9IjkiIGN5PSI3IiByPSI0Ii8+PHBhdGggZD0iTTIyIDIxdi0yYTQgNCAwIDAgMC0zLTMuODciLz48cGF0aCBkPSJNMTYgMy4xM2E0IDQgMCAwIDEgMCA3Ljc1Ii8+PC9zdmc+
[3]: https://img.shields.io/badge/Platform-Linux-0A1E1E?style=plastic&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJsdWNpZGUgbHVjaWRlLWxhcHRvcC1taW5pbWFsIj48cmVjdCB3aWR0aD0iMTgiIGhlaWdodD0iMTIiIHg9IjMiIHk9IjQiIHJ4PSIyIiByeT0iMiIvPjxsaW5lIHgxPSIyIiB4Mj0iMjIiIHkxPSIyMCIgeTI9IjIwIi8+PC9zdmc+
[4]: https://img.shields.io/github/languages/top/realazthat/mdreftidy.svg?&cacheSeconds=28800&style=plastic&color=0A1E1E
[5]: https://img.shields.io/github/license/realazthat/mdreftidy?style=plastic&color=0A1E1E
[6]: https://github.com/realazthat/mdreftidy/blob/v0.6.1/LICENSE.md
[7]: https://img.shields.io/pypi/v/mdreftidy?style=plastic&color=0A1E1E
[8]: https://pypi.org/project/mdreftidy/
[9]: https://img.shields.io/pypi/pyversions/mdreftidy?style=plastic&color=0A1E1E
[10]: https://github.com/realazthat/mdreftidy/tree/master
[11]: https://img.shields.io/github/actions/workflow/status/realazthat/mdreftidy/build-and-test.yml?branch=master&style=plastic
[12]: https://github.com/realazthat/mdreftidy/actions/workflows/build-and-test.yml
[13]: https://img.shields.io/github/commits-since/realazthat/mdreftidy/v0.6.1/master?style=plastic
[14]: https://github.com/realazthat/mdreftidy/compare/v0.6.1...master
[15]: https://img.shields.io/github/last-commit/realazthat/mdreftidy/master?style=plastic
[16]: https://github.com/realazthat/mdreftidy/tree/develop
[17]: https://img.shields.io/github/actions/workflow/status/realazthat/mdreftidy/build-and-test.yml?branch=develop&style=plastic
[18]: https://img.shields.io/github/commits-since/realazthat/mdreftidy/v0.6.1/develop?style=plastic
[19]: https://github.com/realazthat/mdreftidy/compare/v0.6.1...develop
[20]: https://img.shields.io/github/commits-since/realazthat/mdreftidy/v0.6.1/develop?style=plastic
[21]: https://github.com/realazthat/mdreftidy/compare/v0.6.1...develop
[22]: https://img.shields.io/github/last-commit/realazthat/mdreftidy/develop?style=plastic
[23]: https://ghcr.io/realazthat/mdreftidy
[24]: https://github.com/dce/mdrenum "Very similar, not as featureful (no move-to-bottom)"
[25]: https://github.com/Xunnamius/unified-utils "sort-definitions, renumber-references, remove-unused-definitions"
[26]: https://github.com/remarkjs/remark
Raw data
{
"_id": null,
"home_page": null,
"name": "mdreftidy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "github, markdown, readme, documentation, preprocessor, documentation-tool, readme-md",
"author": null,
"author_email": "AYF <realazthat@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/9c/c3/315241184d582d6fa8b9cbe5c971a532d7dac571ff69911e3f00a4a31a56/mdreftidy-0.6.1.tar.gz",
"platform": null,
"description": "<!--\n\nWARNING: This file is auto-generated by snipinator. Do not edit directly.\nSOURCE: `.github/README.md.jinja2`.\n\n-->\n<!--\n\n\n\n\n\n\n\n-->\n\n# <div align=\"center\">![mdreftidy][1]</div>\n\n<div align=\"center\">\n\n</div>\n\n<div align=\"center\">\n\n<!-- Icons from https://lucide.dev/icons/users -->\n<!-- Icons from https://lucide.dev/icons/laptop-minimal -->\n\n![**Audience:** Developers][2] ![**Platform:** Linux][3]\n\n</div>\n\n<p align=\"center\">\n <strong>\n <a href=\"#-features\">\ud83c\udf87Features</a>\n • \n <a href=\"#-installation\">\ud83c\udfe0Installation</a>\n • \n <a href=\"#-usage\">\ud83d\ude9cUsage</a>\n • \n <a href=\"#-command-line-options\">\ud83d\udcbbCLI</a>\n • \n <a href=\"#-examples\">\ud83d\udca1Examples</a>\n </strong>\n</p>\n\n<p align=\"center\">\n <strong>\n <a href=\"#-requirements\">\u2705Requirements</a>\n • \n <a href=\"#-docker-image\">\ud83d\udc33Docker</a>\n </strong>\n</p>\n\n<div align=\"center\">\n\n![Top language][4] [![GitHub License][5]][6] [![PyPI - Version][7]][8]\n[![Python Version][9]][8]\n\n**CLI to tidy ({renumber,move-to-bottom,sort,clean}) up {image,link} references\nfor markdown**\n\n</div>\n\n---\n\n<div align=\"center\">\n\n| | Status | Stable | Unstable | |\n| ----------------- | --------------------------- | ------------------------- | ------------------------- | ------------------ |\n| **[Master][10]** | [![Build and Test][11]][12] | [![since tagged][13]][14] | | ![last commit][15] |\n| **[Develop][16]** | [![Build and Test][17]][12] | [![since tagged][18]][19] | [![since tagged][20]][21] | ![last commit][22] |\n\n</div>\n\n<img alt=\"Demo\" src=\"https://raw.githubusercontent.com/realazthat/mdreftidy/v0.6.1/.github/demo.gif\" width=\"100%\"/>\n\n## \u2754 What\n\nWhat mdreftidy does:\n\nTurn this ([./mdreftidy/examples/SIMPLE.md](https://github.com/realazthat/mdreftidy/blob/v0.6.1/mdreftidy/examples/SIMPLE.md)):\n\n<!---->\n```md\n# Example markdown file\n\n## Reference link: Out of order\n\n[Reference link: Out of order 1][3], [Reference link: Out of order 2][2].\n\n[2]: ./reference-link-out-of-order-2\n\n## Footnotes\n\n[6]: ./unused-reference-link-6\n[3]: ./reference-link-out-of-order-3\n[1]: ./unused-reference-link-1\n\n```\n<!---->\n\nInto this ([./mdreftidy/examples/SIMPLE.tidied.md](https://github.com/realazthat/mdreftidy/blob/v0.6.1/mdreftidy/examples/SIMPLE.tidied.md)):\n\n<!---->\n```md\n# Example markdown file\n\n## Reference link: Out of order\n\n[Reference link: Out of order 1][1], [Reference link: Out of order 2][2].\n\n\n## Footnotes\n\n[1]: ./reference-link-out-of-order-3\n[2]: ./reference-link-out-of-order-2\n\n```\n<!---->\n\n## \ud83c\udf87 Features\n\n- Renumbers references by order used.\n- Optionally removes unused references.\n- Optionally moves references to the bottom.\n- Optionally sorts reference blocks.\n\n## \ud83c\udfe0 Installation\n\n```bash\n# Install from pypi (https://pypi.org/project/mdreftidy/)\npip install mdreftidy\n\n# Install from git (https://github.com/realazthat/mdreftidy)\npip install git+https://github.com/realazthat/mdreftidy.git@v0.6.1\n```\n\n## \ud83d\ude9c Usage\n\nExample README: ([./mdreftidy/examples/SIMPLE.md](https://github.com/realazthat/mdreftidy/blob/v0.6.1/mdreftidy/examples/SIMPLE.md)):\n\n<!---->\n```md\n# Example markdown file\n\n## Reference link: Out of order\n\n[Reference link: Out of order 1][3], [Reference link: Out of order 2][2].\n\n[2]: ./reference-link-out-of-order-2\n\n## Footnotes\n\n[6]: ./unused-reference-link-6\n[3]: ./reference-link-out-of-order-3\n[1]: ./unused-reference-link-1\n\n```\n<!---->\n\nGenerating the README:\n\n<!---->\n```bash\n$ python -m mdreftidy.cli ./mdreftidy/examples/SIMPLE.md --move-to-bottom --remove-unused --sort-ref-blocks --renumber -o - 2>/dev/null\n# Example markdown file\n\n## Reference link: Out of order\n\n[Reference link: Out of order 1][1], [Reference link: Out of order 2][2].\n\n\n## Footnotes\n\n[1]: ./reference-link-out-of-order-3\n[2]: ./reference-link-out-of-order-2\n\n```\n<!---->\n\nAll together now:\n\n<!---->\n<img alt=\"Output of `bash ./snipinator/examples/simple_example.sh`\" src=\"https://raw.githubusercontent.com/realazthat/mdreftidy/v0.6.1/.github/README.simple-output.generated.svg\"/>\n<!-- -->\n\n## \ud83d\udcbb Command Line Options\n\n<!---->\n<img alt=\"Output of `python -m mdreftidy.cli --help`\" src=\"https://raw.githubusercontent.com/realazthat/mdreftidy/v0.6.1/.github/README.help.generated.svg\"/>\n<!-- -->\n\n## \ud83d\udca1 Examples\n\n- Example:\n - Original: [./mdreftidy/examples/SIMPLE.md](https://github.com/realazthat/mdreftidy/blob/v0.6.1/mdreftidy/examples/SIMPLE.md).\n - Tidied: [./mdreftidy/examples/SIMPLE.tidied.md](https://github.com/realazthat/mdreftidy/blob/v0.6.1/mdreftidy/examples/SIMPLE.tidied.md).\n - Generation script:\n [./mdreftidy/examples/simple_example.sh](https://github.com/realazthat/mdreftidy/blob/v0.6.1/mdreftidy/examples/simple_example.sh).\n\n<!-- TODO: Rebuild this for mdreftidy\n- Projects using mdreftidy:\n - [realazthat/snipinator](https://github.com/realazthat/snipinator), See\n [snipinator/README.md.jinja2](https://github.com/realazthat/snipinator/blob/61cb88593baa099dc375cf5fd40679e4be673fc5/README.md.jinja2).\n - [github.com/realazthat/changeguard](https://github.com/realazthat/changeguard),\n See\n [changeguard/README.md.jinja2](https://github.com/realazthat/changeguard/blob/87d5104b52e651bb9195a3d46dd7f050acbcb534/README.md.jinja2).\n - [github.com/realazthat/comfy-catapult](https://github.com/realazthat/comfy-catapult),\n See\n [comfy-catapult/README.md.jinja2](https://github.com/realazthat/comfy-catapult/blob/ff353d48b25fa7b9c35fa11b31d5f2b3039c41c8/README.md.jinja2).\n - [github.com/realazthat/comfylowda](https://github.com/realazthat/comfylowda),\n See\n [comfylowda/README.md.jinja2](https://github.com/realazthat/comfylowda/blob/e01a32c38107aa0b89ccea21c4678d193a186a78/README.md.jinja2).\n - [github.com/realazthat/excalidraw-brute-export-cli](https://github.com/realazthat/excalidraw-brute-export-cli),\n See\n [excalidraw-brute-export-cli/README.md.jinja2](https://github.com/realazthat/excalidraw-brute-export-cli/blob/54a3b5b08b644e61c721ab565c576094234c5cc7/README.md.jinja2).\n-->\n\n## \u2705 Requirements\n\n- Linux-like environment\n - Why: Uses pexpect.spawn().\n- Python 3.8+\n - Why: Some dev dependencies require Python 3.8+.\n\n### Tested Platforms\n\n- WSL2 Ubuntu 20.04, Python `3.8.0`.\n- Ubuntu 20.04, Python `3.8.0, 3.9.0, 3.10.0, 3.11.0, 3.12.0`, tested in GitHub Actions\n workflow ([build-and-test.yml](https://github.com/realazthat/mdreftidy/blob/v0.6.1/.github/workflows/build-and-test.yml)).\n\n## \ud83d\udc33 Docker Image\n\nDocker images are published to [ghcr.io/realazthat/mdreftidy][23] at each\ntag.\n\n<!---->\n```bash\n\n# View the template file.\ncat \"mdreftidy/examples/SIMPLE.md\"\n\n# Use the published images at ghcr.io/realazthat/mdreftidy.\n# /data in the docker image is the working directory, so paths are simpler.\ndocker run --rm --tty \\\n -v \"${PWD}:/data\" \\\n ghcr.io/realazthat/mdreftidy:v0.6.1 \\\n \"mdreftidy/examples/SIMPLE.md\" \\\n -o \"mdreftidy/examples/SIMPLE.tidied.md\" \\\n --move-to-bottom --remove-unused --sort-ref-blocks --renumber\n\n# Now --check to verify:\ndocker run --rm --tty \\\n -v \"${PWD}:/data\" \\\n ghcr.io/realazthat/mdreftidy:v0.6.1 \\\n --check \\\n \"mdreftidy/examples/SIMPLE.tidied.md\" \\\n --move-to-bottom --remove-unused --sort-ref-blocks --renumber\n\n# View the remotified file.\ncat \"mdreftidy/examples/SIMPLE.tidied.md\"\n\n```\n<!---->\n\nIf you want to build the image yourself, you can use the Dockerfile in the\nrepository.\n\n<!---->\n```bash\n\ndocker build -t my-mdreftidy-image .\n\n# View the template file.\ncat \"mdreftidy/examples/SIMPLE.md\"\n\n# /data in the docker image is the working directory, so paths are simpler.\ndocker run --rm --tty \\\n -v \"${PWD}:/data\" \\\n my-mdreftidy-image \\\n \"mdreftidy/examples/SIMPLE.md\" \\\n -o \"mdreftidy/examples/SIMPLE.tidied.md\" \\\n --move-to-bottom --remove-unused --sort-ref-blocks --renumber\n\n# Now --check to verify:\ndocker run --rm --tty \\\n -v \"${PWD}:/data\" \\\n my-mdreftidy-image \\\n --check \\\n \"mdreftidy/examples/SIMPLE.tidied.md\" \\\n --move-to-bottom --remove-unused --sort-ref-blocks --renumber\n\n# View the remotified file.\ncat \"mdreftidy/examples/SIMPLE.tidied.md\"\n\n\n```\n<!---->\n\n## \ud83e\udd0f Versioning\n\nWe use SemVer for versioning. For the versions available, see the tags on this\nrepository.\n\n## \ud83d\udd11 License\n\nThis project is licensed under the MIT License - see the\n[./LICENSE.md](https://github.com/realazthat/mdreftidy/blob/v0.6.1/LICENSE.md) file for details.\n\n## \ud83d\ude4f Thanks\n\nMain libraries used in mdreftidy are:\n\n- Markdown AST: [mistletoe](https://github.com/miyuchina/mistletoe).\n- Colorful CLI help: [rich-argparse](https://github.com/hamdanal/rich-argparse).\n\n## \ud83e\udd1d Related Projects\n\nNot complete, and not necessarily up to date. Make a PR\n([contributions](#-contributions)) to insert/modify.\n\n| Project | Stars | Last Update | Language | Platform | Similarity X Obviousness |\n| ------------------- | ----- | ------------ | ---------------- | -------- | ------------------------ |\n| [dce/mdrenum][24] | 2 | `2023/11/16` | JS | CLI | \u2b50\u2b50\u2b50\u2b50\u2b50 |\n| [unified-utils][25] | 4 | JS | [remark][26]/CLI | \u2b50\u2b50\u2b50\u2b50\u2b50 | |\n\n## \ud83e\udee1 Contributions\n\n### Development environment: Linux-like\n\n- For running `pre.sh` (Linux-like environment).\n\n - From [./.github/dependencies.yml](https://github.com/realazthat/mdreftidy/blob/v0.6.1/.github/dependencies.yml), which is used for\n the GH Action to do a fresh install of everything:\n\n ```yaml\n bash: scripts.\n findutils: scripts.\n grep: tests.\n xxd: tests.\n git: scripts, tests.\n xxhash: scripts (changeguard).\n rsync: out-of-directory test.\n expect: for `unbuffer`, useful to grab and compare ansi color symbols.\n jq: dependency for [yq](https://github.com/kislyuk/yq), which is used to generate\n the README; the README generator needs to use `tomlq` (which is a part of `yq`)\n to query `pyproject.toml`.\n\n ```\n\n - Requires `pyenv`, or an exact matching version of python as in\n [.python-version](https://github.com/realazthat/mdreftidy/blob/v0.6.1/.python-version) (which is currently\n `3.8.0 `).\n - `jq`, ([installation](https://jqlang.github.io/jq/)) required for\n [yq](https://github.com/kislyuk/yq), which is itself required for our\n [./README.md](https://github.com/realazthat/mdreftidy/blob/v0.6.1/README.md) generation, which uses `tomlq` (from the\n [yq](https://github.com/kislyuk/yq) package) to include version strings from\n [./pyproject.toml](https://github.com/realazthat/mdreftidy/blob/v0.6.1/pyproject.toml).\n - act (to run the GH Action locally):\n - Requires nodejs.\n - Requires Go.\n - docker.\n - Generate animation:\n - docker\n - docker (for building the docker image).\n\n### Commit Process\n\n1. (Optionally) Fork the `develop` branch.\n2. Stage your files: `git add path/to/file.py`.\n3. `bash ./scripts/pre.sh`, this will format, lint, and test the code.\n4. `git status` check if anything changed (generated\n [./README.md](https://github.com/realazthat/mdreftidy/blob/v0.6.1/README.md) for example), if so, `git add` the\n changes, and go back to the previous step.\n5. `git commit -m \"...\"`.\n6. Make a PR to `develop` (or push to develop if you have the rights).\n\n## \ud83d\udd04\ud83d\ude80 Release Process\n\nThese instructions are for maintainers of the project.\n\n1. In the `develop` branch, run `bash ./scripts/pre.sh` to ensure\n everything is in order.\n2. In the `develop` branch, bump the version in\n [./pyproject.toml](https://github.com/realazthat/mdreftidy/blob/v0.6.1/pyproject.toml), following semantic versioning\n principles. Also modify the `last_release` and `last_stable_release` in the\n `[tool.mdreftidy-project-metadata]` table as appropriate. Run\n `bash ./scripts/pre.sh` to ensure everything is in order.\n3. In the `develop` branch, commit these changes with a message like\n `\"Prepare release X.Y.Z\"`. (See the contributions section\n [above](#commit-process)).\n4. Merge the `develop` branch into the `master` branch:\n `git checkout master && git merge develop --no-ff`.\n5. `master` branch: Tag the release: Create a git tag for the release with\n `git tag -a vX.Y.Z -m \"Version X.Y.Z\"`.\n6. Publish to PyPI: Publish the release to PyPI with\n `bash ./scripts/deploy-to-pypi.sh`.\n7. Push to GitHub: Push the commit and tags to GitHub with\n `git push && git push --tags`.\n8. The `--no-ff` option adds a commit to the master branch for the merge, so\n refork the develop branch from the master branch:\n `git checkout develop && git merge master`.\n9. Push the develop branch to GitHub: `git push origin develop`.\n\n<!-- Logo from https://lucide.dev/icons/users -->\n\n<!-- Logo from https://lucide.dev/icons/laptop-minimal -->\n\n[1]: https://raw.githubusercontent.com/realazthat/mdreftidy/v0.6.1/.github/logo-exported.svg\n[2]: https://img.shields.io/badge/Audience-Developers-0A1E1E?style=plastic&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJsdWNpZGUgbHVjaWRlLXVzZXJzIj48cGF0aCBkPSJNMTYgMjF2LTJhNCA0IDAgMCAwLTQtNEg2YTQgNCAwIDAgMC00IDR2MiIvPjxjaXJjbGUgY3g9IjkiIGN5PSI3IiByPSI0Ii8+PHBhdGggZD0iTTIyIDIxdi0yYTQgNCAwIDAgMC0zLTMuODciLz48cGF0aCBkPSJNMTYgMy4xM2E0IDQgMCAwIDEgMCA3Ljc1Ii8+PC9zdmc+\n[3]: https://img.shields.io/badge/Platform-Linux-0A1E1E?style=plastic&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJsdWNpZGUgbHVjaWRlLWxhcHRvcC1taW5pbWFsIj48cmVjdCB3aWR0aD0iMTgiIGhlaWdodD0iMTIiIHg9IjMiIHk9IjQiIHJ4PSIyIiByeT0iMiIvPjxsaW5lIHgxPSIyIiB4Mj0iMjIiIHkxPSIyMCIgeTI9IjIwIi8+PC9zdmc+\n[4]: https://img.shields.io/github/languages/top/realazthat/mdreftidy.svg?&cacheSeconds=28800&style=plastic&color=0A1E1E\n[5]: https://img.shields.io/github/license/realazthat/mdreftidy?style=plastic&color=0A1E1E\n[6]: https://github.com/realazthat/mdreftidy/blob/v0.6.1/LICENSE.md\n[7]: https://img.shields.io/pypi/v/mdreftidy?style=plastic&color=0A1E1E\n[8]: https://pypi.org/project/mdreftidy/\n[9]: https://img.shields.io/pypi/pyversions/mdreftidy?style=plastic&color=0A1E1E\n[10]: https://github.com/realazthat/mdreftidy/tree/master\n[11]: https://img.shields.io/github/actions/workflow/status/realazthat/mdreftidy/build-and-test.yml?branch=master&style=plastic\n[12]: https://github.com/realazthat/mdreftidy/actions/workflows/build-and-test.yml\n[13]: https://img.shields.io/github/commits-since/realazthat/mdreftidy/v0.6.1/master?style=plastic\n[14]: https://github.com/realazthat/mdreftidy/compare/v0.6.1...master\n[15]: https://img.shields.io/github/last-commit/realazthat/mdreftidy/master?style=plastic\n[16]: https://github.com/realazthat/mdreftidy/tree/develop\n[17]: https://img.shields.io/github/actions/workflow/status/realazthat/mdreftidy/build-and-test.yml?branch=develop&style=plastic\n[18]: https://img.shields.io/github/commits-since/realazthat/mdreftidy/v0.6.1/develop?style=plastic\n[19]: https://github.com/realazthat/mdreftidy/compare/v0.6.1...develop\n[20]: https://img.shields.io/github/commits-since/realazthat/mdreftidy/v0.6.1/develop?style=plastic\n[21]: https://github.com/realazthat/mdreftidy/compare/v0.6.1...develop\n[22]: https://img.shields.io/github/last-commit/realazthat/mdreftidy/develop?style=plastic\n[23]: https://ghcr.io/realazthat/mdreftidy\n[24]: https://github.com/dce/mdrenum \"Very similar, not as featureful (no move-to-bottom)\"\n[25]: https://github.com/Xunnamius/unified-utils \"sort-definitions, renumber-references, remove-unused-definitions\"\n[26]: https://github.com/remarkjs/remark\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Azriel Fasten. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "CLI to tidy ({renumber,move-to-bottom,sort,clean}) up {image,link} references for markdown.",
"version": "0.6.1",
"project_urls": {
"Documentation": "https://github.com/realazthat/mdreftidy",
"Homepage": "https://github.com/realazthat/mdreftidy",
"Repository": "https://github.com/realazthat/mdreftidy"
},
"split_keywords": [
"github",
" markdown",
" readme",
" documentation",
" preprocessor",
" documentation-tool",
" readme-md"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6244fbc5173cf9beb8a31f1d686cecc93cf31a3cb9f83901ddb5786109c4998d",
"md5": "149d88bd5fd26abe2febd8836e27b99c",
"sha256": "48ad6c02960254da0bbe093d252af38fd5324247361b4edcc7c445207acfb09c"
},
"downloads": -1,
"filename": "mdreftidy-0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "149d88bd5fd26abe2febd8836e27b99c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 14490,
"upload_time": "2024-08-08T22:02:48",
"upload_time_iso_8601": "2024-08-08T22:02:48.369193Z",
"url": "https://files.pythonhosted.org/packages/62/44/fbc5173cf9beb8a31f1d686cecc93cf31a3cb9f83901ddb5786109c4998d/mdreftidy-0.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9cc3315241184d582d6fa8b9cbe5c971a532d7dac571ff69911e3f00a4a31a56",
"md5": "8c44f241f64f4accfc0aa7882ca695b8",
"sha256": "a9cec357b55d00fc88ff0518bbe5ee1955d212441524f52a5efe92bbfb68be64"
},
"downloads": -1,
"filename": "mdreftidy-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "8c44f241f64f4accfc0aa7882ca695b8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 21169,
"upload_time": "2024-08-08T22:02:50",
"upload_time_iso_8601": "2024-08-08T22:02:50.094074Z",
"url": "https://files.pythonhosted.org/packages/9c/c3/315241184d582d6fa8b9cbe5c971a532d7dac571ff69911e3f00a4a31a56/mdreftidy-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-08 22:02:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "realazthat",
"github_project": "mdreftidy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mdreftidy"
}
