Metadata-Version: 2.1
Name: git-browse-remote
Version: 0.1.0
Summary: 
License: CC0
Author: nonylene
Author-email: nonylene@gmail.com
Requires-Python: >=3.12,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: click (>=8.1.7,<9.0.0)
Requires-Dist: pygit2 (>=1.15.1,<2.0.0)
Description-Content-Type: text/markdown

# git-browse-remote

Browse the GitHub repository with the browser from CLI

This module is inpired by [git-browse-remote](https://github.com/motemen/git-browse-remote) gem but has limited features, which I use on daily, than the gem.

## Supported environments

- Python >= 3.12
- GitHub (and repositories that have compatible URL structure with GitHub, e.g. GitHub enterprise)

This tool executes `$ git web--remote` to open a URL. To change the browser to be used, see [git-web--browse documentation](https://git-scm.com/docs/git-web--browse).

## Usage

### Open the PR url for the current branch

```
$ git browse-remote -p # e.g. https://github.com/nonylene/git-browse-remote/pull/{current_branch}
```


### Open the blob/tree url for the path of the current branch

```
$ git browse-remote {path} # e.g. https://github.com/nonylene/git-browse-remote/tree/{current_branch}/{path}
```


## Development

```
# Install dependencies
$ poetry install
# Run
$ poetry run git-browse-remote --help
# Test
$ poetry run python3 -m unittest
# Coverage
$ poetry run coverage run -m unittest
$ poetry run coverage report -m
```

### Release

- Bump up version in pyproject.toml
- `git tag v{version}`

