search

sneakers-the-rat / paper-feeds

A FastAPI web server for creating RSS feeds for scholarly journals with the magic of adversarial interoperability
GNU General Public License v3.0
63 stars 4 forks source link

Documenting how to get the dev env running #1

Closed roaldarbol closed 10 months ago

roaldarbol commented 10 months ago

I've just added a small section about how to get the app running. We can add more stuff here when needed.

sneakers-the-rat commented 10 months ago

I think typically we want to do something like expose an entrypoint like https://github.com/sneakers-the-rat/journal-rss/blob/23636f3fd78df215b92d05644d19e3dbbdbcc1a1/pyproject.toml#L28

So one would do poetry run start but if we wanted to make an executable module we could just rename main.py to __main__.py ?

In any case agreed the entrypoint needs to be documented lol.

Edit: thats also a very javascript-brained name that will only work in a venv (or else it would shadow anything else named start - so we should probably make a click CLI interface like journal-rss start instead

roaldarbol commented 10 months ago

That sounds good to me - I just think we should have it documented how we do it at all times, so for now document current behaviour to ensure everyone who wants to contribute won't stumble over the low hurdles. :) So if we make a CLI, that's cool too, but then we can change the docs then I'd think.

sneakers-the-rat commented 10 months ago

did this in https://github.com/sneakers-the-rat/journal-rss/commit/c4413f812d2186e46a0de9953a3080416957c9af :)