Add New Sites with Maigret Submit Mode
The submit workflow reverse-engineers site signatures for you.
Interactive session
maigret --submit https://example.com/users/jdoeDuring the prompt, Maigret will:
- Fetch the URL and inspect response markers.
- Suggest a
checkType(message/status_code). - Ask whether to append the generated JSON to
data.json.
Approve the entry and review the diff:
git diff maigret/resources/data.jsonManual polishing
- Add accurate
alexaRank,tags, andusernameClaimedvalues. - Set realistic
timeoutandrequestHeadOnlyflags if necessary. - Provide
headersfor APIs that need tokens.
Testing new site
maigret username --site NewSite --debugMake sure presenceStrs and absenceStrs work for both claimed and unclaimed profiles.
Submit upstream
git checkout -b feat/new-site
git commit -am "feat: add ExampleSite profile detection"
git push origin feat/new-siteThen open a pull request referencing observed behaviour and sample accounts.
Collaboration flow
flowchart LR
A[maigret --submit] --> B[data.json diff]
B --> C[Run tests]
C --> D[Open PR]
D --> E[Review & merge]
Submit mode speeds up contributions while preserving consistency across thousands of entries.