Sample CLI
gway readme collect-projects
References
['log', 'warning']
Signature
(project_dir: str, readme: str = 'README.rst')
Docstring
Scan `project_dir` for all modules/packages, collect public functions,
build an RST section, and insert/update it in `readme` before the LICENSE heading.
Args:
project_dir: path to the GWAY projects directory.
readme: path to the README file to update.
Sample CLI
gway release build
References
['abort', 'error', 'info', 'readme', 'readme.collect_projects', 'resource', 'test']
Signature
(*, bump: bool = False, dist: bool = False, twine: bool = False, help_db: bool = True, user: str =
'[PYPI_USERNAME]', password: str = '[PYPI_PASSWORD]', token: str = '[PYPI_API_TOKEN]', projects:
bool = False, git: bool = False, all: bool = False) -> None
Docstring
Build the project and optionally upload to PyPI.
Args:
bump (bool): Increment patch version if True.
dist (bool): Build distribution package if True.
twine (bool): Upload to PyPI if True.
user (str): PyPI username (default: [PYPI_USERNAME]).
password (str): PyPI password (default: [PYPI_PASSWORD]).
token (str): PyPI API token (default: [PYPI_API_TOKEN]).
git (bool): Require a clean git repo and commit/push after release if True.
vscode (bool): Build the vscode extension.
Sample CLI
gway web.app redirect-error
References
['debug', 'error', 'exception']
Signature
(error=None, note='', default='/gway/readme', broken_view_name=None)
Sample CLI
gway web.app render-navbar
References
['qr', 'qr.generate_url', 'resource']
Signature
(visited, path, current_url=None)
Sample CLI
gway web.app render-template
Signature
(*, title='GWAY', navbar='', content='', static='static', css_files=None)
Sample CLI
gway web.app setup
References
['debug', 'info', 'resource', 'to_html', 'to_list', 'unwrap', 'version', 'web', 'web.app_url', 'web.redirect_error', 'web.static_url', 'web.work_url']
Signature
(*, app=None, project='web.site', path=None, static='static', work='work', home: str = 'readme',
prefix: str = 'view', navbar: bool = True)
Docstring
Configure one or more Bottle-based apps. Use web server start-app to launch.
TODOs
# TODO: When passing a param to a view, such as from a form that was left empty by the user
# avoid passing None, instead pass "" (empty string) as it may differentiate between a
# form that has not been submitted and one submitted with empty fields.
Sample CLI
gway web.site view-readme
Signature
(*args, **kwargs)
Docstring
Render the README.rst file as HTML.