Skip to main content

Generator a github card for flask web application

Project description

flask-githubcard

A flask's extension to generate a github card for yourself.

Quick Start

pip install flask-githubcard

Step 1: Initial the extension

from flask import Flask
from flask_githubcard import GithubCard
app = Flask(__name__)
githubcard = GithubCard(app)

Step 2: In your <head> section of your base template add the following code:

<head>
    {{githubcard.init_css()}}
    {{githubcard.init_js()}}
</head>

Step 3: Render the github card in your template.

<div>
    {{githubcard.generate_card()}}
</div>

Advanced

Configure yourself github info

from flask import Flask
from flask_githubcard import GithubCard
app = Flask(__name__)

githubcard = GithubCard(app)
app.config['GITHUB_USERNAME'] = 'foo'
app.config['GITHUB_REPO'] = 'foo_repo'

Choose theme

<head>
    {{githubcard.init_css(theme='darkly')}}
</head>
<div>
    {{githubcard.generate_card(theme='darkly')}}
</div>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Flask-Githubcard-1.0.2.tar.gz (202.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

Flask_Githubcard-1.0.2-py2.py3-none-any.whl (204.4 kB view details)

Uploaded Python 2Python 3

File details

Details for the file Flask-Githubcard-1.0.2.tar.gz.

File metadata

  • Download URL: Flask-Githubcard-1.0.2.tar.gz
  • Upload date:
  • Size: 202.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.6.9

File hashes

Hashes for Flask-Githubcard-1.0.2.tar.gz
Algorithm Hash digest
SHA256 004fe9f0cfc4298d5f28531d5ab1e911dbea0088a431ed702ee378df37ba11d2
MD5 df3bddd5958e94f6dfd888fa68386f24
BLAKE2b-256 3a3cf14fa4ee632e7a983c27f89bbc333bddf62cf2ddab31413f5f2445cab6da

See more details on using hashes here.

File details

Details for the file Flask_Githubcard-1.0.2-py2.py3-none-any.whl.

File metadata

  • Download URL: Flask_Githubcard-1.0.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 204.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.6.9

File hashes

Hashes for Flask_Githubcard-1.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3b7e937056c047cdd66c75d6aedbe7250478163f81c2639fb3a178d74009656a
MD5 1f54fbb36a00cc8db4ee48872d1f5782
BLAKE2b-256 6d7e49a4efb215423f96e4be43edccd7c55a98df5548b40eee147d0ef7217339

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page