Add PyPI Observation API integration #1
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Put the `httpx.Client` instance in it's own module that can be imported around as necessary. Essentially a singleton. Also has authentication information and base URL attached to it, for ease for use.
It makes sense for the root route (`GET /`) to be in the `app.py` module (where the FastAPI app instance is located). This will probably be replaced by current Dragonfly Reporter API version later on in a separate PR, as the [echo endpoint](https://github.com/pypi/pypi-observation-api-private-beta?tab=readme-ov-file#get-danger-apiecho) will most likely be removed in v1.
This will make it easier to test compared to a global singleton that gets imported around - we can simply use FastAPI's [Testing Dependencies](https://fastapi.tiangolo.com/advanced/testing-dependencies/) feature.
Since this app only has two endpoints as of now (including the echo endpoint), it's probably fine to just leave it in app.py
jonathan-d-zhang
requested changes
Mar 2, 2024
Tests don't run in CI if this isn't set to *something*
Add a test case that checks that the "kind" in the payload is set to "malware," but also that "inspector_url" is not present. Normally, the Observations API requires that the "inspector_url" field be present if the kind is "is_malware," so let's see if this endpoint enforces that.
Robin5605
force-pushed
the
observation-api
branch
from
0e0ee4f to
de9a9b8
Compare
jonathan-d-zhang
previously approved these changes
Mar 2, 2024
. Note that you'll have to modify the dockerfile if you've changed how to run the server.
|
I forgor 💀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.