Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update on pypi, README.org is not well supported #24

Open
nbehrnd opened this issue Mar 11, 2024 · 4 comments
Open

update on pypi, README.org is not well supported #24

nbehrnd opened this issue Mar 11, 2024 · 4 comments
Assignees

Comments

@nbehrnd
Copy link
Contributor

nbehrnd commented Mar 11, 2024

The project description of date2name (2024.3.10.1) on pypi doesn't resolve well.

The documentation page appears like a copy-paste of the README.org; however contrasting to for instance GitHub, pypi doesn't appear to support the orgmode syntax (yet). Maybe the a C-e h h to generate an .html were an approach more suitable here.

2024-03-11_date2name_pypi_01-800

2024-03-11_date2name_pypi_02-800

I got to know about the update because it is one of the pages update scanner checks this once a day for me.

@novoid novoid self-assigned this Mar 11, 2024
@novoid
Copy link
Owner

novoid commented Mar 11, 2024

Oh, thanks for the feedback.

I migrated the project over from setup.py to pyproject.toml/poetry. This side-effect was not intended.

If you see any other side-effect I may have overseen during that process, drop me a line!

I also checked in the pyproject.toml. It's my first one and the documentation isn't quite great I think. If you do have comments on that, I'm open. The previous pypi page looked much better: https://web.archive.org/web/20230927131720/https://pypi.org/project/date2name/ but I never privided any HTML for that.

@novoid
Copy link
Owner

novoid commented Mar 11, 2024

Btw, in Firefox contect menu, you can select "Take screenshot" -> "Full page" and get more than the current view point of a web page.

@novoid
Copy link
Owner

novoid commented Mar 11, 2024

Reading https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#readme implies that there can only me Markdown or ReStructuredText files.

I have no idea why the previous publish method produced a decent description. I'll need to play around and perhaps publish a few test versions for that.

@nbehrnd
Copy link
Contributor Author

nbehrnd commented Mar 12, 2024

The are so many markdown dialects (Kofler, cf. vide infra, p. 20) mentioned that there are more than 50 implementations. If it were GitHub md and the conversion would rely on pandoc (a demo page, and an installation-free test pad for text-only conversions), the command to the CLI would be

pandoc -s -i input.org -o output.md --to=gfm

Regarding the screen photos: I didn't record them with Firefox because the action of the later is instantaneous (i.e., no time to open a pull-down menu), and I didn't figure out yet how to optionally retain the mouse pointer as an indicator in the picture. The consistent shrink of the photos to a width of 800 px relies on photo2mail.sh by William Scotts (source), a moderator in turn calling convert of imagemagick and adds nicely e.g., to geeqie, or as a «Thunar action».

pandoc2.pdf

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

No branches or pull requests

2 participants