Commit a41e45b3 authored by Adrian DC's avatar Adrian DC
Browse files

chore: docs: refactor the 'Preview' job into a 'termtosvg' job

parent 9bbe427d

.gitlab-ci.yml

+10 −5
Changes for .gitlab-ci.yml: 10 added lines, 5 removed lines.
Original line number Diff line number Diff line
@@ -8,6 +8,10 @@ stages: 
  - quality

  - deploy



variables:

  EXECUTOR_HOST: preview

  EXECUTOR_TOOL: pexpect-executor



.local:

  engine: docker,auto

  real_paths: true
@@ -52,6 +56,7 @@ stages: 
    - sudo pip3 install -r requirements/deploy.txt --upgrade

    - sudo pip3 install -r requirements/quality.txt --upgrade

    - sudo pip3 install -r requirements/tests.txt --upgrade

    - sudo pip3 install -r requirements/docs.txt --upgrade

  only:

    - local
@@ -67,12 +72,12 @@ stages: 


'Preview':

  stage: development

  image: local:silent

  before_script:

    - pip3 install -q dist/*.whl 2>/dev/null

    - pip3 install -q -r requirements/docs.txt --upgrade 2>/dev/null

    - pip3 install -q -r requirements/tests.txt --upgrade 2>/dev/null

  script:

    - for i in $(seq 1 100); do echo ' '; done

    - sleep 3

    - python3 ./docs/preview.py

    - sleep 10

    - pexpect-executor -- termtosvg ./docs/preview.svg -c 'python3 ./docs/preview.py' -g 80x24 -t ./docs/template.svg

  only:

    - local

README.md

+9 −1
Changes for README.md: 9 added lines, 1 removed line.
Original line number Diff line number Diff line
@@ -11,6 +11,12 @@ Automate interactive CLI tools actions to create previews or tests in Python. 


---



## Preview



![preview.svg](https://gitlab.com/AdrianDC/pexpect-executor/raw/1.1.1/docs/preview.svg)



---



## CLI examples



```bash
@@ -62,6 +68,8 @@ Executor('').\ 
    finish()

```



---



## Usage



| Command          |                                        |
@@ -110,6 +118,6 @@ Executor('').\ 
- [git-chglog](https://github.com/git-chglog/git-chglog): CHANGELOG generator

- [gitlab-release](https://pypi.org/project/gitlab-release/): Utility for publishing on GitLab

- [gitlabci-local](https://pypi.org/project/gitlabci-local/): Launch .gitlab-ci.yml jobs locally

- [peek](https://github.com/phw/peek): Simple GIF screen recorder

- [PyPI](https://pypi.org/): The Python Package Index

- [termtosvg](https://pypi.org/project/termtosvg/): Record terminal sessions as SVG animations

- [twine](https://pypi.org/project/twine/): Utility for publishing on PyPI

docs/preview.py

+3 −1
Changes for docs/preview.py: 3 added lines, 1 removed line.
Original line number Diff line number Diff line
@@ -7,7 +7,9 @@ from pexpect_executor import Executor 
Executor.configure(host='previews', tool='pexpect-executor')



# List

Executor('ls -la', workdir='/').\

Executor(

    'pexpect-executor --space --down --down --space --press a --press a --enter -- gitlabci-local'

).\

    finish()



# More

docs/preview.svg

0 → 100644
+113

File added.

Preview size limit exceeded, changes collapsed.

docs/template.svg

0 → 100644
+54
Changes for docs/template.svg: 54 added lines, 0 removed lines.
Original line number Diff line number Diff line 
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" id="terminal" baseProfile="full" viewBox="0 0 676 345" width="676" version="1.1">

    <defs>

        <termtosvg:template_settings xmlns:termtosvg="https://github.com/nbedos/termtosvg">

            <termtosvg:screen_geometry columns="82" rows="19"/>

            <termtosvg:animation type="css"/>

        </termtosvg:template_settings>

        <style type="text/css" id="generated-style"></style>

        <style type="text/css" id="user-style">

            /* The colors defined below are the default 16 colors used for rendering text of the terminal. Adjust

               them as needed.

               ubuntu colors based on https://en.wikipedia.org/wiki/ANSI_escape_code#Colors */

            .foreground {fill: #e5e5e5;}

            .background {fill: #000000;}

            .color0 {fill: #000000;}

            .color1 {fill: #cd0000;}

            .color2 {fill: #00cd00;}

            .color3 {fill: #cdcd00;}

            .color4 {fill: #0000ee;}

            .color5 {fill: #cd00cd;}

            .color6 {fill: #00cdcd;}

            .color7 {fill: #e5e5e5;}

            .color8 {fill: #7f7f7f;}

            .color9 {fill: #ff0000;}

            .color10 {fill: #00ff00;}

            .color11 {fill: #ffff00;}

            .color12 {fill: #5c5cff;}

            .color13 {fill: #ff00ff;}

            .color14 {fill: #00ffff;}

            .color15 {fill: #ffffff;}



            #terminal {border-radius: 5px; overflow:hidden;}



            @keyframes progress-bar-animation {

                from {

                    transform: translate(0px, calc(100% - 5px)) scale(0, 1);

                }

                to {

                    transform: translate(0px, calc(100% - 5px)) scale(1, 1);

                }

            }

            #progress-bar {

                animation-duration: var(--animation-duration);

                animation-iteration-count: infinite;

                animation-name: progress-bar-animation;

                animation-timing-function: linear;

                fill: #2083dd;

                transform-origin: left;

            }

        </style>

    </defs>

    <rect id="terminalui" class="background" width="100%" height="100%" />

    <svg id="screen" width="656" height="323" x="10" y="10" viewBox="0 0 656 323" preserveAspectRatio="xMidYMin slice"></svg>

    <rect id="progress-bar" width="100%" height="5"/>

</svg>