Metadata-Version: 2.1
Name: matter-observability
Version: 1.0.0
Summary: A template for Matter's observability library
Project-URL: Documentation, https://github.com/Matter-Tech/matter-observability#readme
Project-URL: Issues, https://github.com/Matter-Tech/matter-observability/issues
Project-URL: Source, https://github.com/Matter-Tech/matter-observability
Author-email: Tomer Sasson <tomer@thisismatter.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.10
Requires-Dist: matter-exceptions==0.1.1
Requires-Dist: starlette-exporter==0.15.1
Description-Content-Type: text/markdown

# matter-observability

**Table of Contents**

- [Installation](#installation)
- [License](#license)

## Getting started

TODO


## Installation

```console
pip install matter-observability
```

## Contributing

Make sure you have all supported python versions installed in your machine:

* 3.9
* 3.10
* 3.11

### Install hatch in your system

```https://hatch.pypa.io/latest/install/```

### Create the environment

```console
hatch env create
```

### Locate the new environment

```console
hatch env find default
```

Do your changes...

### Run the tests

```console
hatch run test
```

The command above will run the tests against all supported python versions
installed in your machine. For testing in other operating system you may use the
configured CI in github. 

### Bump a new version

In general, you just need to execute:

```console
hatch version
```

This command will update the minor version. i.e.:
No breaking changes and new feature has been added

We are using [semantic version](https://semver.org/), if you are doing a bug fix:

```console
hatch version fix
```
