https://github.com/sloev/ghlint
Linting utility for GitHub
https://github.com/sloev/ghlint
Last synced: 21 days ago
JSON representation
Linting utility for GitHub
- Host: GitHub
- URL: https://github.com/sloev/ghlint
- Owner: sloev
- License: mit
- Created: 2017-09-22T09:15:50.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-20T20:46:35.000Z (almost 9 years ago)
- Last Synced: 2025-03-09T22:45:42.076Z (over 1 year ago)
- Language: Python
- Homepage: https://ghlint.org
- Size: 119 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
ghlint
======
|build| |pypi|
Linting utility for GitHub.
Getting Started
---------------
Set the environment variables ``GITHUB_USERNAME`` and ``GITHUB_PASSWORD`` to your GitHub credentials. Alternatively, configure your username and `access token `_ in the ``[SETTINGS]`` section of the ``.ghlintrc`` file:
.. code-block::
[SETTINGS]
# GitHub username
username=YOUR_USERNAME
# GitHub password or personal access token
password=YOUR_PASSWORD
Run
---
.. code-block:: sh
pip install -r requirements.txt
python ghlint
or
.. code-block:: sh
pip install .
ghlint
Tooling
-------
Using `pyenv `_ to switch between multiple versions of Python:
.. code-block:: sh
pyenv versions
pyenv global 3.6.1
.. |build| image:: https://img.shields.io/travis/martinbuberl/ghlint/master.svg
:target: https://travis-ci.org/martinbuberl/ghlint
.. |pypi| image:: https://img.shields.io/pypi/v/ghlint.svg
:target: https://pypi.python.org/pypi/ghlint