Metadata-Version: 2.4
Name: rtecommon
Version: 2.2.2
Summary: Common tools/utilities/configurations used in the RealTime Events echo system.
License: Proprietary
License-File: LICENSE.txt
Author: Hendrik du Toit
Author-email: hendrik@brightedge.co.za
Maintainer: Hendrik du Toit
Maintainer-email: hendrikdt@citiqprepaid.co.za
Requires-Python: >=3.10
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Office/Business
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: pydantic (>=2.11.5,<3.0.0)
Requires-Dist: pydantic-settings (>=2.9.1,<3.0.0)
Project-URL: Homepage, https://github.com/RealTimeEvents/rtecommon
Project-URL: Repository, https://github.com/RealTimeEvents/rtecommon.git
Project-URL: changelog, https://github.com/RealTimeEvents/rtecommon/blob/master/ReleaseNotes.md
Project-URL: issues, https://github.com/RealTimeEvents/rtecommon/issues
Description-Content-Type: text/markdown

# RealTimeEvents Common

| **Category** | **Status' and Links**                                                                                      |
| ------------ | ---------------------------------------------------------------------------------------------------------- |
| General      | [![][general_maintenance_y_img]][general_maintenance_y_lnk] [![][general_semver_pic]][general_semver_link] |
| CD/CI        | [![][cicd_codestyle_img]][cicd_codestyle_lnk]                                                              |

Common tools/utilities/configurations used in the RealTime Events echo system.

______________________________________________________________________

## Overview

Add any common tools/utilities/configurations to be used in the RealTime Events ecosystem to this module.

______________________________________________________________________

## Usage

```python
import rtecommon
```

______________________________________________________________________

## Updating ReleaseNotes Instructions

1. Run the `pushpy.ps1` script or manually commit the current changes.
1. Generate the release notes
   1. Use one of the following AI propmpts in Notion to generate the release notes.

      - [Release - Update - General](https://www.notion.so/Release-Update-General-2c0bc8e6c6f38076b4cee82e3cf243fa?v=2c0bc8e6c6f3806e85db000c395f94ce&source=copy_link)
      - [Release - Update - VenvIt](https://www.notion.so/Release-Update-VenvIt-2c0bc8e6c6f380de84a0f3fbb8b5dda5?v=2c0bc8e6c6f3806e85db000c395f94ce&source=copy_link)

      or

   1. Use the following template and manually update the ReleaseNotes.md file.

      ```
       # Release ?.?.?
       ## Summary of Changes
       - bla, bla, bla
       ## Next Heading
       - bla, bla, bla
       ---
      ```
1. You can repeat step 1 multiple times.
1. You can repeat step 2 multiple times but update the ReleaseNotes that has not been published.
1. Run the `pushpr.ps1` script once you are ready to create the PR to publish the release. TOy can also manually create the tag, touch a file, commit and push the changes.
1. Merge the PR in GitHub.
1. Confirm the following:
   1. The release update reflects in GitHub
   1. The release update notification was sent

______________________________________________________________________

## Good to Know's

- None

______________________________________________________________________

## Further Development

- None

______________________________________________________________________

## Updating ReleaseNotes Instructions

1. Run the `pushpy.ps1` script or manually commit the current changes.
1. Generate the release notes
   1. Use one of the following AI propmpts in Notion to generate the release notes.

      - [Release - Update - General](https://www.notion.so/Release-Update-General-2c0bc8e6c6f38076b4cee82e3cf243fa?v=2c0bc8e6c6f3806e85db000c395f94ce&source=copy_link)
      - [Release - Update - VenvIt](https://www.notion.so/Release-Update-VenvIt-2c0bc8e6c6f380de84a0f3fbb8b5dda5?v=2c0bc8e6c6f3806e85db000c395f94ce&source=copy_link)

      or

   1. Use the following template and manually update the ReleaseNotes.md file.

      ```
       # Release ?.?.?
       ## Summary of Changes
       - bla, bla, bla
       ## Next Heading
       - bla, bla, bla
       ---
      ```
1. You can repeat step 1 multiple times.
1. You can repeat step 2 multiple times but update the ReleaseNotes that has not been published.
1. Run the `pushpr.ps1` script once you are ready to create the PR to publish the release. TOy can also manually create
   the tag, touch a file, commit and push the changes.
1. Merge the PR in GitHub.
1. Confirm the following:
   1. The release update reflects in GitHub
   1. The release update notification was sent

______________________________________________________________________

[cicd_codestyle_img]: https://img.shields.io/badge/code%20style-black-000000.svg "Black"
[cicd_codestyle_lnk]: https://github.com/psf/black "Black"
[general_maintenance_y_img]: https://img.shields.io/badge/Maintenance%20Intended-%E2%9C%94-green.svg?style=flat-square "Maintenance - intended"
[general_maintenance_y_lnk]: http://unmaintained.tech/ "Maintenance - intended"
[general_semver_link]: https://semver.org/ "Sentic Versioning - 2.0.0"
[general_semver_pic]: https://img.shields.io/badge/Semantic%20Versioning-2.0.0-brightgreen.svg?style=flat-square "Sentic Versioning - 2.0.0"

