Repository navigation
Redesign the README for scanning - #3
Merged
Merged
Conversation
Adopt the shared SDK README layout: header, badges, getting started, a choose-what-you-need table, proxy status table and folded framework guides. Every fact and sample is kept; the proxy sample gains the missing os import.
This file contains hidden or 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
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.
What changed
Only
README.md. The README now follows the shared SDK template: centred logo, tagline, badge row, banner, "What is this", "Getting started" (prerequisites,pip install fingerly, read an event with both clients, verify a webhook, docs link), a "Choose what you need" table and a contents list, then the reference sections, Requirements, Documentation, Help and Licence.Reorganisation inside the reference material:
event_pendingandevent_not_foundcodes are a table.<details>. "A note on mount paths" and "Source structure" are folded too.Preserved
Every fact from the old README was kept: key rules and rejected key kinds, endpoint override, no redirects, no retries,
FingerlyAPIErrorfields and the three error classes,ip_network,document,has_document,suspect_scoreandproject_idsemantics, 30-day retention, the verify-a-backend-action policy text, the webhook rules (raw bytes, 300 second tolerance, rotation, first 32 signatures, never raises,project_idin deliveries), the sync-in-async warning, closing rules, proxy path rules, headers forwarded and relayed,x-fingerly-proxy-version, user agent, 1 MiB and 4 MiB caps,client_iprules and the500message,ProxyRequestfields, mount path notes, all three framework apps, timeouts (10 s and 5 s), the thread sizing arithmetic, connection pooling (256, five minutes), API version, development commands and source structure. All code samples are unchanged except as noted below.Verified
src/fingerly(constructor arguments,events.listparameters,verify_webhooksignature,FingerlyProxyandProxyRequestfields).pytest(261 passed),uv buildand the wheel metadata (README is the long description) all pass locally.ci.yml), minimum Python 3.9 (fromrequires-python), licence (Apache-2.0 perLICENSE), docs.Sample fix
The proxy construction sample used
os.environwithoutimport os; the import was added.Notes
fingerly-io/.githubassets; they return 200 now.httpx>=0.27,<1frompyproject.toml.