Skip to content

Conversation

maresb
Copy link
Contributor

@maresb maresb commented Sep 29, 2024

I noticed that the images on PyPI are broken, so this is basically just a copy-paste from pymc-labs/pymc-marketing#1051.

Use the hatch-fancy-pypi-readme plugin to fix broken links on PyPI.

To view differences, run

pipx run hatch-fancy-pypi-readme > pypi-readme.md
diff README.md pypi-readme.md

Result:

10c10
<   <img src="labelle.png" alt="logo" width="400"></img>
---
>   <img src="https://raw.githubusercontent.com/labelle-org/labelle/main/labelle.png" alt="logo" width="400"></img>
44c44
< Labelle is not affiliated with DYMO. Please see the [disclaimer](#disclaimers) below.
---
> Labelle is not affiliated with DYMO. Please see the [disclaimer](https://github.com/labelle-org/labelle/tree/main/#disclaimers) below.
50c50
< [adding the device id](src/labelle/lib/constants.py). Once you can print,
---
> [adding the device id](https://github.com/labelle-org/labelle/tree/main/src/labelle/lib/constants.py). Once you can print,
52c52
< by following [these instructions](doc/margin-calibration-howto.md).
---
> by following [these instructions](https://github.com/labelle-org/labelle/tree/main/doc/margin-calibration-howto.md).
142c142
< Default fonts are managed via [labelle.ini](labelle.ini).
---
> Default fonts are managed via [labelle.ini](https://github.com/labelle-org/labelle/tree/main/labelle.ini).
157,158c157,158
< See [here](vendoring/README.md) for more information and
< [LICENSE](src/labelle/_vendor/matplotlib/LICENSE) for the license.
---
> See [here](https://github.com/labelle-org/labelle/tree/main/vendoring/README.md) for more information and
> [LICENSE](https://github.com/labelle-org/labelle/tree/main/src/labelle/_vendor/matplotlib/LICENSE) for the license.
161c161
< [SIL Open Font License](src/labelle/resources/fonts/LICENSE).
---
> [SIL Open Font License](https://github.com/labelle-org/labelle/tree/main/src/labelle/resources/fonts/LICENSE).
233c233
< ![Batch mode example](doc/batch-example.png)
---
> ![Batch mode example](https://raw.githubusercontent.com/labelle-org/labelle/main/doc/batch-example.png)
269c269
< ![alt](doc/Labelle_example_1.png)
---
> ![alt](https://raw.githubusercontent.com/labelle-org/labelle/main/doc/Labelle_example_1.png)
273c273
< ![alt](doc/Labelle_example_2.png)
---
> ![alt](https://raw.githubusercontent.com/labelle-org/labelle/main/doc/Labelle_example_2.png)
277c277
< ![alt](doc/Labelle_example_3.png)
---
> ![alt](https://raw.githubusercontent.com/labelle-org/labelle/main/doc/Labelle_example_3.png)
295c295
< * This software is provided as-is, without any warranty. Please see [LICENSE](LICENSE)
---
> * This software is provided as-is, without any warranty. Please see [LICENSE](https://github.com/labelle-org/labelle/tree/main/LICENSE)
303a304
> 

Use the `hatch-fancy-pypi-readme` plugin to fix broken links on PyPI.

To view differences, run

```bash
pipx run hatch-fancy-pypi-readme > pypi-readme.md
diff README.md pypi-readme.md
```
@maresb maresb merged commit dbeb782 into labelle-org:main Sep 29, 2024
6 checks passed
@maresb maresb deleted the fix-pypi-readme branch September 29, 2024 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant