Review Sublime Text packages
Project description
# st_package_reviewer
[![Build Status](https://travis-ci.org/packagecontrol/st_package_reviewer.svg?branch=master)](https://travis-ci.org/packagecontrol/st_package_reviewer)
[![Coverage Status](https://coveralls.io/repos/github/packagecontrol/st_package_reviewer/badge.svg?branch=master)](https://coveralls.io/github/packagecontrol/st_package_reviewer?branch=master)
[![PyPI](https://img.shields.io/pypi/v/st-package-reviewer.svg)](https://pypi.python.org/pypi/st-package-reviewer)
[![Python Versions](https://img.shields.io/pypi/pyversions/st-package-reviewer.svg)](https://pypi.python.org/pypi/st-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
[![Build Status](https://travis-ci.org/packagecontrol/st_package_reviewer.svg?branch=master)](https://travis-ci.org/packagecontrol/st_package_reviewer)
[![Coverage Status](https://coveralls.io/repos/github/packagecontrol/st_package_reviewer/badge.svg?branch=master)](https://coveralls.io/github/packagecontrol/st_package_reviewer?branch=master)
[![PyPI](https://img.shields.io/pypi/v/st-package-reviewer.svg)](https://pypi.python.org/pypi/st-package-reviewer)
[![Python Versions](https://img.shields.io/pypi/pyversions/st-package-reviewer.svg)](https://pypi.python.org/pypi/st-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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
st_package_reviewer-0.2.2.tar.gz
(35.3 kB
view hashes)
Built Distribution
Close
Hashes for st_package_reviewer-0.2.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7420ff16a17beeca135f1c8efa9746158dbb4d20b1494885a80b5f5d9d8af2d9 |
|
MD5 | 8c392529cfa0d6d7a81e41ed32d1cab0 |
|
BLAKE2b-256 | 3ad7f8fcb6810a11c73565292de8f43229c1491b653d0541da19099528b2666f |
Close
Hashes for st_package_reviewer-0.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b8158a27a017204e2bd9af07022f7c6ceccd7ce3ec0c724a662360f01a4356e |
|
MD5 | e72e98c9739057cac2fdc6d872760d9b |
|
BLAKE2b-256 | f2b7481a33a81aeaf6a6c28fe7741fa308cc7128c693f926a591f44debd9e3e5 |