Skip to content

Latest commit

 

History

History
104 lines (71 loc) · 2.39 KB

README.md

File metadata and controls

104 lines (71 loc) · 2.39 KB
Raw

gropen

PyPI Maintainability

gropen (Git Remote Open) is a simple command line application for opening local files and directories in remote git repositories.

gropen_example

Supported repos

  • Bitbucket
  • GitHub
  • GitLab

Supported editors

Supported systems

  • Linux
  • macOS
  • Windows

Installation

pip install gropen

NOTE: gropen requires Python 3.6 or greater installed on your local environment.

Usage

Here are some example of what gropen can open on your project's remote repo.

Open current directory:

gropen .

Open another directory:

gropen gropen/

Open a file:

gropen gropen/gropen.py

Open a file pointing out the lines of code to be highlighted:

gropen gropen/gropen.py:42
gropen gropen/gropen.py:16,32

Open file from an outter directory:

cd ~/Dev
gropen python/gropen/gropen/gropen.py:20,30

Open file from an inner directory:

cd ~/Dev/python/gropen/gropen
gropen gropen.py:20,30

TODO

  • Add support for GitHub repositories;
  • Add support for Bitbucket repositories;
  • Add support for GitLab repositories;
  • Open current directory;
  • Open arbitrary directory and files;
  • Open in a line or range of lines in the file;
  • Open files in a specific commit;
  • Handle relative and absolute paths;
  • Support flag for only displaying the URL instead of opening it in the browser;
  • Create Vim plugin;
  • Create VS Code plugin;
  • Create Sublime plugin.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/tiagopog/gropen/. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

This package is available as open source under the terms of the MIT License.