Metadata-Version: 2.0
Name: st-package-reviewer
Version: 0.2.1
Summary: Review Sublime Text packages
Home-page: https://github.com/packagecontrol/st_package_reviewer
Author: FichteFoll
Author-email: fichtefoll2@googlemail.com
License: MIT
Keywords: sublime text,review,
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: github3.py (>=1.0.0a4)
Requires-Dist: pyperclip

# package_reviewer

A tool to review packages for [Sublime Text 3][]
(and its package manager [Package Control][]).
Supports passing local file paths
or URLs to GitHub repositories.

This README focuses on installation and usage of the tool.
For how to *resolve* failures or warnings
reported by the tool,
[refer to the wiki][wiki].

Sublime Text 2 has essentially been deprecated
a long time ago,
which is why it is not considered.


## Installation

Requires **Python 3.4** or higher.

```bash
$ pip install st_package_reviewer
```


## Usage

```
usage: st_package_reviewer [-h] [--clip] [--repo-only] [-w] [-v] [--debug]
                           [path_or_URL [path_or_URL ...]]

Check a Sublime Text package for common errors.

positional arguments:
  path_or_URL           URL to the repository or path to the package to be checked. If not provided, runs in interactive mode.

optional arguments:
  -h, --help            show this help message and exit
  --clip                Copy report to clipboard.
  --repo-only           Do not check the package itself and only its repository.
  -w, --fail-on-warnings
                        Return a non-zero exit code for warnings as well.
  -v, --verbose         Increase verbosity.
  --debug               Enter pdb on exceptions. Implies --verbose.

Return values:
    0: No errors
    -1: Invalid command line arguments

Additional return values in non-interactive mode (a combination of bit flags):
    1: Package check finished with failures
    2: Repository check finished with failures
    4: Unable to download repository

Interactive mode:
    Enter package paths or repository URLS continuously.
    Type `c` to copy the last report to your clipboard.

```


[Sublime Text 3]: https://sublimetext.com/
[Package Control]: https://packagecontrol.io/
[wiki]: https://github.com/packagecontrol/st_package_reviewer/wiki


