labthings / labthings/labthings-fastapi

Documentation issues

Open
#167 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
9
Forks
4
PR merge metrics
No merged PRs in 30d

Description

I am trying to work out how to directly create a DirectThingClient and not have it injected into a thing by LabThings.

I need it for testing because I think the reason a test is taking 30 seconds is that the FastAPI TestClient is taking 0.1s per request, so this adds up when trying to make lots of calls.

The docs still have a question I asked you, this somehow slipped in:

Image

The links on this page do not link to DirectThingClient.

Trying to find the docs
Image is there a way to update the search settings
The docs

Reading the docs, it is not clear to me at all whether I can make an instance? And if not, if there is something I can do?

If I attach the Thing to a server, but I have reference to it. Can I just call it?

Edited to add

  • It is unclear to me what is imported with all. I have only ever used __all__ imports with pdoc, that uses this to create clear docs for what is available when you import.
  • Most python documentation has a way to view source code so you can see code that was documented. This doesn't seem to be working.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the v0.0.11 AutoAPI index and the documentation entry points for DirectThingClient, then inspect how exported names, search, and source links are configured. Done means the client can be found and its usage is explained, the import behavior is documented, and the reported search and source-view problems are resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
fastapi, python
Domain
documentation, testing
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.