Skip to content

Commit ad2c80d

Browse files
committed
Update README
1 parent 14ef590 commit ad2c80d

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,13 @@
1717

1818
---
1919

20-
# Apitally client library for Python
20+
# Apitally SDK for Python
2121

2222
[![Tests](https://github.com/apitally/apitally-py/actions/workflows/tests.yaml/badge.svg?event=push)](https://github.com/apitally/apitally-py/actions)
2323
[![Codecov](https://codecov.io/gh/apitally/apitally-py/graph/badge.svg?token=UNLYBY4Y3V)](https://codecov.io/gh/apitally/apitally-py)
2424
[![PyPI](https://img.shields.io/pypi/v/apitally?logo=pypi&logoColor=white&color=%23006dad)](https://pypi.org/project/apitally/)
2525

26-
This client library for Apitally currently supports the following Python web
27-
frameworks:
26+
This SDK for Apitally currently supports the following Python web frameworks:
2827

2928
- [FastAPI](https://docs.apitally.io/frameworks/fastapi)
3029
- [Django REST Framework](https://docs.apitally.io/frameworks/django-rest-framework)
@@ -40,19 +39,27 @@ the 📚 [documentation](https://docs.apitally.io).
4039

4140
### API analytics
4241

43-
Track traffic, error and performance metrics for your API, each endpoint and individual API consumers, allowing you to make informed, data-driven engineering and product decisions.
42+
Track traffic, error and performance metrics for your API, each endpoint and
43+
individual API consumers, allowing you to make informed, data-driven engineering
44+
and product decisions.
4445

4546
### Error tracking
4647

47-
Understand which validation rules in your endpoints cause client errors. Capture error details and stack traces for 500 error responses, and have them linked to Sentry issues automatically.
48+
Understand which validation rules in your endpoints cause client errors. Capture
49+
error details and stack traces for 500 error responses, and have them linked to
50+
Sentry issues automatically.
4851

4952
### Request logging
5053

51-
Drill down from insights to individual requests or use powerful filtering to understand how consumers have interacted with your API. Configure exactly what is included in the logs to meet your requirements.
54+
Drill down from insights to individual requests or use powerful filtering to
55+
understand how consumers have interacted with your API. Configure exactly what
56+
is included in the logs to meet your requirements.
5257

5358
### API monitoring & alerting
5459

55-
Get notified immediately if something isn't right using custom alerts, synthetic uptime checks and heartbeat monitoring. Notifications can be delivered via email, Slack or Microsoft Teams.
60+
Get notified immediately if something isn't right using custom alerts, synthetic
61+
uptime checks and heartbeat monitoring. Notifications can be delivered via
62+
email, Slack or Microsoft Teams.
5663

5764
## Install
5865

@@ -128,8 +135,8 @@ app.wsgi_app = ApitallyMiddleware(
128135

129136
### Starlette
130137

131-
This is an example of how to add the Apitally middleware to a Starlette application.
132-
For further instructions, see our
138+
This is an example of how to add the Apitally middleware to a Starlette
139+
application. For further instructions, see our
133140
[setup guide for Starlette](https://docs.apitally.io/frameworks/starlette).
134141

135142
```python

0 commit comments

Comments
 (0)