Metadata-Version: 2.1
Name: gropen
Version: 0.1.0
Summary: CLI for opening local files on browsers based on a remote git repository
Home-page: https://github.com/tiagopog/gropen/
Author: Tiago Guedes
Author-email: tiagopog@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/tiagopog/gropen/issues
Description: # gropen
        
        `gropen` (Git Remote Open) is a simple command line application for opening
        local files and directories on remote git repositories.
        
        Current support:
        
        - [x] GitHub;
        - [x] Bitbucket;
        - [ ] GitLab.
        
        # Installation
        
        ```
        pip install gropen
        ```
        
        **NOTE:** `gropen` requires Python 3.6 or greater to be 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
        ```
        
        # TODO
        
        - [x] Add support for remote repos on GitHub;
        - [x] Add support for remote repos on Bitbucket;
        - [ ] Add support for remote repos on GitLab;
        - [x] Open current directory;
        - [x] Open arbitrary directory and files;
        - [x] Point out the line(s) of code to be highlighted;
        - [ ] Handle relative paths;
        - [ ] 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/](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](https://www.contributor-covenant.org/) code of conduct.
        
        # License
        
        This package is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/markdown
