Metadata-Version: 2.1
Name: gitinfo
Version: 1.0.2
Summary: Quickly get information about a Github repository
Home-page: UNKNOWN
Author: Folke Ishii
Author-email: folke.ishii@gmail.com
License: MIT
Platform: UNKNOWN
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# gitinfo
Quickly get information about a Github repository

## Installation
`pip install gitinfo`

## Usage

```
Usage: gitinfo [OPTIONS] URL_OR_REPO_PATH

  Displays information on a Github repository.

  URL_OR_REPO_PATH must be either some form of Github Url or path starting
  with username and repo such as `user/repo/whatever`.

Options:
  --set-token                Sets `url` to personal access token.
  -l, --long                 View more information.
  -L, --lang                 Show all languages of repo.
  -f, --file-tree            Display files in a tree.
  -p, --path TEXT            Set starting path for file tree relative to root
                             (Github repo).  [default: ]

  -d, --depth INTEGER RANGE  Depth to traverse file tree.  [default: 1]
  -b, --branch TEXT          Enter branch name or commit hash to view files
                             from that specific branch/commit.  [default:
                             master]

  --help                     Show this message and exit.
```

## Examples:

### Quick overview of a repository
`gitinfo https://github.com/microsoft/vscode`

result:
```
                         microsoft/vscode - Ratelimit: 4941
â•­â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â•®
â”‚ Owner    - microsoft     Disk usage - 366.69 MB    Created at  - 5 Years ago     â”‚
â”‚ URL      - Link          Stars      - 116795       Updated at  - 54 Minutes ago  â”‚
â”‚ License  - MIT           Forks      - 19071        Pushed at   - 20 Minutes ago  â”‚
â”‚ Language - TypeScript    Watchers   - 3125         Open issues - 5337            â”‚
â•°â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â•¯
```

### More detailed view:
`gitinfo microsoft/terminal -l`

```
                                    microsoft/terminal - Ratelimit: 4998
â•­â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â•®
â”‚ Owner          - microsoft                       Created at     - 3 Years ago       Is archived - False  â”‚
â”‚ URL            - Link                            Updated at     - 49 Minutes ago    Is disabled - False  â”‚
â”‚ License        - MIT                             Pushed at      - 4 Hours ago       Is fork     - False  â”‚
â”‚ Latest Release - Windows Terminal v1.8.1444.0    Disk usage     - 92.08 MB          Is in org.  - True   â”‚
â”‚ Forks          - 6702                            Watchers       - 1313              Is locked   - False  â”‚
â”‚ Star count     - 74816                           Open Issues    - 1288              Is mirror   - False  â”‚
â”‚ Commit count   - 2274                            Closed Issues  - 6681              Is private  - False  â”‚
â”‚ Open p.r.      - 51                              Closed p.r.    - 260               Merged p.r. - 1973   â”‚
â•°â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â•¯
```

### Language breakdown
`gitinfo https://github.com/torvalds/linux.git -L`

```
             torvalds/linux - Ratelimit: 4996
â•­â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â•®
â”‚ C - 98.15%            Assembly - 0.98%   Shell - 0.3%   â”‚
â”‚ Makefile - 0.23%      Perl - 0.12%       Python - 0.12% â”‚
â”‚ C++ - 0.02%           Roff - 0.02%       SmPL - 0.02%   â”‚
â”‚ Yacc - 0.01%          Lex - 0.01%        Awk - 0.0%     â”‚
â”‚ UnrealScript - 0.0%   Gherkin - 0.0%     Raku - 0.0%    â”‚
â”‚ M4 - 0.0%             Clojure - 0.0%     XS - 0.0%      â”‚
â”‚ sed - 0.0%                                              â”‚
â•°â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â•¯
```

### Simple file tree query
`gitinfo secozzi/gitinfo/useless_path/2 -f`

```
./
â”œâ”€â”€ gitinfo/
â”œâ”€â”€ .gitignore (1.76 KB)
â”œâ”€â”€ LICENSE (1.04 KB)
â”œâ”€â”€ README.md (75 bytes)
â•°â”€â”€ setup.py (309 bytes)
```

### Advanced file tree query
`gitinfo sympy/sympy -f --branch 1.7 --path sympy/integrals --depth 4`

```
./sympy/integrals/
â”œâ”€â”€ benchmarks/
â”‚   â”œâ”€â”€ __init__.py (0 bytes)
â”‚   â”œâ”€â”€ bench_integrate.py (295 bytes)
â”‚   â•°â”€â”€ bench_trigintegrate.py (241 bytes)
â”œâ”€â”€ rubi/
â”‚   â”œâ”€â”€ parsetools/
â”‚   â”‚   â”œâ”€â”€ tests/
â”‚   â”‚   â”‚   â”œâ”€â”€ __init__.py (0 bytes)
â”‚   â”‚   â”‚   â•°â”€â”€ test_parse.py (8.02 KB)
â”‚   â”‚   â”œâ”€â”€ __init__.py (0 bytes)
â”‚   â”‚   â”œâ”€â”€ generate_rules.py (2.77 KB)
â”‚   â”‚   â”œâ”€â”€ generate_tests.py (2.64 KB)
â”‚   â”‚   â”œâ”€â”€ header.py.txt (9.15 KB)
â”‚   â”‚   â•°â”€â”€ parse.py (26.99 KB)
â”‚   â”œâ”€â”€ rubi_tests/
â”‚   â”‚   â”œâ”€â”€ tests/
â”‚   â”‚   â”‚   â”œâ”€â”€ __init__.py (0 bytes)
â”‚   â”‚   â”‚   â”œâ”€â”€ test_1_2.py (29.71 KB)
â”‚   â”‚   â”‚   â”œâ”€â”€ test_1_3.py (59.75 KB)
â”‚   â”‚   â”‚   â”œâ”€â”€ test_1_4.py (10.18 KB)
â”‚   â”‚   â”‚   â”œâ”€â”€ test_exponential.py (245.08 KB)
â”‚   â”‚   â”‚   â”œâ”€â”€ test_hyperbolic_sine.py (77.69 KB)
â”‚   â”‚   â”‚   â”œâ”€â”€ test_inverse_hyperbolic_sine.py (63.64 KB)
â”‚   â”‚   â”‚   â”œâ”€â”€ test_inverse_sine.py (82.23 KB)
â”‚   â”‚   â”‚   â”œâ”€â”€ test_logarithms.py (431.76 KB)
â”‚   â”‚   â”‚   â”œâ”€â”€ test_miscellaneous_algebra.py (513.84 KB)
â”‚   â”‚   â”‚   â”œâ”€â”€ test_secant.py (91.21 KB)
â”‚   â”‚   â”‚   â”œâ”€â”€ test_sine.py (160.52 KB)
â”‚   â”‚   â”‚   â”œâ”€â”€ test_special_functions.py (47.21 KB)
â”‚   â”‚   â”‚   â”œâ”€â”€ test_tangent.py (129.27 KB)
â”‚   â”‚   â”‚   â•°â”€â”€ test_trinomials.py (1.44 MB)
â”‚   â”‚   â•°â”€â”€ __init__.py (293 bytes)
â”‚   â”œâ”€â”€ rules/
â”‚   â”‚   â”œâ”€â”€ __init__.py (0 bytes)
â”‚   â”‚   â”œâ”€â”€ binomial_products.py (194.5 KB)
â”‚   â”‚   â”œâ”€â”€ exponential.py (61.4 KB)
â”‚   â”‚   â”œâ”€â”€ hyperbolic.py (212.89 KB)
â”‚   â”‚   â”œâ”€â”€ integrand_simplification.py (22.64 KB)
â”‚   â”‚   â”œâ”€â”€ inverse_hyperbolic.py (342.67 KB)
â”‚   â”‚   â”œâ”€â”€ inverse_trig.py (309.75 KB)
â”‚   â”‚   â”œâ”€â”€ linear_products.py (89.41 KB)
â”‚   â”‚   â”œâ”€â”€ logarithms.py (95.54 KB)
â”‚   â”‚   â”œâ”€â”€ miscellaneous_algebraic.py (227.17 KB)
â”‚   â”‚   â”œâ”€â”€ miscellaneous_integration.py (49.38 KB)
â”‚   â”‚   â”œâ”€â”€ miscellaneous_trig.py (184.83 KB)
â”‚   â”‚   â”œâ”€â”€ piecewise_linear.py (19.43 KB)
â”‚   â”‚   â”œâ”€â”€ quadratic_products.py (309.78 KB)
â”‚   â”‚   â”œâ”€â”€ secant.py (440.04 KB)
â”‚   â”‚   â”œâ”€â”€ sine.py (716.0 KB)
â”‚   â”‚   â”œâ”€â”€ special_functions.py (87.32 KB)
â”‚   â”‚   â”œâ”€â”€ tangent.py (306.98 KB)
â”‚   â”‚   â•°â”€â”€ trinomial_products.py (236.89 KB)
â”‚   â”œâ”€â”€ tests/
â”‚   â”‚   â”œâ”€â”€ __init__.py (0 bytes)
â”‚   â”‚   â”œâ”€â”€ test_rubi_integrate.py (2.62 KB)
â”‚   â”‚   â•°â”€â”€ test_utility_function.py (79.7 KB)
â”‚   â”œâ”€â”€ __init__.py (3.38 KB)
â”‚   â”œâ”€â”€ constraints.py (288.21 KB)
â”‚   â”œâ”€â”€ rubimain.py (7.91 KB)
â”‚   â”œâ”€â”€ symbol.py (1.56 KB)
â”‚   â•°â”€â”€ utility_function.py (262.95 KB)
â”œâ”€â”€ tests/
â”‚   â”œâ”€â”€ __init__.py (0 bytes)
â”‚   â”œâ”€â”€ test_deltafunctions.py (3.41 KB)
â”‚   â”œâ”€â”€ test_failing_integrals.py (6.7 KB)
â”‚   â”œâ”€â”€ test_heurisch.py (10.96 KB)
â”‚   â”œâ”€â”€ test_integrals.py (61.09 KB)
â”‚   â”œâ”€â”€ test_intpoly.py (35.32 KB)
â”‚   â”œâ”€â”€ test_lineintegrals.py (235 bytes)
â”‚   â”œâ”€â”€ test_manual.py (25.3 KB)
â”‚   â”œâ”€â”€ test_meijerint.py (29.49 KB)
â”‚   â”œâ”€â”€ test_prde.py (15.56 KB)
â”‚   â”œâ”€â”€ test_quadrature.py (19.45 KB)
â”‚   â”œâ”€â”€ test_rationaltools.py (4.86 KB)
â”‚   â”œâ”€â”€ test_rde.py (9.27 KB)
â”‚   â”œâ”€â”€ test_risch.py (36.37 KB)
â”‚   â”œâ”€â”€ test_singularityfunctions.py (1.14 KB)
â”‚   â”œâ”€â”€ test_transforms.py (34.6 KB)
â”‚   â•°â”€â”€ test_trigonometry.py (3.78 KB)
â”œâ”€â”€ __init__.py (1.8 KB)
â”œâ”€â”€ deltafunctions.py (7.18 KB)
â”œâ”€â”€ heurisch.py (24.69 KB)
â”œâ”€â”€ integrals.py (62.55 KB)
â”œâ”€â”€ intpoly.py (41.56 KB)
â”œâ”€â”€ manualintegrate.py (61.75 KB)
â”œâ”€â”€ meijerint.py (76.11 KB)
â”œâ”€â”€ meijerint_doc.py (1.0 KB)
â”œâ”€â”€ prde.py (50.01 KB)
â”œâ”€â”€ quadrature.py (16.26 KB)
â”œâ”€â”€ rationaltools.py (10.15 KB)
â”œâ”€â”€ rde.py (26.04 KB)
â”œâ”€â”€ risch.py (64.95 KB)
â”œâ”€â”€ singularityfunctions.py (2.24 KB)
â”œâ”€â”€ transforms.py (61.87 KB)
â•°â”€â”€ trigonometry.py (10.79 KB)
```

