Skip to content

Commit dd7341d

Browse files
Add usage GIF (#99)
1 parent c3bfa9d commit dd7341d

File tree

3 files changed

+116
-4
lines changed

3 files changed

+116
-4
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ their [SQLAlchemy](https://www.sqlalchemy.org/) drivers. Records
3030
mover is able to auto-negotiate the most efficient way of moving data
3131
from one to the other.
3232

33-
## Example CLI use
33+
## CLI use example
3434

3535
Installing:
3636

@@ -61,7 +61,11 @@ configured using
6161
For more installation notes, see [INSTALL.md](./docs/INSTALL.md). To
6262
understand the security model here, see [SECURITY.md](./docs/SECURITY.md).
6363

64-
## Example Python library use
64+
## CLI use demo (table creation and loading)
65+
66+
<img src="https://i.imgur.com/PvmMhft.gif">
67+
68+
## Python library use example
6569

6670
First, install records_mover. We'll also use Pandas, so we'll install
6771
that, too, as well as a driver for Postgres.
@@ -98,7 +102,7 @@ When moving data, the sources supported can be found
98102
and the targets supported can be found
99103
[here](https://records-mover.readthedocs.io/en/latest/records_mover.records.targets.html).
100104

101-
## Advanced Python library use
105+
## Advanced Python library use example
102106

103107
Here's another example, using some additional features:
104108

docs/terminalizer.yml

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
# Specify a command to be executed
2+
# like `/bin/bash -l`, `ls`, or any other commands
3+
# the default is bash for Linux
4+
# or powershell.exe for Windows
5+
command: bash -l
6+
7+
# Specify the current working directory path
8+
# the default is the current working directory path
9+
cwd: /Users/broz
10+
11+
# Export additional ENV variables
12+
env:
13+
recording: true
14+
15+
# Explicitly set the number of columns
16+
# or use `auto` to take the current
17+
# number of columns of your shell
18+
cols: 120
19+
20+
# Explicitly set the number of rows
21+
# or use `auto` to take the current
22+
# number of rows of your shell
23+
rows: 50
24+
25+
# Amount of times to repeat GIF
26+
# If value is -1, play once
27+
# If value is 0, loop indefinitely
28+
# If value is a positive number, loop n times
29+
repeat: 0
30+
31+
# Quality
32+
# 1 - 100
33+
quality: 100
34+
35+
# Delay between frames in ms
36+
# If the value is `auto` use the actual recording delays
37+
frameDelay: auto
38+
39+
# Maximum delay between frames in ms
40+
# Ignored if the `frameDelay` isn't set to `auto`
41+
# Set to `auto` to prevent limiting the max idle time
42+
maxIdleTime: 2000
43+
44+
# The surrounding frame box
45+
# The `type` can be null, window, floating, or solid`
46+
# To hide the title use the value null
47+
# Don't forget to add a backgroundColor style with a null as type
48+
frameBox:
49+
type: null
50+
title: mvrec
51+
style:
52+
backgroundColor: black
53+
border: 0px black solid
54+
# boxShadow: none
55+
# margin: 0px
56+
57+
# Add a watermark image to the rendered gif
58+
# You need to specify an absolute path for
59+
# the image on your machine or a URL, and you can also
60+
# add your own CSS styles
61+
watermark:
62+
imagePath: null
63+
style:
64+
position: absolute
65+
right: 15px
66+
bottom: 15px
67+
width: 100px
68+
opacity: 0.9
69+
70+
# Cursor style can be one of
71+
# `block`, `underline`, or `bar`
72+
cursorStyle: block
73+
74+
# Font family
75+
# You can use any font that is installed on your machine
76+
# in CSS-like syntax
77+
fontFamily: "Monaco, Lucida Console, Ubuntu Mono, Monospace"
78+
79+
# The size of the font
80+
fontSize: 12
81+
82+
# The height of lines
83+
lineHeight: 1
84+
85+
# The spacing between letters
86+
letterSpacing: 0
87+
88+
# Theme
89+
theme:
90+
background: "transparent"
91+
foreground: "#afafaf"
92+
cursor: "#c7c7c7"
93+
black: "#232628"
94+
red: "#fc4384"
95+
green: "#b3e33b"
96+
yellow: "#ffa727"
97+
blue: "#75dff2"
98+
magenta: "#ae89fe"
99+
cyan: "#708387"
100+
white: "#d5d5d0"
101+
brightBlack: "#626566"
102+
brightRed: "#ff7fac"
103+
brightGreen: "#c8ed71"
104+
brightYellow: "#ebdf86"
105+
brightBlue: "#75dff2"
106+
brightMagenta: "#ae89fe"
107+
brightCyan: "#b1c6ca"
108+
brightWhite: "#f9f9f4"

metrics/mdl_high_water_mark

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
8
1+
9

0 commit comments

Comments
 (0)