From a551a57b3aab5d55a9e140d8bb1590c19e572f2f Mon Sep 17 00:00:00 2001 From: noble-varghese Date: Mon, 11 Sep 2023 19:13:33 +0530 Subject: [PATCH] feat: added changie to generate changelogs --- .changes/header.tpl.md | 6 ++++++ .changes/unreleased/.gitkeep | 0 .changes/v0.1.0.md | 1 + .changie.yaml | 26 ++++++++++++++++++++++++++ CHANGELOG.md | 29 +++++++++++++++++++++++++++++ README.md | 24 ++++++++++++++++++++++++ portkey/version.py | 2 +- pyproject.toml | 23 +++++++++++++++++++++-- 8 files changed, 108 insertions(+), 3 deletions(-) create mode 100644 .changes/header.tpl.md create mode 100644 .changes/unreleased/.gitkeep create mode 100644 .changes/v0.1.0.md create mode 100644 .changie.yaml create mode 100644 CHANGELOG.md diff --git a/.changes/header.tpl.md b/.changes/header.tpl.md new file mode 100644 index 00000000..df8faa7b --- /dev/null +++ b/.changes/header.tpl.md @@ -0,0 +1,6 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html), +and is generated by [Changie](https://github.com/miniscruff/changie). diff --git a/.changes/unreleased/.gitkeep b/.changes/unreleased/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/.changes/v0.1.0.md b/.changes/v0.1.0.md new file mode 100644 index 00000000..5f2a267e --- /dev/null +++ b/.changes/v0.1.0.md @@ -0,0 +1 @@ +## v0.1.0 - 2023-09-11 diff --git a/.changie.yaml b/.changie.yaml new file mode 100644 index 00000000..906d4955 --- /dev/null +++ b/.changie.yaml @@ -0,0 +1,26 @@ +changesDir: .changes +unreleasedDir: unreleased +headerPath: header.tpl.md +changelogPath: CHANGELOG.md +versionExt: md +versionFormat: '## {{.Version}} - {{.Time.Format "2006-01-02"}}' +kindFormat: '### {{.Kind}}' +changeFormat: '* {{.Body}}' +kinds: +- label: Added + auto: minor +- label: Changed + auto: major +- label: Deprecated + auto: minor +- label: Removed + auto: major +- label: Fixed + auto: patch +- label: Security + auto: patch +newlines: + afterChangelogHeader: 1 + beforeChangelogVersion: 1 + endOfVersion: 1 +envPrefix: CHANGIE_ diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..525c2373 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,29 @@ +# Changelog + +We are excited to announce the **stable release** of the all-new **Portkey Python SDK**, version 0.1.44! This SDK makes it easier than ever to add production capabilities to your existing LLM systems with one line of change to your code. + +## Key Features and Enhancements + +- **Stability and Reliability**: This release marks the stable version of Portkey Python SDK, thoroughly tested to ensure reliable performance in your projects. + +- **Ease of Use**: The SDK follows OpenAI SDK footprint, and with one line of change to your existing code, you can add Portkey's production features to your app. + +- **Community Support**: [Join our growing community](https://discord.gg/QHJ3RgcvKT) of practitioners putting LLMs in production. Share ideas, resolve doubts, and collaborate on projects. + +## Getting Started + +```py +pip install portkey-ai +``` +For comprehensive documentation on Portkey production features, [check out our docs here.](https://docs.portkey.ai/) + +## Feedback and Contributions + +We welcome your feedback and contributions! Feel free to report issues, suggest enhancements, or submit pull requests on our [GitHub repository](https://github.com/Portkey-AI/portkey-python-sdk). + +Thank you for your support and enthusiasm for the Portkey Python SDK. We look forward to seeing the amazing projects you will build with it! + +Happy coding! + +- The Portkey Team + diff --git a/README.md b/README.md index 8b136420..dfbf80ad 100644 --- a/README.md +++ b/README.md @@ -68,3 +68,27 @@ pip install portkey-ai #### 📞 Talk to the devs: [Rohit](https://twitter.com/jumbld) | [Ayush](https://twitter.com/ayushgarg_xyz) + +

+# Changelog + +We are excited to announce the **stable release** of the all-new **Portkey Python SDK**, version 0.1.44! This SDK makes it easier than ever to add production capabilities to your existing LLM systems with one line of change to your code. + +### Key Features and Enhancements of this release + +- **Stability and Reliability**: This release marks the stable version of Portkey Python SDK, thoroughly tested to ensure reliable performance in your projects. + +- **Ease of Use**: The SDK follows OpenAI SDK footprint, and with one line of change to your existing code, you can add Portkey's production features to your app. + +- **Community Support**: [Join our growing community](https://discord.gg/QHJ3RgcvKT) of practitioners putting LLMs in production. Share ideas, resolve doubts, and collaborate on projects. + +### Feedback and Contributions + +We welcome your feedback and contributions! Feel free to report issues, suggest enhancements, or submit pull requests on our [GitHub repository](https://github.com/Portkey-AI/portkey-python-sdk). + +Thank you for your support and enthusiasm for the Portkey Python SDK. We look forward to seeing the amazing projects you will build with it! + +Happy coding! + +- The Portkey Team + diff --git a/portkey/version.py b/portkey/version.py index ce82d97d..f5068f6e 100644 --- a/portkey/version.py +++ b/portkey/version.py @@ -1 +1 @@ -VERSION = "0.1.43" +VERSION = "0.1.44" diff --git a/pyproject.toml b/pyproject.toml index 7fd26b97..3c5b532b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,3 +1,22 @@ [build-system] -requires = ["setuptools"] -build-backend = "setuptools.build_meta" \ No newline at end of file +requires = ["setuptools ~= 58.0", "cython ~= 0.29.0"] +build-backend = "setuptools.build_meta" + + +[tool.setuptools] +# Add your package information here +name = "portkey-ai" +author = "Portkey.ai" +author_email = "support@portkey.ai" +description = "Python client library for the Portkey API" +long_description = file: README.md +long_description_content_type = text/markdown +url = "https://github.com/Portkey-AI/portkey-python-sdk" +license = "MIT" + + +[project.urls] +homepage = 'https://github.com/Portkey-AI/portkey-python-sdk' +documentation = 'https://docs.portkey.ai/' +repository = 'https://github.com/Portkey-AI/portkey-python-sdk' +changelog = "https://github.com/Portkey-AI/portkey-python-sdk/blob/main/CHANGELOG.md"