Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: added changie to generate changelogs #4

Merged
merged 2 commits into from
Sep 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changes/header.tpl.md
Original file line number Diff line number Diff line change
@@ -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).
Empty file added .changes/unreleased/.gitkeep
Empty file.
1 change: 1 addition & 0 deletions .changes/v0.1.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
## v0.1.0 - 2023-09-11
26 changes: 26 additions & 0 deletions .changie.yaml
Original file line number Diff line number Diff line change
@@ -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_
29 changes: 29 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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

24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,27 @@ pip install portkey-ai

#### 📞 Talk to the devs: [Rohit](https://twitter.com/jumbld) | [Ayush](https://twitter.com/ayushgarg_xyz)


<br></br>
# 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

23 changes: 21 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"
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"