Flask Blueprints + Dependency Injector Example

This is a Flask Blueprints + Dependency Injector example application.

The example application helps to search for repositories on the Github.

Run

Create virtual environment:

virtualenv venv
. venv/bin/activate

Install requirements:

pip install -r requirements.txt

To run the application do:

export FLASK_APP=githubnavigator.application
export FLASK_ENV=development
flask run

The output should be something like:

* Serving Flask app "githubnavigator.application" (lazy loading)
* Environment: development
* Debug mode: on
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
* Restarting with fsevents reloader
* Debugger is active!
* Debugger PIN: 473-587-859

After that visit http://127.0.0.1:5000/ in your browser.

Note

Github has a rate limit. When the rate limit is exceed you will see an exception github.GithubException.RateLimitExceededException. For unauthenticated requests, the rate limit allows for up to 60 requests per hour. To extend the limit to 5000 requests per hour you need to set personal access token.

It's easy:

• Follow this guide to create a token.
• Set a token to the environment variable:

export GITHUB_TOKEN=<your token>

• Restart the app with flask run

Read more on Github rate limit

Test

This application comes with the unit tests.

To run the tests do:

py.test githubnavigator/tests.py --cov=githubnavigator

The output should be something like:

platform linux -- Python 3.12.3, pytest-8.3.2, pluggy-1.5.0
plugins: cov-6.0.0, flask-1.3.0
asyncio: mode=Mode.STRICT, default_loop_scope=None
collected 2 items

githubnavigator/tests.py ..                                     [100%]

---------- coverage: platform darwin, python 3.10.0-final-0 ----------
Name                                     Stmts   Miss  Cover
------------------------------------------------------------
githubnavigator/__init__.py                  0      0   100%
githubnavigator/application.py              13      0   100%
githubnavigator/blueprints/__init__.py       0      0   100%
githubnavigator/blueprints/example.py       12      0   100%
githubnavigator/containers.py                8      0   100%
githubnavigator/services.py                 14      0   100%
githubnavigator/tests.py                    34      0   100%
------------------------------------------------------------
TOTAL                                       81      0   100%