Skip to content
/ ght-pypackage Public template

A GitHub Template for creating a Python Package

License

Notifications You must be signed in to change notification settings

sodre/ght-pypackage

Repository files navigation

{%- import '.github/ght/macros/selected.j2' as selected -%} {% call(license) selected.first(ght.license) -%} {% set is_open_source = license != 'Proprietary' -%} {% for _ in cookiecutter.project_name %}={% endfor %} {{ cookiecutter.project_name }} {% for _ in cookiecutter.project_name %}={% endfor %}

image

{% if is_open_source %} .. image:: https://img.shields.io/codecov/c/gh/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_repo }}?logo=codecov&style=flat-square {%- else %} .. image:: https://codecov.io/gh/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_repo }}/branch/master/graph/badge.svg?token={{ codecov.badge_token }} {%- endif %} :target: https://codecov.io/gh/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_repo }}

image

{% if is_open_source %} .. image:: https://img.shields.io/pypi/v/{{ cookiecutter.project_repo }}?logo=pypi&style=flat-square :target: https://pypi.python.org/pypi/{{ cookiecutter.project_repo }}

Documentation Status

{%- endif %}

{% if cookiecutter.add_pyup_badge == 'y' and false %} .. image:: https://pyup.io/repos/github/{{ cookiecutter.github_username }}/{{ cookiecutter.project_repo }}/shield.svg&style=flat-square :target: https://pyup.io/repos/github/{{ cookiecutter.github_username }}/{{ cookiecutter.project_repo }}/ :alt: Updates {% endif %}

{{ cookiecutter.project_short_description }}

{% if is_open_source %} * Free software: {{ license }} * Documentation: https://{{ cookiecutter.project_repo | replace("_", "-") }}.readthedocs.io. {% endif %}

Features

  • TODO

This package was created with ght-render and the sodre/ght-pypackage project template.

{% endcall %}