Skip to content

Commit

Permalink
Fix pypi project details and update badges
Browse files Browse the repository at this point in the history
  • Loading branch information
JrGoodle committed Jun 29, 2020
1 parent a5025c9 commit a0c13d0
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 15 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# `clowder`

[![Documentation Status](https://readthedocs.org/projects/clowder/badge/?version=latest)](http://clowder.readthedocs.io)
[![GitHub Actions Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FJrGoodle%2Fclowder%2Fbadge&style=flat)](https://actions-badge.atrox.dev/JrGoodle/clowder/goto)
[![CircleCI](https://circleci.com/gh/JrGoodle/clowder.svg?style=shield)](https://circleci.com/gh/JrGoodle/clowder)
[![Maintainability](https://api.codeclimate.com/v1/badges/56c92799de08f9ef9258/maintainability)](https://codeclimate.com/github/JrGoodle/clowder/maintainability)
[![codecov](https://codecov.io/gh/JrGoodle/clowder/branch/master/graph/badge.svg)](https://codecov.io/gh/JrGoodle/clowder)
[![Code Climate Maintainability](https://api.codeclimate.com/v1/badges/56c92799de08f9ef9258/maintainability)](https://codeclimate.com/github/JrGoodle/clowder/maintainability)
[![codecov coverage](https://codecov.io/gh/JrGoodle/clowder/branch/master/graph/badge.svg)](https://codecov.io/gh/JrGoodle/clowder)
[![PyPI version](https://badge.fury.io/py/clowder-repo.svg)](https://badge.fury.io/py/clowder-repo)
[![Python version](https://img.shields.io/pypi/pyversions/clowder-repo.svg)](https://pypi.python.org/pypi/clowder-repo)
[![Python versions](https://img.shields.io/pypi/pyversions/clowder-repo.svg)](https://pypi.python.org/pypi/clowder-repo)
[![Requirements Status](https://requires.io/github/JrGoodle/clowder/requirements.svg?branch=master)](https://requires.io/github/JrGoodle/clowder/requirements/?branch=master)
[![Documentation Status](https://readthedocs.org/projects/clowder/badge/?version=latest)](http://clowder.readthedocs.io)

> **clowder** - A group of cats
>
Expand Down
2 changes: 1 addition & 1 deletion docs/clowder-yml-cats.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ defaults:
alias.cat: '!echo "😸"'
```

This example specifies a default `branch` of `trracking_branch` that all projects will inherit. It's also possible to specify a default `tag` or `commit`. The `git`section can contain custom git config entries that will be installed for all projects.
This example specifies a default `branch` of `tracking_branch` that all projects will inherit. It's also possible to specify a default `tag` or `commit`. The `git`section can contain custom git config entries that will be installed for all projects.

```yaml
- name: jrgoodle/mu
Expand Down
2 changes: 1 addition & 1 deletion docs/clowder-yml-forks.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ sources:
protocol: https
```

The`protocol is set specifically to https for repositories where the user may not have the ability to clone via ssh.
The `protocol` is set specifically to `https` for repositories where the user may not have the ability to clone via `ssh`.

```yaml
- name: dropbox/djinni
Expand Down
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
clowder
=======

.. image:: https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FJrGoodle%2Fclowder%2Fbadge&style=flat
:target: https://actions-badge.atrox.dev/JrGoodle/clowder/goto

.. image:: https://circleci.com/gh/JrGoodle/clowder.svg?style=shield
:target: https://circleci.com/gh/JrGoodle/clowder

Expand All @@ -21,9 +24,6 @@ clowder
.. image:: https://img.shields.io/pypi/pyversions/clowder-repo.svg
:target: https://pypi.python.org/pypi/clowder-repo

.. image:: https://img.shields.io/pypi/l/clowder-repo.svg
:target: https://pypi.python.org/pypi/clowder-repo

.. image:: https://requires.io/github/JrGoodle/clowder/requirements.svg?branch=master
:target: https://requires.io/github/JrGoodle/clowder/requirements/?branch=master

Expand Down
2 changes: 1 addition & 1 deletion script/deploy
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ else
github-release release \
--tag "${TAG}" \
--name "${TAG}" \
--description "Release ${TAG}" || exit 1
--description "[${TAG} on PyPI](https://pypi.org/project/clowder-repo/${TAG}/)" || exit 1
echo ''

echo "Upload artifacts to GitHub Releases"
Expand Down
12 changes: 9 additions & 3 deletions script/process_readme.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@
from pathlib import Path
from typing import List, Optional


repo_dir = Path(__file__).resolve().parent.parent.resolve()
if 'SETUP_PY' in globals():
repo_dir = Path(globals()['REPO_DIR'])
else:
repo_dir = Path(__file__).resolve().parent.parent.resolve()


def main():
Expand All @@ -21,10 +23,14 @@ def main():
output = output.replace('](CONTRIBUTING', '](https://github.com/JrGoodle/clowder/blob/master/CONTRIBUTING')

pattern = r'\]\(docs\/(.+?)\)'
# matches = re.findall(pattern, output)
replace = r'](https://github.com/JrGoodle/clowder/blob/master/docs/\1)'
output = re.sub(pattern, replace, output)

if 'SETUP_PY' in globals():
pattern = r'(## Table of Contents.+?##)'
replace = r'##'
output = re.sub(pattern, replace, output, flags=re.DOTALL)

output = output.replace('.gif)', '.gif?raw=true)')

processed_readme_path = repo_dir / 'README-processed.md'
Expand Down
7 changes: 5 additions & 2 deletions src/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
else:
repo_dir = Path(__file__).resolve().parent.parent.resolve()
process_readme_script = repo_dir / 'script' / 'process_readme.py'
exec(process_readme_script.read_text())
exec(process_readme_script.read_text(), {'SETUP_PY': True, 'REPO_DIR': str(repo_dir)})
processed_readme = repo_dir / 'README-processed.md'
long_description = processed_readme.read_text()

Expand All @@ -24,7 +24,10 @@
long_description=long_description,
long_description_content_type='text/markdown',
version='4.0b4',
url='http://clowder.cat',
url='https://github.com/JrGoodle/clowder',
project_urls={
"Documentation": "https://clowder.readthedocs.io/en/latest/"
},
author='Joe DeCapo',
author_email='joe@polka.cat',
license='MIT',
Expand Down

0 comments on commit a0c13d0

Please sign in to comment.