Skip to content

feat: CLI entrypoint#47

Merged
kesara merged 1 commit intoietf-tools:mainfrom
Julien00859:entrypoint
Aug 12, 2025
Merged

feat: CLI entrypoint#47
kesara merged 1 commit intoietf-tools:mainfrom
Julien00859:entrypoint

Conversation

@Julien00859
Copy link
Contributor

@Julien00859 Julien00859 commented Aug 7, 2025

This adds a script entrypoint to run the markup() function on a bunch of files. This makes it possible to use rfc2html with pipx/uvx as follow:

$ wget https://www.rfc-editor.org/rfc/rfc8446.txt
$ pipx rfc2html -v rfc8446.txt
rfc8446.txt.html

I've tested it manually on both py3.7 (the oldest python that compiles on my machine) and py3.10 (my system python). I believe the code works with py2 as well but I can't test it. Tell me if you think it deserves a unittest.

@Julien00859 Julien00859 changed the title imp: CLI entrypoint imp: add a CLI entrypoint Aug 7, 2025
@Julien00859
Copy link
Contributor Author

Semantic PR — PR has only one non-merge commit and it's not semantic; add another commit before squashing

I don't know what I need to do in this regard.

@rjsparks
Copy link
Member

rjsparks commented Aug 7, 2025

I don't know what I need to do in this regard.

Don't worry about it for now. If you add another commit to the PR, follow what's at https://www.conventionalcommits.org/en/v1.0.0/. (imp: isn't recognized - feat: would be).

If you don't add another commit, we can deal with it at squash time.

@rjsparks rjsparks requested a review from kesara August 7, 2025 15:06
Copy link
Member

@kesara kesara left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR.
Can you update the README.md usage section on how to use the this a CLI tool?

@Julien00859 Julien00859 force-pushed the entrypoint branch 3 times, most recently from 8e42637 to 28aba39 Compare August 8, 2025 13:16
This adds a script entrypoint to run the markup() function on a bunch of
files. This makes it possible to use rfc2html with pipx/uvx as follow:

	$ wget https://www.rfc-editor.org/rfc/rfc8446.txt
	$ pipx rfc2html -v rfc8446.txt
	rfc8446.txt.html
@kesara kesara changed the title imp: add a CLI entrypoint feat: CLI entrypoint Aug 10, 2025
@kesara kesara merged commit 7bcf072 into ietf-tools:main Aug 12, 2025
62 of 65 checks passed
@Julien00859 Julien00859 deleted the entrypoint branch August 26, 2025 09:31
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.

3 participants