Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Install wis2box on host with pipx #608

Open
6 tasks
isedwards opened this issue Dec 29, 2023 · 1 comment
Open
6 tasks

Install wis2box on host with pipx #608

isedwards opened this issue Dec 29, 2023 · 1 comment
Assignees

Comments

@isedwards
Copy link
Member

Background

I saw that cookiecutter recently switched to using pipx.

pipx installs and runs Python applications (CLIs) in isolated environments so that they are available as tools on the command line, but cannot be imported from system Python. This would also allow a few, small, additional dependencies to be installed that would not interfere in any way with the user's system.

Additionally, could the wis2box-create-config.py, wis2box-ctl and wis2box tools be combined into a single wis2box CLI tool that behaves appropriately depending on the context it is called from?

User story

  • As the project maintainer, I don't want wis2box-ctl to install additional dependencies on the host machine that may cause conflicts with other software.
  • As a user, I want wis2box-ctl to be available on the host machine without having to type python3 in front.
  • As a developer, I want to be able to make use of a small number dependencies as part of wis2box-ctl to make it easier to develop and maintain the software

Acceptance criteria

  • Users can install using pipx install wis2box instead of ...
    wget https://github.com/wmo-im/wis2box/releases/download/1.0b6/wis2box-setup-1.0b6.zip
    unzip wis2box-setup-1.0b6.zip
    cd wis2box-1.0b6
    
  • Users can upgrade with pipx upgrade wis2box
  • Users can cleanly uninstall with pipx uninstall wis2box

Definition of done

  • unit/functional tests added/updated
  • documentation updated
  • live demonstration provided
@maaikelimper
Copy link
Collaborator

Assign to Tom for review. Not sure if this is in scope for the current sprint

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants