afqbrowser.upload

afqbrowser.upload(target, repo_name, uname=None, upass=None, token=None, org=None, to_vault=True)

Upload an assembled AFQ-Browser site to a github pages website.

Parameters

targetstr

Local path to the file-system location where the AFQ-Browser files are (need to run assemble before running this function)

repo_namestr

The website will be at https://<username>.github.io/<repo_name>

unamestr, optional

GitHub user-name

upassstr, optional

GitHub password

orgstr, optional

When provided, this means that the website will be at: https://<org>.github.io/<repo_name>. Defaults to use the user-name.

to_vaultbool, optional

Whether to deposit the data to afqvault. Default: True