RProj

A simple project management tool because I have a ton of folders of code and need a way to open them fast.

---

Features

• Keep track of your projects
• Open projects quickly in VSC or file explorer - just type the name
• Open a terminal for your project fast
• Run code for your projects easily

Installation

Prerequisites:

• Python (last tested with version 3.12.4)
• Pip or Pipx
• Git

With pipx

1. Install using:

   pipx install git+https://github.com/jadenlabs/rproj.git

   or, to get a specific release:

   pipx install https://github.com/JadenLabs/rproj/archive/refs/tags/{release}.zip
   pipx install https://github.com/JadenLabs/rproj/archive/refs/tags/v0.2.7.zip

With pip

1. Clone this repo:

   git clone https://github.com/JadenLabs/rproj.git

2. CD into the new directory:

   cd rproj

3. Install rproj using pip or pipx

   pip install .

Usage

Commands:

• create (c, make): Create a new project

  rproj create NAME ./DIR
  rproj create NAME ./DIR --description a pretty cool project
  rproj create NAME ./DIR --github "https://github.com/example/example"
  rproj create NAME ./DIR --run "python main.py"

• add (a): Add an existing project file

  rproj add ./DIR

• update (u): Update info on a project

  rproj update NAME --project_name PROJECT_NAME
  rproj update NAME --github GITHUB
  rproj update NAME --run RUN
  rproj update NAME --description ...

• delete (d, del, rm, remove): Delete a project

  rproj delete NAME

• list (l, li, all): List all projects

  rproj list

• search (s, find, fetch): Search for a project

  rproj search NAME

• code (vsc): Open project in VSC

  rproj code NAME

• file (explorer): Open project in file explorer

  rproj file NAME

• dir: Print the project's directory

  rproj dir NAME

• terminal (ter): Open a terminal of the project

  rproj terminal NAME
  rproj terminal NAME -t powershell
  rproj terminal NAME -type powershell

• run (r): Run the run_cmd attribute of the project in a new terminal

  rproj run NAME
  rproj run NAME -t powershell

• tree (tr): Print the file structure of the project

  rproj tree NAME
  rproj tree NAME --ignore file.txt

Contributing

Please open an issue for any feature requests or bug reports. Alternatively, message @roc.py on Discord.

If there is an open issue that you'd like to work on, feel free to fork the repo and make a PR when you're done.

Guidelines:

• Use the Conventional Commits commit style.
• Use the Black formatter for Python.
• Do not push code that you do not have the rights to.
• Do not push code that has primarily been generated by a llm, using it to debug is fine.

License

This project is licensed under the MIT License - pretty much meaning, you can do almost whatever you want as long as you keep the original copyright in the code. This software doesn't come with a warrenty for anything bad happening.

A better explaination: here