Skip to content

mi-erasmusmc/launchPro

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

launchPro

launchPro is a small Python CLI for opening local RStudio projects, optional Shiny project folders, and project GitHub pages from a single command.

Current version: 0.1.1

Requirements

  • Python 3.9 or newer
  • A local project folder containing exactly one .Rproj file
  • Windows, macOS or Linux

Setup

The recommended way to install launchPro is using pipx, which installs the package in an isolated environment and automatically manages your PATH.

Using pipx (Recommended)

git clone https://github.com/mi-erasmusmc/launchPro
cd launchPro
pipx install .

Run the CLI

Show help:

launch --help

Register a project first:

launch register MyProject ~/Documents/my-project - https://github.com/your-org/my-project
launch register MyStudy ~/Documents/my-study ~/Documents/my-study/inst/shiny/App https://github.com/your-org/my-study

Then open the main project folder:

launch MyProject -p

Open the Shiny project and GitHub page:

launch MyStudy -s -g

If no flag is provided, launch opens the main project by default:

launch MyProject

Register a New Project

Add or update a project entry in the app-data projects.json:

launch register MyProject ~/Documents/my-project - https://github.com/your-org/my-project

Use - when the project does not have a Shiny folder. If it does, pass the Shiny directory instead:

launch register MyStudy ~/Documents/my-study ~/Documents/my-study/inst/shiny/App https://github.com/your-org/my-study

Notes

  • Paths may use ~ and environment variables.
  • The CLI fails if a target folder does not exist or contains zero or multiple .Rproj files.
  • On macOS it uses open, on Linux xdg-open, and on Windows the system default file opener.
  • For local development without installing, run ./launch ... from the repository root.

License

This project is licensed under the Apache License 2.0. See LICENSE for the full text.

About

Python CLI for opening local RStudio projects

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages