laundry list of what we want to know from a PreTeXt-CLI user in -support

[Steven Clontz]

I want to add a `pretext support` command to the CLI to print out everything we'd want to know about a user. Then we can add to the header of the pretext-support group that CLI users should supply this info to get timely support.

Issue here https://github.com/PreTeXtBook/pretext-cli/issues/185 but let's discuss here first.

[Steven Clontz]

Some obvious stuff

OS and version
Python version and path/to/python (to infer whether a venv is used)

PreTeXt-CLI version

Maybe the contents of project.ptx would be important as well (e.g. a user tries to pretext build html but doesn't have an html target defined).

[Steven Clontz]

And if the user is cloning rbeezer/mathbook we might prepare a recipe they could run as well (but that's way more difficult due to the various ways they may have wired things together).

[Jones, Bryan]

Perhaps also the contents of pip list, so you'll know what versions of which libraries (especially lxml) are installed? Project path (look for spaces in filenames, foreign chars, etc.)

--
You received this message because you are subscribed to the Google Groups "PreTeXt development" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pretext-dev...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/pretext-dev/24f540d5-dec8-43f4-8d83-aefcf8671546n%40googlegroups.com.

--

Bryan A. Jones, Ph.D.
Associate Professor
Department of Electrical and Computer Engineering
231 Simrall / PO Box 9571
Mississippi State University
Mississippi State, MS 39762
http://www.ece.msstate.edu/~bjones
bjones AT ece DOT msstate DOT edu
voice 662-325-3149
fax 662-325-2298

Our Master, Jesus Christ, is on his way. He'll show up right on
time, his arrival guaranteed by the Blessed and Undisputed Ruler,
High King, High God.
- 1 Tim. 6:14b-15 (The Message)

[Steven Clontz]

Yeah, versions of the pip libraries required by PreTeXt-CLI would be good.

And yes, we should return the path of the root of the project (the directory containing project.ptx).

[Steven Clontz]

We should output the Git remote to infer e.g. where a GitHub Pages build should live if they're using `pretext publish`

[Steven Clontz]

Current draft produces this:

user@project-a3ec276b-3ccf-43b8-bbb2-52eec3285126 ~/new-pretext-project (main)
[pipenv]$ pretext support
PreTeXt project found in `/home/user/new-pretext-project`.

Please share the following information when posting to the
pretext-support Google Group.

PreTeXt-CLI version: 0.6.1.dev0
PreTeXt core resources commit: db92736db712a0a15faaa5e15b1a59e6b2defe5a
OS: Linux-5.11.0-1020-gcp-x86_64-with-glibc2.29
Python version: 3.8.5
Current working directory: /home/user/new-pretext-project
PreTeXt project path: /home/user/new-pretext-project

Contents of project.ptx:
------------------------
<!--
    This file provides the overall configuration for your PreTeXt
    project. To edit the content of your document, open `source/main.ptx`
    (default location).
--><project>
  <targets>
    <target name="html">
      <format>html</format>
      <source>source/main.ptx</source>
      <publication>publication/publication.ptx</publication>
      <output-dir>output/html</output-dir>
    </target>
    <target name="latex">
      <format>latex</format>
      <source>source/main.ptx</source>
      <publication>publication/publication.ptx</publication>
      <output-dir>output/latex</output-dir>
    </target>
    <target name="pdf">
      <format>pdf</format>
      <source>source/main.ptx</source>
      <publication>publication/publication.ptx</publication>
      <output-dir>output/pdf</output-dir>
    </target>
    <!-- To quickly build the html of a subset of your project, edit main-subset.ptx
        and run `pretext build subset` (or `view` with watch option) -->
    <target name="subset">
      <format>html</format>
      <source>source/main-subset.ptx</source>
      <publication>publication/publication.ptx</publication>
      <output-dir>output/subset</output-dir>
      <stringparam key="debug.skip-knowls" value="yes"/>
    </target>
  </targets>
  <executables>
      <tex>xelatex</tex>
      <pdfsvg>pdf2svg</pdfsvg>
      <asy>asy</asy>
      <sage>sage</sage>
      <pdfpng>convert</pdfpng>
      <pdfeps>pdftops</pdfeps>
      <pdfcrop>pdf-crop-margins</pdfcrop>
      <pageres>pageres</pageres>
      <node>node</node>
      <liblouis>file2brl</liblouis>
    </executables>
</project>

[Rob Beezer]

Love the core resources commit.

Any chance of a date for the CLI version? It'd frequently save one more lookup to see just when various parts were assembled. In other words, not necessary information that couldn't be deduced, but a convenience for support supporters.

>>>>> <https://groups.google.com/d/msgid/pretext-dev/24f540d5-dec8-43f4-8d83-aefcf8671546n%40googlegroups.com?utm_medium=email&utm_source=footer>
>>>>> .

>>>>>
>>>>
>>>>
>>>> --
>>>> Bryan A. Jones, Ph.D.
>>>> Associate Professor
>>>> Department of Electrical and Computer Engineering
>>>> 231 Simrall / PO Box 9571
>>>> Mississippi State University
>>>> Mississippi State, MS 39762
>>>> http://www.ece.msstate.edu/~bjones
>>>> bjones AT ece DOT msstate DOT edu

>>>> voice 662-325-3149 <(662)%20325-3149>
>>>> fax 662-325-2298 <(662)%20325-2298>

[Steven Clontz]

I could make the version link to pypi which would have a date (I think). Versions aren't associated with dates and I don't think it's wise to do this manually.

You received this message because you are subscribed to a topic in the Google Groups "PreTeXt development" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/pretext-dev/Dis03tiAISE/unsubscribe.
To unsubscribe from this group and all its topics, send an email to pretext-dev...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/pretext-dev/MTAwMDAwMS5iZWV6ZXI.1646509065%40quikprotect.

[Rob Beezer]

Got it - thanks. +1 for a link. ;-)