Skip to content

Commit

Permalink
chore: add deprecation warning (#42)
Browse files Browse the repository at this point in the history
* 💡 add deprecation warning

* 📝 update README

* 👷 update code check workflow
  • Loading branch information
ajndkr authored May 14, 2023
1 parent 59154e1 commit 060192d
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/code-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Code check
on:
push:
branches:
- main
- fastapi-async-langchain/main
pull_request:
types: [opened, synchronize, reopened, ready_for_review]

Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/ajndkr/fastapi-async-langchain/blob/main/LICENSE)
[![PyPI version](https://badge.fury.io/py/fastapi-async-langchain.svg)](https://pypi.org/project/fastapi-async-langchain/)

> ⚠️ DISCLAIMER: `fastapi-async-langchain` has been deprecated in favor of `lanarky`. You can find the PyPI project [here](https://pypi.org/project/lanarky/).
Ship production-ready [LangChain](https://github.com/hwchase17/langchain) projects with
[FastAPI](https://github.com/tiangolo/fastapi).

Expand Down
8 changes: 8 additions & 0 deletions fastapi_async_langchain/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import warnings

DEPRECATION_MESSAGE = """`fastapi_async_langchain` package name has been deprecated and will not receive any new updates.
For future releases, please install the `lanarky` package instead: `pip install lanarky`.
"""

warnings.warn(DEPRECATION_MESSAGE, DeprecationWarning, stacklevel=2)

0 comments on commit 060192d

Please sign in to comment.