Skip to content

Commit 024fc0a

Browse files
Improve both READMEs (#3)
* Add screenshot to RST README * Add CircleCI badge * Enable coveralls * Add HowFast uptime badge * Add Coveralls badge * Add shields.io badges
1 parent 1c30653 commit 024fc0a

File tree

6 files changed

+41
-6
lines changed

6 files changed

+41
-6
lines changed

.circleci/config.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: 2
22
jobs:
33
build:
44
docker:
5-
- image: circleci/python:3.6.8
5+
- image: circleci/python:3.6.9
66
steps:
77
- checkout
88

@@ -25,8 +25,9 @@ jobs:
2525

2626
- run:
2727
name: run tests
28-
command: poetry run pytest .
29-
28+
command: |
29+
poetry run coverage run -m pytest .
30+
poetry run coveralls
3031
3132
workflows:
3233
version: 2

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# HowFast APM agent for Python
22

3+
[![CircleCI](https://circleci.com/gh/HowFast/apm-python.svg?style=svg)](https://circleci.com/gh/HowFast/apm-python)
4+
[![uptime](https://badge.howfast.tech/uptime.png?t=https%3A%2F%2Fwww.howfast.tech%2F)](https://www.howfast.tech/#/monitors/https:%2F%2Fwww.howfast.tech%2F?pk_campaign=badge)
5+
[![Coverage Status](https://coveralls.io/repos/github/HowFast/apm-python/badge.svg?branch=master)](https://coveralls.io/github/HowFast/apm-python?branch=master)
6+
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/howfast-apm)
7+
![PyPI - Downloads](https://img.shields.io/pypi/dw/howfast-apm)
8+
39
This Python APM (Application Performance Monitoring) agent sends performance data to your
410
[HowFast](https://www.howfast.tech/) account.
511

README.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
HowFast APM for Python servers
22
==============================
33

4-
Light instrumentation of your Python server for reporting performance data to HowFast APM.
4+
Light instrumentation of your Python server for reporting performance data to `HowFast APM <https://www.howfast.tech/>`_.
5+
6+
.. image:: https://github.com/HowFast/apm-python/blob/master/screenshot.png
7+
:align: center
8+
:alt: Screenshot from HowFast APM
59

610
Install
711
-------

poetry.lock

Lines changed: 25 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ coverage = "^4.5"
3636
flake8 = "^3.7"
3737
yapf = "^0.28.0"
3838
mypy = "^0.720.0"
39+
coveralls = "^1.8"
3940

4041
[tool.poetry.extras]
4142
flask = ["flask", "blinker"]

screenshot.png

5.55 KB
Loading

0 commit comments

Comments
 (0)