Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding Codacy and CodeClimate badges #22

Merged
merged 5 commits into from
Aug 5, 2015
Merged

Adding Codacy and CodeClimate badges #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
36b2c00
Add Codeclimate and Codacy badge placeholders
kaidokert Jul 21, 2015
894f23b
Fix up badge svg style to align with the rest
kaidokert Jul 21, 2015
95d3c19
Add note about fixing up Codacy badge after importing
kaidokert Jul 21, 2015
a444543
Fix tabs/spaces
kaidokert Jul 21, 2015
3e23954
Merge
kaidokert Aug 3, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,20 @@ You will be asked for these fields:
"no"
- Add a Scrutinizer_ badge in ``README.rst``.

* - ``cookiecutter.codacy``
- .. code:: python

"no"
- Add a Codacy_ badge in ``README.rst``.

**Note:** After importing the project in Codacy, find the hexadecimal project ID from settings and replace it in badge URL

* - ``cookiecutter.codeclimate``
- .. code:: python

"no"
- Add a CodeClimate_ badge in ``README.rst``.

* - ``sphinx_theme``
- .. code:: python

Expand Down Expand Up @@ -299,3 +313,5 @@ If you have criticism or suggestions please open up an Issue or Pull Request.
.. _Codecov: http://codecov.io/
.. _Landscape: https://landscape.io/
.. _Scrutinizer: https://scrutinizer-ci.com/
.. _Codacy: https://codacy.com/
.. _CodeClimate: https://codeclimate.com/
2 changes: 2 additions & 0 deletions cookiecutter.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,7 @@
"codecov": "yes",
"landscape": "no",
"scrutinizer": "no",
"codacy" : "no",
"codeclimate" : "no",
"sphinx_theme": "readthedocs"
}
12 changes: 12 additions & 0 deletions {{cookiecutter.repo_name}}/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
{%- if cookiecutter.codecov|lower == 'yes' %} |codecov|{% endif -%}
{%- if cookiecutter.landscape|lower == 'yes' %} |landscape|{% endif -%}
{%- if cookiecutter.scrutinizer|lower == 'yes' %} |scrutinizer|{% endif -%}
{%- if cookiecutter.codacy|lower == 'yes' %} |codacy|{% endif -%}
{%- if cookiecutter.codeclimate|lower == 'yes' %} |codeclimate|{% endif -%}
{{ '' }}
* - package
- |version| |downloads|
Expand Down Expand Up @@ -43,6 +45,16 @@
:target: https://landscape.io/github/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}/master
:alt: Code Quality Status
{% endif %}
{% if cookiecutter.codacy|lower == 'yes' %}
.. |codacy| image:: https://img.shields.io/codacy/REPLACE_WITH_PROJECT_ID.svg?style=flat&label=Codacy
:target: https://www.codacy.com/app/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}
:alt: Codacy Code Quality Status
{% endif %}
{% if cookiecutter.codeclimate|lower == 'yes' %}
.. |codeclimate| image:: https://img.shields.io/codeclimate/github/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}.svg?style=flat&label=CodeClimate
:target: https://codeclimate.com/github/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}
:alt: CodeClimate Quality Status
{% endif %}
.. |version| image:: http://img.shields.io/pypi/v/{{ cookiecutter.distribution_name }}.svg?style=flat
:alt: PyPI Package latest release
:target: https://pypi.python.org/pypi/{{ cookiecutter.distribution_name }}
Expand Down