From 060192d2c5b2d2a0b3ec4ed54dcc1add4d48518e Mon Sep 17 00:00:00 2001
From: Ajinkya Indulkar <26824103+ajndkr@users.noreply.github.com>
Date: Sun, 14 May 2023 17:22:37 +0200
Subject: [PATCH] chore: add deprecation warning (#42)

* :bulb: add deprecation warning

* :memo: update README

* :construction_worker: update code check workflow
---
 .github/workflows/code-check.yaml   | 2 +-
 README.md                           | 2 ++
 fastapi_async_langchain/__init__.py | 8 ++++++++
 3 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/code-check.yaml b/.github/workflows/code-check.yaml
index fcb0e4c..b055fe5 100644
--- a/.github/workflows/code-check.yaml
+++ b/.github/workflows/code-check.yaml
@@ -3,7 +3,7 @@ name: Code check
 on:
   push:
     branches:
-      - main
+      - fastapi-async-langchain/main
   pull_request:
     types: [opened, synchronize, reopened, ready_for_review]
 
diff --git a/README.md b/README.md
index debf18b..e4379b0 100644
--- a/README.md
+++ b/README.md
@@ -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).
 
diff --git a/fastapi_async_langchain/__init__.py b/fastapi_async_langchain/__init__.py
index e69de29..ff42f8e 100644
--- a/fastapi_async_langchain/__init__.py
+++ b/fastapi_async_langchain/__init__.py
@@ -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)