Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Describe why apikey is needed, where to get them and the format. #321

Merged
merged 3 commits into from
Mar 9, 2021
Merged

Describe why apikey is needed, where to get them and the format. #321

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d404d5a
Describe why apikey is needed, where to get them and the format.
sverhoeven Mar 9, 2021
b29c85c
Update README.rst
sverhoeven Mar 9, 2021
bf0c23f
Update README.rst
sverhoeven Mar 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,23 @@ The manual override will be reflected in the output, as follows:
(5/5) checklist
✓ skipped (reason: I'm using the Codacy dashboard to guide my development)

Rate limit
^^^^^^^^^^

By default ``howfairis`` uses anonymous requests to the API of the source code platforms.
However when a lot of repositories are checked you will exceed the rate limit of those APIs and checks will fail.
To increase the rate limit you need to use authenticated requests.
Your username and token can be passed to ``howfairis`` using environment variables called ``APIKEY_GITHUB`` and ``APIKEY_GITLAB``.
The format of the environment variable values are:

.. code-block:: shell

export APIKEY_GITHUB=<user who made the token>:<personal access token>
export APIKEY_GITLAB=<user who made the token>:<personal access token>

Generation of personal access tokens are explained on `GitHub documentation <https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token>`_ and `GitLab documentation <https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#creating-a-personal-access-token>`_.
No scopes have to be selected, being authenticated is enough to get higher rate limit.

Contributing
------------

Expand Down