showyourwork.cli.commands.setup.setup(slug, cache, overleaf_id, ssh, action_spec)#

Set up a new article repo.

  • slug (str) – Repository slug (user/repo).

  • cache (bool) – If True, enable caching on Zenodo Sandbox.

  • overleaf_id (str or NoneType) – Overleaf ID of the article.

  • ssh (bool) – If True, use SSH to clone the repository. Otherwise, use HTTPS.

  • action_spec (str or None) – Showyourwork version passed to showyourwork-action in .github/workflows/*.yml