Add New Sites with Maigret Submit Mode

The submit workflow reverse-engineers site signatures for you.

Interactive session

maigret --submit https://example.com/users/jdoe

During the prompt, Maigret will:

  1. Fetch the URL and inspect response markers.
  2. Suggest a checkType (message/status_code).
  3. Ask whether to append the generated JSON to data.json.

Approve the entry and review the diff:

git diff maigret/resources/data.json

Manual polishing

  • Add accurate alexaRank, tags, and usernameClaimed values.
  • Set realistic timeout and requestHeadOnly flags if necessary.
  • Provide headers for APIs that need tokens.

Testing new site

maigret username --site NewSite --debug

Make 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-site

Then 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.