Metadata-Version: 2.1
Name: greptime_cloud_quick_start
Version: 1.0.2
Summary: A quick start demo for GreptimeCloud
Project-URL: Homepage, https://github.com/GreptimeCloudStarters/quick-start-python
Project-URL: Bug Tracker, https://github.com/GreptimeCloudStarters/quick-start-python/issues
Author-email: CUI YIRAN <cuiyiran3@gmail.com>
License-File: LICENSE
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Requires-Dist: opentelemetry-api==1.19.0
Requires-Dist: opentelemetry-exporter-otlp-proto-http==1.19.0
Requires-Dist: opentelemetry-instrumentation-system-metrics==0.40b0
Requires-Dist: opentelemetry-instrumentation==0.40b0
Requires-Dist: opentelemetry-proto==1.19.0
Requires-Dist: opentelemetry-sdk==1.19.0
Description-Content-Type: text/markdown

# Introduction

This is a quick start demo for [GreptimeCloud](https://greptime.cloud/). It collects the system metric data such as CPU and memory usage through Opentelemetry and sends the metrics to GreptimeCloud. You can view the metrics on the GreptimeCloud dashboard.

## Quick Start

Use the following command line to start it in Python 3.10+ without cloning the repo:

```shell
pipx run --no-cache greptime-cloud-quick-start -e <endpoint-url> -db <dbname> -u <username> -p <password>
```

Or you can clone the repo and run it:

```shell
pip install -r requirements.txt
python start/main.py -e <endpoint-url> -db <dbname> -u <username> -p <password>
```

## Release

1. Change the version in `pyproject.toml`.
2. Commit and push the changes.
3. Create a tag with the version and push it to the remote repository.

    ```shell
    git tag v<major>.<minor>.<patch>
    git push origin v<major>.<minor>.<patch>
    ```

4. Build and publish the package to PyPI:

    ```shell
    python -m build
    python -m twine upload dist/*
    ```
