Please add transactions to the Engines -> SQLiteEngine documentation

[badlydrawnrob]

It could be clearer how to get up and running with SQLite quickly ...

Generally there's normally some example of db.open() and db.close() wherever the SQLite documentation is, as well as options to have it all in one function rather than every route. You've got a great example on the tutorials documentation but that's buried quite deep in the docs.

Postgres has it's connection_pool() examples, so on the SQLiteEngine page it'd make sense to have (a) a link to the FastAPI tutorial, and (b) an isolated example that'd work with any implementation. It'd also be nice to consolidate the tutorials a little better, as currently the main site's documentation link points to the root Read the Docs page and not the Read the Docs: tutorials page (which also doesn't have a backlink to YouTube videos).

Finally, the from piccolo.engine import engine_finder docs could also be improved and easier to locate, but it doesn't seem you're using it in the FastAPI tutorials link above so I guess that's optional?

I'm happy to write some .md you could use for the docs if it helps.

[Skelmis]

If you are happy to make the changes, I'd be keen to see a pull request with what you have in mind

[badlydrawnrob]

@Skelmis How difficult is it to build the docs from source? I see they're using .rst files but I've not used Read the Docs before. Otherwise I can just write the file and preview it somewhere (by the way I'm unsure of how to connect to the database other than that transactions example).

[Skelmis]

You can find info on that here: https://piccolo-orm.readthedocs.io/en/latest/piccolo/contributing/index.html

[sinisaos]

@badlydrawnrob Transaction documentation is here, and transactions in SQLite are described here because using SQLite with asyncio can be problematic, and that is explained in detail at that link.

[badlydrawnrob]

@Skelmis Thanks for the link. I'm getting a few errors but I've managed to launch the documentation now. Quite nice that the requirements are split up for different needs. I imagine piccolo-admin and piccolo-api are the same setup? Fork -> Requirements -> Make -> Run .sh?

[Skelmis]

Yes they have similar contributing guides in their docs