Mention Python at the top of the README?

[gitressa]

Thanks for making this project, it looks like it's a great candidate for Python and HTMX integration. However, beginners looking for Python and HTMX may not find this project if they make a search in Github, or just generally in search engines ...

Problem

It's understood by the insiders that FastAPI is for Python, but not by the Github search engine, or new users looking HTMX integration in Python via search engines generally. See for example this search, which does not find this project:

https://github.com/search?q=python%20htmx&type=repositories

This probably happens because Python is not mentioned in the README. In fact, the only place Pythons is mentioned on the project page https://github.com/volfpeter/fasthx is in the right hand side under "Languages" :)

Languages

• Python 99.7% - Jinja 0.3%

Solution

Maybe mention that this is for Python?

FastHX - Python, FastAPI, and HTMX

Python FastAPI server-side rendering with built-in HTMX support.

While this may seem redundant to the in-crowd, it will make sure that also new users looking for Python HTMX solutions will find this project, and increase the adoption rate.

[volfpeter]

Thanks, this is actually a great contribution! I never use github search, it's quite bad, so I never noticed this problem.

I just noticed that the repo description and tags also don't mention Python or HTMX 🙂 Tags are fixed now. I'll see if/how that affects search, I guess it'll take some time. I'll then adjust the project description and the readme if needed.

FYI: now I recommend using holm, which is also my lib. It's a higher level abstraction built on top of fasthx and FastAPI. Think JSX and NextJS in Python, designed to work great with HTMX.

[gitressa]

Thanks for a fast answer, it's impossible for a single maintainer to cover all aspects :)

It's now in the Github search results as # 6. So Github is fixed.

Though, you could still consider including the word "Python" in the README, like I suggested. Because whereas it may be fixed for Github, all other search engines does not treat a code tag as anything significant. Including the string "Python" right next to "HTMX" and "FastAPI" will help in the search engines, broadly.

Improved suggestion - maybe too much? But probably by far the most efficient in terms of getting found in search engines, since the important words are in a H1 tag.

Also, as a casual visitor, it is now very clear what this page is about:

FastHX - Python, FastAPI, and HTMX

Python FastAPI server-side rendering with built-in HTMX support.

Also, perhaps ask to get this project included under https://htmx.org/server-examples/#fastapi? It ought to be placed at the top then, just based on the number of stars and breadth of the project (compared to a ToDo and Reminder example).

And thanks for the tip about holm! It could also get included https://htmx.org/server-examples/#fastapi as well, if you ask Carson?

[volfpeter]

That was quick! Thanks, when I checked, it still didn't show up. I think that issue with github, but you're of course right on SEO.

Updating the title may be a good idea. Let me think about it a bit. I noticed you submitted a PR, I had no time to check it just yet, but I will as soon as I can.

Also, perhaps ask to get this project included under https://htmx.org/server-examples/#fastapi? It ought to be placed at the top then, just based on the number of stars and breadth of the project (compared to a ToDo and Reminder example).

I created this PR months ago to add fasthx and holm, but got no response so far from the maintainers, and I don't want to push too much, they are busy with HTMX v4: bigskysoftware/htmx#3482 Could you maybe drop a comment in the PR? 🙂

[gitressa]

It's nice to get these basic search engine tasks fixed, it will pay off in the future. And thanks for fast and positive responses, I really appreciate it!

I left a comment and review in the Merge Request, so fingers crossed it will happen at some point? Have a nice day :)

[volfpeter]

Thanks again! I hope you'll be enjoying these tools.

[volfpeter]

Thanks again, this issue and your PR were really great contributions! And sorry again that I kept your PR waiting for so long!

If you happen to use holm or htmy and you see similar (or totally different) issues there, please ping me or feel free to submit similar PRs 🙂

[gitressa]

You're welcome, thanks for being positive and welcoming! It's not always the case in Open Source, so it's great to encounter.

And it looks like the Github search engine picked up the change. Though, Python is still not mentioned in the search result (apart from the label). So perhaps "Python" could be added in the project description, to make it more likely those people looking for python + htmx finds it, even if they're just quickly skimming the text?

About

Declarative server-side rendering utility for Python FastAPI with built-in HTMX support.

Add "Python" ^^ ?

I'll make sure to create issues or MRs for your other projects if I get ideas for improvement :)

[volfpeter]

Yeah, it would maybe make it easier to find the project, but "Python FastAPI" just feels wrong.

You clearly thought about the issue, made insightful comments, and proposed simple, clear improvements. It's hard not to be positive about these 🙂

[gitressa]

Well, it does not have to be in that order ... "FastAPI Python framework" or some other combination will also work. Having "Python" included is the key point.

I don't think you should fear that this will be seen as gaming the system or trying to cheat, if that's your worry. The intention is solely to guide users interested in python and htmx to this project. Remember, the vast majority of users new to Python have zero knowledge about what FastAPI is.

Think of it as indexing your product in a library system, why would you leave out a key component in the description?

[gitressa]

PS. And the description meta tag from https://github.com/volfpeter/fasthx is also used in search engines, and shown under the title:

<meta name="description" content="Declarative server-side rendering utility for FastAPI with built-in HTMX support. - volfpeter/fasthx">

The result is that Python is not mentioned in search engine results

This is the displayed text from a search for "Declarative server-side rendering utility for FastAPI" in a popular search engine:

volfpeter/fasthx: Declarative server-side rendering utility for ...
GitHub
https://github.com › volfpeter › fasthx
Declarative server-side rendering utility for FastAPI with built-in HTMX support. volfpeter.github.io/fasthx/. License. MIT license · 694 stars 19 forks ...

As you can see, Python is not mentioned.

[volfpeter]

I updated the description, now it also has Python in it right after "Declarative".

[gitressa]

Thank you, it will help new users find this project.

[volfpeter]

Thanks again.