Skip to content

Commit dd47cd4

Browse files
author
alrex
authored
docs: updating readme (#1052)
* docs: updating readme
1 parent 7b6aba0 commit dd47cd4

File tree

1 file changed

+9
-85
lines changed

1 file changed

+9
-85
lines changed

Diff for: README.md

+9-85
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,13 @@
3636

3737
---
3838

39-
## About this project
39+
## OpenTelemetry Python
4040

41-
The Python [OpenTelemetry](https://opentelemetry.io/) client.
41+
The Python [OpenTelemetry](https://opentelemetry.io/) implementation.
4242

43-
## Installation
43+
## Getting started
44+
45+
OpenTelemetry's goal is to provide a single set of APIs to capture distributed traces and metrics from your application and send them to an observability platform. This project allows you to do just that for applications written in Python.
4446

4547
This repository includes multiple installable packages. The `opentelemetry-api`
4648
package includes abstract classes and no-op implementations that comprise the OpenTelemetry API following
@@ -52,9 +54,6 @@ Libraries that produce telemetry data should only depend on `opentelemetry-api`,
5254
and defer the choice of the SDK to the application developer. Applications may
5355
depend on `opentelemetry-sdk` or another package that implements the API.
5456

55-
**Please note** that this library is currently in _beta_, and shouldn't
56-
generally be used in production environments.
57-
5857
The API and SDK packages are available on PyPI, and can installed via `pip`:
5958

6059
```sh
@@ -94,13 +93,9 @@ The online documentation is available at https://opentelemetry-python.readthedoc
9493
if you want to access the documentation for the latest version use
9594
https://opentelemetry-python.readthedocs.io/en/latest/.
9695

97-
## Compatible Exporters
98-
99-
See the [OpenTelemetry registry](https://opentelemetry.io/registry/?s=python) for a list of exporters available.
100-
10196
## Contributing
10297

103-
See [CONTRIBUTING.md](CONTRIBUTING.md)
98+
See [CONTRIBUTING.md](CONTRIBUTING.md).
10499

105100
We meet weekly on Thursday at 9AM PT. The meeting is subject to change depending on contributors' availability. Check the [OpenTelemetry community calendar](https://calendar.google.com/calendar/embed?src=google.com_b79e3e90j7bbsa2n2p5an5lf60%40group.calendar.google.com) for specific dates.
106101

@@ -134,78 +129,7 @@ Maintainers ([@open-telemetry/python-maintainers](https://github.com/orgs/open-t
134129
<img src="https://contributors-img.web.app/image?repo=open-telemetry/opentelemetry-python" />
135130
</a>
136131

137-
## Release Schedule
138-
139-
OpenTelemetry Python is under active development.
140-
141-
The library is not yet _generally available_, and releases aren't guaranteed to
142-
conform to a specific version of the specification. Future releases will not
143-
attempt to maintain backwards compatibility with previous releases. Each alpha
144-
and beta release includes significant changes to the API and SDK packages,
145-
making them incompatible with each other.
146-
147-
The [v0.1 alpha
148-
release](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v0.1.0)
149-
includes:
150-
151-
- Tracing API
152-
- Tracing SDK
153-
- Metrics API
154-
- Metrics SDK (Partial)
155-
- W3C Trace Context Propagation
156-
- B3 Context Propagation
157-
- HTTP Integrations
158-
159-
The [v0.2 alpha
160-
release](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v0.2.0)
161-
includes:
162-
163-
- OpenTracing Bridge
164-
- Jaeger Trace Exporter
165-
- Trace Sampling
166-
167-
The [v0.3 alpha
168-
release](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v0.3.0)
169-
includes:
170-
171-
- Metrics Instruments and Labels
172-
- Flask Integration
173-
- PyMongo Integration
174-
175-
The [v0.4 alpha
176-
release](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v0.4.0)
177-
includes:
178-
179-
- Metrics MinMaxSumCount Aggregator
180-
- Context API
181-
- Full Metrics SDK Pipeline
182-
- Metrics STDOUT Exporter
183-
- Dbapi2 Integration
184-
- MySQL Integration
185-
- Psycopg2 Integration
186-
- Zipkin Exporter
187-
- Prometheus Metrics Exporter
188-
- New Examples and Improvements to Existing Examples
189-
190-
The [v0.5 beta
191-
release](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v0.5.0)
192-
includes:
193-
194-
- W3C Correlation Context Propagation
195-
- OpenTelemetry Collector Exporter Integration for both metrics and traces
196-
- Metrics SDK
197-
- Global configuration module
198-
- Documentation improvements
199-
200-
The [v0.6 beta
201-
release](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v0.6.0)
202-
includes:
203-
204-
- API changes and bugfixes
205-
- An autoinstrumentation package and updated Flask instrumentation
206-
- gRPC integration
207-
208-
See the [project
209-
milestones](https://github.com/open-telemetry/opentelemetry-python/milestones)
210-
for details on upcoming releases. The dates and features described in issues
132+
## Project Status
133+
134+
Project [boards](https://github.com/open-telemetry/opentelemetry-python/projects) and [milestones](https://github.com/open-telemetry/opentelemetry-python/milestones) can be found at the respective links. We try to keep these accurate and should be the best place to go for answers on project status. The dates and features described in issues
211135
and milestones are estimates, and subject to change.

0 commit comments

Comments
 (0)