rivtlib 1.0.0a18

Run a rivt file in a rivt CodeSpace

Open the rivtlib repository at https://github.com/rivtlib-dev/rivtlib . If you are reading this README file in GitHub you may already be there.

You will need to set up and log into your free GitHub account at https://github.com . before you fork the repository and run the rivt CodeSpace example.

+ When you fork or clone the rivtlib repository, you also get a devcontainer that
+ installs rivt and opens an example rivt file in a VSCode rivt environment.

Here are the steps to run the example rivt file in your CodeSpaces:

+ 1. Find the Fork button in the upper right corner of the page and click it.
+    This will create a copy of the repository in your own GitHub account.

+ 2. Go to the forked repository in your GitHub account and click the green Code button.

+ 3. In the Code menu, click the "Open with Codespaces" tab and then click the "New codespace" button.

+ 4. Wait for the Codespace to be created and the VSCode environment to open.

+ 5. The first time you do this it will take a few minutes to set up the environment.
+    rivt is built with about 2 million lines of open-source code and it
+    takes a few minutes to install all dependencies. This is only done once.
+    When you start rivt CodeSpaces in the future, it will only take a few seconds to open.

+ 6. Eventually you will see some progress messages in the terminal. You will
+    also be prompted to give permission to install some VSCode extensions.
+    Granting permission and trust once will install all of them. You do this one time.
+    You can rearrange the panels to your liking. Moving the terminal to the right
+    side with full vertical height is preferred for rivt.

+ 7. Once the environment is set up you can open the example file rivt-example-01.py
+    from the explorer pane on the left. You may have to click the pages icon to open it.
+    Run the file by clicking the triangle ▶ in the top right status bar.
+    The output text will be displayed in the terminal and the txt, pdf or html
+    files will be written to their respective output folders, depending on | PUBLISH | settings.

- 8. It is best to set the doc type to "txt" in the | PUBLISH | command in the rv.D
-    method at the end of the example file to check that everything is working for the
-    first few runs. The first run may take a minute or two as everything compiles for
-    the first time. Subsequent runs take a couple of seconds.

See https://rivt.info for details on creating, editing and running rivt files.

rivt Modules - Summary

================================================================================
Total Project Line Count:  6035
================================================================================

================================================================================
Module Name: C:\git\rivtlib-git\src\rivtlib\rvapi.py   | Total Lines: 493
================================================================================

IMPORTS:
- import argparse
- import fnmatch
- import logging
- import os
- import string
- import sys
- import warnings
- from importlib.metadata import version
- from pathlib import Path
- import __main__
- import rivtlib.rvunits as rvunit
- from rivtlib import rvdoc, rvparse, rvshell, rvtext

CLASSES & METHODS:

TOP-LEVEL FUNCTIONS:
- cmdhelp() -> 12 lines
- doc_parse() -> 29 lines
- R() -> 26 lines
- I() -> 22 lines
- V() -> 45 lines
- T() -> 60 lines
- D() -> 11 lines
- S() -> 9 lines
- X() -> 7 lines
================================================================================

================================================================================
Module Name: C:\git\rivtlib-git\src\rivtlib\rvbook.py   | Total Lines: 327
================================================================================

IMPORTS:
- import configparser
- import glob
- import logging
- import os
- import subprocess
- import sys
- import textwrap
- import warnings
- from datetime import datetime
- from pathlib import Path
- import __main__
- import rvrepcfg as rvb

CLASSES & METHODS:

TOP-LEVEL FUNCTIONS:
- pdfx() -> 88 lines
- txtx() -> 29 lines
================================================================================

================================================================================
Module Name: C:\git\rivtlib-git\src\rivtlib\rvcmd.py   | Total Lines: 1284
================================================================================

IMPORTS:
- import csv
- import sys
- import textwrap
- from datetime import datetime
- from io import StringIO
- from pathlib import Path
- import numpy as np
- import pandas as pd
- import sympy as sp
- import tabulate
- from fastcore.utils import store_attr
- from IPython.display import display as _display
- from PIL import Image
- from sympy.abc import _clash2
- from rivtlib.rvunits import *
- from rivtlib.unum.core import Unum

CLASSES & METHODS:
    Class: Cmd (1261 lines total)
    └─ Method: __init__() -> 28 lines
    └─ Method: cmdx() -> 13 lines
    └─ Method: vdefine() -> 56 lines
    └─ Method: vassign() -> 113 lines
    └─ Method: vfunc() -> 115 lines
    └─ Method: vcompare() -> 123 lines
    └─ Method: wrap_pad() -> 15 lines
    └─ Method: get_image_time() -> 57 lines
    └─ Method: IMAGE() -> 62 lines
    └─ Method: IMAGE2() -> 85 lines
    └─ Method: TABLE() -> 85 lines
    └─ Method: VALTABLE() -> 101 lines
    └─ Method: VALDATA() -> 101 lines
    └─ Method: PYTHON() -> 81 lines
    └─ Method: FUNCTION() -> 83 lines
    └─ Method: TEXT() -> 92 lines

TOP-LEVEL FUNCTIONS:
================================================================================

================================================================================
Module Name: C:\git\rivtlib-git\src\rivtlib\rvdoc.py   | Total Lines: 548
================================================================================

IMPORTS:
- import configparser
- import glob
- import logging
- import os
- import shutil
- import subprocess
- import warnings
- from datetime import datetime
- from pathlib import Path
- import rvdoccfg as rvd
- from fastcore.utils import store_attr
- import __main__

CLASSES & METHODS:
    Class: Cmdp (528 lines total)
    └─ Method: __init__() -> 88 lines
    └─ Method: cmdx() -> 84 lines
    └─ Method: metadatax() -> 33 lines
    └─ Method: attachpdfx() -> 5 lines
    └─ Method: pdfx() -> 27 lines
    └─ Method: pdf_insert() -> 141 lines
    └─ Method: htmlx() -> 38 lines
    └─ Method: txtx() -> 24 lines
    └─ Method: nonex() -> 17 lines
    └─ Method: docreadme() -> 36 lines

TOP-LEVEL FUNCTIONS:
================================================================================

================================================================================
Module Name: C:\git\rivtlib-git\src\rivtlib\rvdoccfg.py   | Total Lines: 726
================================================================================

IMPORTS:
- import glob
- import os
- import shutil
- from datetime import datetime
- from pathlib import Path

CLASSES & METHODS:

TOP-LEVEL FUNCTIONS:
- copy_docs() -> 11 lines
- pdf_confpy() -> 145 lines
- pdf_yamlS() -> 424 lines
- html_templ() -> 41 lines
- html_confpy() -> 81 lines
================================================================================

================================================================================
Module Name: C:\git\rivtlib-git\src\rivtlib\rvparse.py   | Total Lines: 406
================================================================================

IMPORTS:
- import logging
- import os
- import re
- import sys
- import textwrap
- import warnings
- from io import StringIO
- from pathlib import Path
- import tabulate
- from fastcore.utils import store_attr
- import __main__
- from . import rvcmd, rvtag

CLASSES & METHODS:
    Class: Rs (384 lines total)
    └─ Method: __init__() -> 147 lines
    └─ Method: prt_tabl() -> 22 lines
    └─ Method: remove_aster() -> 10 lines
    └─ Method: content() -> 198 lines

TOP-LEVEL FUNCTIONS:
================================================================================

================================================================================
Module Name: C:\git\rivtlib-git\src\rivtlib\rvrepcfg.py   | Total Lines: 790
================================================================================

IMPORTS:
- import glob
- import os
- import shutil
- from pathlib import Path

CLASSES & METHODS:

TOP-LEVEL FUNCTIONS:
- copy_docs() -> 10 lines
- pdf_confpy() -> 146 lines
- pdf_yamlS() -> 402 lines
- pdf_coverS() -> 68 lines
- html_confpy() -> 81 lines
- html_index() -> 57 lines
================================================================================

================================================================================
Module Name: C:\git\rivtlib-git\src\rivtlib\rvreport.py   | Total Lines: 518
================================================================================

IMPORTS:
- import configparser
- import glob
- import logging
- import os
- import shutil
- import subprocess
- import sys
- import textwrap
- import warnings
- from datetime import datetime
- from itertools import groupby
- from pathlib import Path
- import __main__
- import rvrepcfg as rvr

CLASSES & METHODS:

TOP-LEVEL FUNCTIONS:
- pdfx() -> 92 lines
- htmlx() -> 155 lines
- txtx() -> 40 lines
================================================================================

================================================================================
Module Name: C:\git\rivtlib-git\src\rivtlib\rvshell.py   | Total Lines: 93
================================================================================

IMPORTS:
- import glob
- import os
- import shutil
- import subprocess
- import textwrap
- from pathlib import Path

CLASSES & METHODS:

TOP-LEVEL FUNCTIONS:
- run_shell() -> 85 lines
================================================================================

================================================================================
Module Name: C:\git\rivtlib-git\src\rivtlib\rvtag.py   | Total Lines: 379
================================================================================

IMPORTS:
- import csv
- import textwrap
- from pathlib import Path
- import docutils.parsers.rst.tableparser
- import sympy as sp
- import tabulate
- from fastcore.utils import store_attr
- from numpy import *
- from sympy.abc import _clash2

CLASSES & METHODS:
    Class: Tag (365 lines total)
    └─ Method: __init__() -> 23 lines
    └─ Method: taglx() -> 160 lines
    └─ Method: tagbx() -> 147 lines
    └─ Method: parse_simple_rst_table() -> 24 lines

TOP-LEVEL FUNCTIONS:
================================================================================

================================================================================
Module Name: C:\git\rivtlib-git\src\rivtlib\rvtext.py   | Total Lines: 266
================================================================================

IMPORTS:
- import ast
- import io
- import sys
- import textwrap
- from pathlib import Path
- from docutils.core import publish_parts

CLASSES & METHODS:

TOP-LEVEL FUNCTIONS:
- build_transcript() -> 67 lines
- format_text() -> 166 lines
- mermaidx() -> 2 lines
- dotx() -> 2 lines
- latexx() -> 2 lines
- htmlx() -> 2 lines
- rstx() -> 2 lines
================================================================================

================================================================================
Module Name: C:\git\rivtlib-git\src\rivtlib\rvunits.py   | Total Lines: 141
================================================================================

IMPORTS:
- import importlib.util
- import sys
- from pathlib import Path
- from rivtlib.unum.core import Unum, new_unit

CLASSES & METHODS:

TOP-LEVEL FUNCTIONS:
================================================================================

================================================================================
Module Name: C:\git\rivtlib-git\src\rivtlib\__init__.py   | Total Lines: 60
================================================================================

IMPORTS:

CLASSES & METHODS:

TOP-LEVEL FUNCTIONS:
================================================================================

================================================================================
Module Name: C:\git\rivtlib-git\src\rivtlib\__main__.py   | Total Lines: 4
================================================================================

IMPORTS:

CLASSES & METHODS:

TOP-LEVEL FUNCTIONS:
================================================================================