def test_load_config():
with tempfile.TemporaryDirectory() as dir:
config = cfg.load({'ASCIINEMA_CONFIG_HOME': dir + '/foo/bar'})
assert re.match('^\w{8}-\w{4}-\w{4}-\w{4}-\w{12}', config.api_token)
with open(dir + '/config', 'w') as f:
token = 'foo-bar-baz-qux-quux'
f.write("[api]\ntoken = %s" % token)
config = cfg.load({'ASCIINEMA_CONFIG_HOME': dir})
assert_equal(token, config.api_token)
def test_load_config():
with tempfile.TemporaryDirectory() as dir:
config = cfg.load({'ASCIINEMA_CONFIG_HOME': dir + '/foo/bar'})
assert re.match('^\w{8}-\w{4}-\w{4}-\w{4}-\w{12}', config.api_token)
with open(dir + '/config', 'w') as f:
token = 'foo-bar-baz-qux-quux'
f.write("[api]\ntoken = %s" % token)
config = cfg.load({'ASCIINEMA_CONFIG_HOME': dir})
assert_equal(token, config.api_token)
def upload_asciinema(filename):
"""a wrapper around generation of an asciinema.api.Api to call the
upload command given an already existing asciinema file.
Parameters
==========
filename: the asciinema file to upload, can be generated with
function record_asciinema in record.py
"""
if os.path.exists(filename):
try:
from asciinema.commands.upload import UploadCommand
import asciinema.config as aconfig
from asciinema.api import Api
except:
bot.exit(
"The asciinema module is required to submit "
"an asciinema recording. Try pip install helpme[asciinema]"
)
# Load the API class
cfg = aconfig.load()
api = Api(cfg.api_url, os.environ.get("USER"), cfg.install_id)
# Perform the upload, return the url
uploader = UploadCommand(api, filename)
try:
url, warn = uploader.api.upload_asciicast(filename)
if warn:
uploader.print_warning(warn)
# Extract just the url, if provided (always is https)
if url:
match = re.search("https://.+", url)
if match:
url = match.group()
return url
except:
bot.error("Problem with upload, skipping")
else:
bot.warning("Cannot find %s, skipping submission." % filename)
def record_asciinema():
"""a wrapper around generation of an asciinema.api.Api and a custom
recorder to pull out the input arguments to the Record from argparse.
The function generates a filename in advance and a return code
so we can check the final status.
"""
import asciinema.config as aconfig
from asciinema.api import Api
# Load the API class
cfg = aconfig.load()
api = Api(cfg.api_url, os.environ.get("USER"), cfg.install_id)
# Create dummy class to pass in as args
recorder = HelpMeRecord(api)
code = recorder.execute()
if code == 0 and os.path.exists(recorder.filename):
return recorder.filename
print("Problem generating %s, return code %s" % (recorder.filename, code))
def main():
if locale.nl_langinfo(locale.CODESET).upper() != 'UTF-8':
print("asciinema needs a UTF-8 native locale to run. Check the output of `locale` command.")
sys.exit(1)
try:
cfg = config.load()
except config.ConfigError as e:
sys.stderr.write(str(e) + '\n')
sys.exit(1)
# create the top-level parser
parser = argparse.ArgumentParser(
description="Record and share your terminal sessions, the right way.",
epilog="""example usage:
Record terminal and upload it to asciinema.org:
\x1b[1masciinema rec\x1b[0m
Record terminal to local file:
\x1b[1masciinema rec demo.cast\x1b[0m
Record terminal and upload it to asciinema.org, specifying title:
\x1b[1masciinema rec -t "My git tutorial"\x1b[0m
Record terminal to local file, limiting idle time to max 2.5 sec:
\x1b[1masciinema rec -i 2.5 demo.cast\x1b[0m
Replay terminal recording from local file:
\x1b[1masciinema play demo.cast\x1b[0m
Replay terminal recording hosted on asciinema.org:
\x1b[1masciinema play https://asciinema.org/a/difqlgx86ym6emrmd8u62yqu8\x1b[0m
Print full output of recorded session:
\x1b[1masciinema cat demo.cast\x1b[0m
For help on a specific command run:
\x1b[1masciinema <command> -h\x1b[0m""",
formatter_class=argparse.RawDescriptionHelpFormatter
)
parser.add_argument('--version', action='version', version='asciinema %s' % __version__)
subparsers = parser.add_subparsers()
# create the parser for the "rec" command
parser_rec = subparsers.add_parser('rec', help='Record terminal session')
parser_rec.add_argument('--stdin', help='enable stdin recording, disabled by default', action='store_true', default=cfg.record_stdin)
parser_rec.add_argument('--append', help='append to existing recording', action='store_true', default=False)
parser_rec.add_argument('--raw', help='save only raw stdout output', action='store_true', default=False)
parser_rec.add_argument('--overwrite', help='overwrite the file if it already exists', action='store_true', default=False)
parser_rec.add_argument('-c', '--command', help='command to record, defaults to $SHELL', default=cfg.record_command)
parser_rec.add_argument('-e', '--env', help='list of environment variables to capture, defaults to ' + config.DEFAULT_RECORD_ENV, default=cfg.record_env)
parser_rec.add_argument('-t', '--title', help='title of the asciicast')
parser_rec.add_argument('-i', '--idle-time-limit', help='limit recorded idle time to given number of seconds', type=positive_float, default=maybe_str(cfg.record_idle_time_limit))
parser_rec.add_argument('-y', '--yes', help='answer "yes" to all prompts (e.g. upload confirmation)', action='store_true', default=cfg.record_yes)
parser_rec.add_argument('-q', '--quiet', help='be quiet, suppress all notices/warnings (implies -y)', action='store_true', default=cfg.record_quiet)
parser_rec.add_argument('filename', nargs='?', default='', help='filename/path to save the recording to')
parser_rec.set_defaults(func=rec_command)
# create the parser for the "play" command
parser_play = subparsers.add_parser('play', help='Replay terminal session')
parser_play.add_argument('-i', '--idle-time-limit', help='limit idle time during playback to given number of seconds', type=positive_float, default=maybe_str(cfg.play_idle_time_limit))
parser_play.add_argument('-s', '--speed', help='playback speedup (can be fractional)', type=positive_float, default=cfg.play_speed)
parser_play.add_argument('filename', help='local path, http/ipfs URL or "-" (read from stdin)')
parser_play.set_defaults(func=play_command)
# create the parser for the "cat" command
parser_cat = subparsers.add_parser('cat', help='Print full output of terminal session')
parser_cat.add_argument('filename', help='local path, http/ipfs URL or "-" (read from stdin)')
parser_cat.set_defaults(func=cat_command)
# create the parser for the "upload" command
parser_upload = subparsers.add_parser('upload', help='Upload locally saved terminal session to asciinema.org')
parser_upload.add_argument('filename', help='filename or path of local recording')
parser_upload.set_defaults(func=upload_command)
# create the parser for the "auth" command
parser_auth = subparsers.add_parser('auth', help='Manage recordings on asciinema.org account')
parser_auth.set_defaults(func=auth_command)
# parse the args and call whatever function was selected
args = parser.parse_args()
if hasattr(args, 'func'):
command = args.func(args, cfg)
code = command.execute()
sys.exit(code)
else:
parser.print_help()
sys.exit(1)
def main():
if locale.nl_langinfo(locale.CODESET).upper() != 'UTF-8':
print("asciinema needs a UTF-8 native locale to run. Check the output of `locale` command.")
sys.exit(1)
cfg = config.load()
# create the top-level parser
parser = argparse.ArgumentParser(
description="Record and share your terminal sessions, the right way.",
epilog="""example usage:
Record terminal and upload it to asciinema.org:
\x1b[1masciinema rec\x1b[0m
Record terminal to local file:
\x1b[1masciinema rec demo.json\x1b[0m
Record terminal and upload it to asciinema.org, specifying title:
\x1b[1masciinema rec -t "My git tutorial"\x1b[0m
Record terminal to local file, "trimming" longer pauses to max 2.5 sec:
\x1b[1masciinema rec -w 2.5 demo.json\x1b[0m
Replay terminal recording from local file:
\x1b[1masciinema play demo.json\x1b[0m
Replay terminal recording hosted on asciinema.org:
\x1b[1masciinema play https://asciinema.org/a/difqlgx86ym6emrmd8u62yqu8\x1b[0m
For help on a specific command run:
\x1b[1masciinema <command> -h\x1b[0m""",
formatter_class=argparse.RawDescriptionHelpFormatter
)
parser.add_argument('--version', action='version', version='asciinema %s' % __version__)
subparsers = parser.add_subparsers()
# create the parser for the "rec" command
parser_rec = subparsers.add_parser('rec', help='Record terminal session')
parser_rec.add_argument('-c', '--command', help='command to record, defaults to $SHELL', default=cfg.record_command)
parser_rec.add_argument('-t', '--title', help='title of the asciicast')
parser_rec.add_argument('-w', '--max-wait', help='limit recorded terminal inactivity to max <sec> seconds (can be fractional)', type=positive_float, default=maybe_str(cfg.record_max_wait))
parser_rec.add_argument('-y', '--yes', help='answer "yes" to all prompts (e.g. upload confirmation)', action='store_true', default=cfg.record_yes)
parser_rec.add_argument('-q', '--quiet', help='be quiet, suppress all notices/warnings (implies -y)', action='store_true', default=cfg.record_quiet)
parser_rec.add_argument('filename', nargs='?', default='', help='filename/path to save the recording to')
parser_rec.set_defaults(func=rec_command)
# create the parser for the "play" command
parser_play = subparsers.add_parser('play', help='Replay terminal session')
parser_play.add_argument('-w', '--max-wait', help='limit terminal inactivity to max <sec> seconds (can be fractional)', type=positive_float, default=maybe_str(cfg.play_max_wait))
parser_play.add_argument('-s', '--speed', help='playback speedup (can be fractional)', type=positive_float, default=cfg.play_speed)
parser_play.add_argument('filename', help='local path, http/ipfs URL or "-" (read from stdin)')
parser_play.set_defaults(func=play_command)
# create the parser for the "upload" command
parser_upload = subparsers.add_parser('upload', help='Upload locally saved terminal session to asciinema.org')
parser_upload.add_argument('filename', help='filename or path of local recording')
parser_upload.set_defaults(func=upload_command)
# create the parser for the "auth" command
parser_auth = subparsers.add_parser('auth', help='Manage recordings on asciinema.org account')
parser_auth.set_defaults(func=auth_command)
# parse the args and call whatever function was selected
args = parser.parse_args()
if hasattr(args, 'func'):
command = args.func(args, cfg)
code = command.execute()
sys.exit(code)
else:
parser.print_help()
sys.exit(1)
def main():
if locale.nl_langinfo(locale.CODESET).upper() != 'UTF-8':
print(
"asciinema needs a UTF-8 native locale to run. Check the output of `locale` command."
)
sys.exit(1)
cfg = config.load()
# create the top-level parser
parser = argparse.ArgumentParser(
description="Record and share your terminal sessions, the right way.",
epilog="""example usage:
Record terminal and upload it to asciinema.org:
\x1b[1masciinema rec\x1b[0m
Record terminal to local file:
\x1b[1masciinema rec demo.json\x1b[0m
Record terminal and upload it to asciinema.org, specifying title:
\x1b[1masciinema rec -t "My git tutorial"\x1b[0m
Record terminal to local file, "trimming" longer pauses to max 2.5 sec:
\x1b[1masciinema rec -w 2.5 demo.json\x1b[0m
Replay terminal recording from local file:
\x1b[1masciinema play demo.json\x1b[0m
Replay terminal recording hosted on asciinema.org:
\x1b[1masciinema play https://asciinema.org/a/difqlgx86ym6emrmd8u62yqu8\x1b[0m
For help on a specific command run:
\x1b[1masciinema <command> -h\x1b[0m""",
formatter_class=argparse.RawDescriptionHelpFormatter)
parser.add_argument('--version',
action='version',
version='asciinema %s' % __version__)
subparsers = parser.add_subparsers()
# create the parser for the "rec" command
parser_rec = subparsers.add_parser('rec', help='Record terminal session')
parser_rec.add_argument('-c',
'--command',
help='command to record, defaults to $SHELL',
default=cfg.record_command)
parser_rec.add_argument('-t', '--title', help='title of the asciicast')
parser_rec.add_argument(
'-w',
'--max-wait',
help=
'limit recorded terminal inactivity to max <sec> seconds (can be fractional)',
type=positive_float,
default=maybe_str(cfg.record_max_wait))
parser_rec.add_argument(
'-y',
'--yes',
help='answer "yes" to all prompts (e.g. upload confirmation)',
action='store_true',
default=cfg.record_yes)
parser_rec.add_argument(
'-q',
'--quiet',
help='be quiet, suppress all notices/warnings (implies -y)',
action='store_true',
default=cfg.record_quiet)
parser_rec.add_argument('filename',
nargs='?',
default='',
help='filename/path to save the recording to')
parser_rec.set_defaults(func=rec_command)
# create the parser for the "play" command
parser_play = subparsers.add_parser('play', help='Replay terminal session')
parser_play.add_argument(
'-w',
'--max-wait',
help=
'limit terminal inactivity to max <sec> seconds (can be fractional)',
type=positive_float,
default=maybe_str(cfg.play_max_wait))
parser_play.add_argument(
'filename', help='local path, http/ipfs URL or "-" (read from stdin)')
parser_play.set_defaults(func=play_command)
# create the parser for the "upload" command
parser_upload = subparsers.add_parser(
'upload',
help='Upload locally saved terminal session to asciinema.org')
parser_upload.add_argument('filename',
help='filename or path of local recording')
parser_upload.set_defaults(func=upload_command)
# create the parser for the "auth" command
parser_auth = subparsers.add_parser(
'auth', help='Manage recordings on asciinema.org account')
parser_auth.set_defaults(func=auth_command)
# parse the args and call whatever function was selected
args = parser.parse_args()
if hasattr(args, 'func'):
command = args.func(args, cfg)
code = command.execute()
sys.exit(code)
else:
parser.print_help()
sys.exit(1)
