Skip to content

Commit

Permalink
add env docs
Browse files Browse the repository at this point in the history
  • Loading branch information
snehalbaghel committed Apr 24, 2021
1 parent 0f45012 commit 48e3bf0
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/source/badgrclient.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ BadgrClient is the class that is responsible for authentication and calling of t
has some fetcher functions and some operations that dont fall spcifically under any 'Badgr Model'. For other
operations you will have to use the Badgr Models (Asserstion, BadgeClass, Issuer).

.. note::
Keep in mind that the models can't do anything on their own so they still need to be passed a client instance to do it's job.
You can init badgrclient by either providing credentials to its constructor or setting a .env file with
``BADGR_USERNAME`` and ``BADGR_PASSWORD``


.. toctree::
:maxdepth: 4
Expand Down

0 comments on commit 48e3bf0

Please sign in to comment.