sci-oer / student-cli Goto Github PK

Describe the solution you'd like

Creating command documentation in the form of linux man pages is helpful to provide a full set of documentation to go along with the cli application. The man pages is a predictable location to find documentation for a cli command for most terminal users.

These man pages should be auto installed when the package is installed.

https://www.pragmaticlinux.com/2021/01/create-a-man-page-for-your-own-program-or-script-with-pandoc/

Describe the solution you'd like

In order to reduce the number of manual tasks this should be added as a github pipeline to be run every time a new tag is created.

Describe alternatives you've considered

In addition to releasing on PyPi the package would ideally be released in several other locations as well:

• brew package (mac)
• chocolaty (windows)
• apt (debian / its derivitives)
• aur (arch / its derivitives)
• dnf (fedora)
• archive through a github release version

please add the location of the configuration file to the output from "scioer status". Would really help with debugging.

Remove the test commands from the application.

I made a mistake and published the package to sci-oer instead of scioer. Because the names are so similar it can not be redeployed again with the other name.

The contents of the config file that is being uses is supposed to be printed in the info log but it looks like the dictionary is being printed wrong.

The ports mappings that get forwarded to the container should should be specified in the config file.

ie:

ports:
  - 'host:container'
  - ....

random_ports: False

The default behaviour should be:

- '3000:3000' # wiki
- '8888:8888' # jupyter
- '8000:8000'  # lectues
- '2222:22' #ssh

• if random_ports == False then any port not specified in the list must not be passed through
• if random_ports == True and the exposed ports are specified then the specified ports should override the random ports. **
• if random_ports == False and no ports are specified then no ports should be forwarded for the container

** = check how this works in docker

The status / about sub commands should list all the passed through ports.

Test the behaviour if:

• another course is useing the same ports
• another application is using the same ports

Currenly the same error message is shown both if docker is not running and if the user does not have permissions to interact with docker. The 'fix' steps are different and should have different error messages associated with it

Hi there, just wanted to thank you both @MarshallAsch and @judiMc for making this for us in CIS2430! Really appreciate having everything I need in one container that I can start/stop/remove.

I have a suggestion for the scioer python package. It appears that installing python and scioer with pip is bit of a hit-and-miss on different systems. How about instead of instructing students to install python + a pip package, scioer would be distributed as a binary for Windows, Linux, and macOS.

The executables could be built using a user-triggered github workflow with pyinstaller to create a github release, and students could run something like
wget https://github.com/sci-oer/student-cli/releases/latest/download/scioer && mv scioer /usr/bin (C:\Windows\System32 for windows users). The idea would be to avoid having to install/upgrade python or dealing with pip.

start by default will build a new container but if it was not removed then it will fail to start because the name is already in use.

Describe the solution you'd like

Having to always specify a number of cli flags is very annoying, tedious, and it is easy to forget one and that can lead to issues.
To resolve this I propose adding support for configuration options that can be loaded from config files.

See: tiangolo/typer#86 and phha/click_config_file for some potential ideas on how to make that work by out of the box with Typer.

This should do the following:

1. Load from the config file by default, the file should not have to be specified for it to be used
2. The config file should be located in a well known location (such as ~/.myConfig or ~/.config/myApp/config)
3. The cli flags should over ride any options specified in the config file
4. A different config file should be specifiable
5. An option to ignore the config file should be included
6. An option to verify an existing config file should be included

when running a shell it says the username is I dont have a name

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

lets not make it pull by default as students may not be on an internet connection that supports a pull.

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

should print the version with the -v and --version flags

Is your feature request related to a problem? Please describe.

When installing the scioer student-cli some Windows 11 users were having issues when the student-cli was trying to create the folder in their Desktop. The issues were mostly related to permission as Windows 11 Desktop folder seems to be very connected to OneDrive (Win 11 may have two Desktop folders - 1 for OneDrive and 1 for local but I am not too sure). For some users, the student-cli was able to create the folder but it was never accessible through their Desktop folder but the user was able to cd into it and find the folder.

Describe the solution you'd like

The default path (which is the user's Desktop folder) may need to be changed to fix this. Even the Documents folder may not work as that it also connected to OneDrive

Describe alternatives you've considered
N/A

Additional context

Unfortunately, I do not have screenshots today but I will give the student cli a try on a Win 11 machine and post here

Describe the bug
Upon running 'scioer start', cannot access front-end as the browser states that the connection was reset. Inspecting docker logs for the container reveals that there were permission issues with creating the required file structure. Turns out that the course folder was created with user/group ownership as root/root. Upon changing the user to logan, front-end became accessible. How can we avoid having to change permissions manually?

To Reproduce
Steps to reproduce the behavior:

1. scioer config
2. scioer start
3. ls -la in the folder directory

Expected behavior
Front-end should be accessible immediately after running scioer start

Screenshots
What I saw after running scioer start the first time:

Checking docker logs:

Checking folder permissions:

After running sudo chown logan CIS2430:

Desktop (please complete the following information):

• OS: Ubuntu 22.04.3 LTS x86_64
• Browser: Firefox

the help command should include basic usage that the students will probably want

The message after scioer start is uninformative. Perhaps it could print out the login info for the wiki as students will need that and maybe the commands to start, stop, and shell so that students know what to do next?

Is your feature request related to a problem? Please describe.

The basic start command should wrap the docker run -d .... command to start the course specific educational resource.

The initial implementation does not need to accept any cli flags, only the name of the container that should be started.

The persistent storage location should be under ~/.local/share/sci-student (to later follow the $XDG_DATA_HOME spec) under *nix systems and FOLDERID_LocalAppData on windows.

See dirs-dev/directories-rs for some more information.

Describe the solution you'd like

• The container should be started in detached mode
• The /course volume should be mounted
• The 'default' ports should be exposed (pass through)
• Should check if the ports are in use before starting the container
• Should check if the container is already running before starting

Additional context
Docker needs to be installed and running before this is started.

Is your feature request related to a problem? Please describe.

To prevent issues trying to use the script it should first check to ensure that docker is installed, is running, and the current user has permissions to interact with the docker daemon.
This should also provide detailed error messages that provide clear instructions on how to fix the issues.

Describe alternatives you've considered

The check for docker being installed should also be apart of the pip install script.

The unit installed is sci-oer but the unit that must be run is scioer. Can we pick one?

When there is an unkown docker error it just prints unknown error and does not print the message from the error without the debug level log.

If I issue a 'scioer start' command and the pull flag is enabled the only output is the word 'pull'. that is not informative. Should be at least a sentence that indicates it is pulling the latest version from the internet and that it might take a while. In the best of all possible worlds it would update with a progress bar.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• chore(deps): update dependency pyparsing to v3.1.2
• chore(deps): update dependency pyyaml to v6.0.2
• chore(deps): update dependency attrs to v23.2.0
• chore(deps): update dependency colorlog to v6.8.2
• chore(deps): update dependency pathspec to v0.12.1
• chore(deps): update dependency typer to v0.12.3
• chore(deps): update heinrichreimer/github-changelog-generator-action action to v2.4
• chore(deps): update pypa/gh-action-pypi-publish action to v1.9.0
• chore(deps): update actions/cache action to v4
• chore(deps): update actions/setup-python action to v5
• chore(deps): update dependency attrs to v24
• chore(deps): update dependency docker to v7
• chore(deps): update dependency packaging to v24
• chore(deps): update dependency platformdirs to v4
• chore(deps): update dependency pytest to v8
• chore(deps): update dependency pytype to v2024
• chore(deps): update release-drafter/release-drafter action to v6
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency black to v24 [security]
• chore(deps): update dependency setuptools to v70 [security]
• chore(deps): update dependency pytest to v7.4.4
• chore(deps): update dependency shellingham to v1.5.4
• chore(deps): update dependency packaging to v23.2
• chore(deps): update dependency platformdirs to v3.11.0
• chore(deps): update dependency pluggy to v1.5.0
• chore(deps): update dependency pytype to v2023.12.18
• chore(deps): update dependency rich to v13.7.1
• chore(deps): update dependency typing_extensions to v4.12.2
• chore(deps): update dependency wheel to v0.44.0
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Is your feature request related to a problem? Please describe.

The cli is meant to be be invoked multiple separate times to interact with the same docker resource.
A feature should be added so that the cli application will save some information about the docker containers it has started to a semi-persistent location (such as /.localor/.cache` where it can persist while the machine is running but not between reboots).

Describe the solution you'd like

This file should track information such as:

• human friendly name to reference the container through cli invocations
• the real docker container name
• persistent file paths
• forwarded port numbers
• the real image that is being run

Describe alternatives you've considered

Instead of keeping track this information it could be dynamically obtained by invoking docker commands

make sure tilde gets expanded in the file paths

• for config file path
• for storage paths

Describe the solution you'd like

In order to reduce the number of manual tasks this should be added as a github pipeline to be run every time a new tag is created.

Describe alternatives you've considered

In addition to releasing on PyPi the package would ideally be released in several other locations as well:

• `pypi #1
• chocolaty (windows)
• apt (debian / its derivitives)
• aur (arch / its derivitives)
• dnf (fedora)
• archive through a github release version