<commit_before>========
Cibopath
========

Search Cookiecutters on GitHub.

Usage
-----

.. code-block:: text

	Usage: cibopath [OPTIONS] COMMAND [ARGS]...

	  Cibopath - Search Cookiecutters on GitHub.

	Options:
	  -v, --verbose           Print debug information
	  -c, --config-file PATH  Config file to hold settings
	  -V, --version           Show the version and exit.
	  --help                  Show this message and exit.

	Commands:
	  config
	  search
	  update


License
-------

Distributed under the terms of the `BSD 3-Clause License`_, Cibopath is free and open source software

Code of Conduct
---------------

Everyone interacting in the Cibopath project's codebases, issue trackers, chat
rooms, and mailing lists is expected to follow the `PyPA Code of Conduct`_.

.. _`PyPA Code of Conduct`: https://www.pypa.io/en/latest/code-of-conduct/
.. _`BSD 3-Clause License`: LICENSE
<commit_msg>Write docs for the GitHub token and the config cmd<commit_after>========
Cibopath
========

Search Cookiecutters on GitHub.

Usage
-----

.. code-block:: text

	Usage: cibopath [OPTIONS] COMMAND [ARGS]...

	  Cibopath - Search Cookiecutters on GitHub.

	Options:
	  -v, --verbose           Print debug information
	  -c, --config-file PATH  Config file to hold settings
	  -V, --version           Show the version and exit.
	  --help                  Show this message and exit.

	Commands:
	  config
	  search
	  update

Config
------

First you need to `create a GitHub access token`_ for Cibopath, so it can
authenticate with the `GitHub API v3`_. `GitHub's rate limiting`_ won't allow
more than 60 unauthenticated requests per hour. So yeah, you definitely want to
have a token set up as there are more than 60 featured `Cookiecutter
templates`_.

The Cibopath access token does **NOT** require any `scopes`_. Please stick to
the defaults when creating the token (**Read-only access to public
repositories**).

Now use the CLI to store your credentials in your home directory (default
``~/.cibopathrc``).

.. code-block:: bash

	$ cibopath config github.username <your-username>
	$ cibopath config github.token <your-access-token>

Feel free to view the contents of the config file via:

.. code-block:: bash

    $ cibopath -v config --list


License
-------

Distributed under the terms of the `BSD 3-Clause License`_, Cibopath is free
and open source software

Code of Conduct
---------------

Everyone interacting in the Cibopath project's codebases, issue trackers, chat
rooms, and mailing lists is expected to follow the `PyPA Code of Conduct`_.

.. _`BSD 3-Clause License`: LICENSE
.. _`Cookiecutter templates`: https://github.com/audreyr/cookiecutter#available-cookiecutters
.. _`GitHub API v3`: https://developer.github.com/v3/
.. _`GitHub's rate limiting`: https://developer.github.com/v3/#rate-limiting
.. _`PyPA Code of Conduct`: https://www.pypa.io/en/latest/code-of-conduct/
.. _`create a GitHub access token`: https://help.github.com/articles/creating-an-access-token-for-command-line-use/
.. _`scopes`: https://developer.github.com/v3/oauth/#scopes

{'fraction_non_alphanumeric': 0.1216260162601626, 'fraction_numerical': 0.004227642276422764, 'mean_word_length': 3.0420499342969776, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 7, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '40109', 'n_tokens_mistral': 988, 'n_tokens_neox': 889, 'n_words': 349}