From c77ea5ec0112bfeddd28a49d6fd531f092cc3e90 Mon Sep 17 00:00:00 2001 From: Kumaran Rajendhiran Date: Thu, 22 Aug 2024 14:00:07 +0530 Subject: [PATCH] Remove mentions of faststream-gen (#1717) --- .pre-commit-config.yaml | 1 - README.md | 42 ------------------------------- docs/docs/en/faststream.md | 51 -------------------------------------- 3 files changed, 94 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1427063edc..3cff44d229 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -9,7 +9,6 @@ repos: exclude: | (?x)^( docs/docs/SUMMARY.md| - .faststream_gen/rabbit/ack.md| docs/docs/en/api/.meta.yml )$ - id: check-yaml diff --git a/README.md b/README.md index 058f3c4890..aace9c1e10 100644 --- a/README.md +++ b/README.md @@ -328,48 +328,6 @@ More integration features can be found [here](https://faststream.airt.ai/latest/ --- -## Code generator - -As evident, **FastStream** is an incredibly user-friendly framework. However, we've taken it a step further and made it even more user-friendly! Introducing [faststream-gen](https://faststream-gen.airt.ai), a Python library that harnesses the power of generative AI to effortlessly generate **FastStream** applications. Simply describe your application requirements, and [faststream-gen](https://faststream-gen.airt.ai) will generate a production-grade **FastStream** project that is ready to deploy in no time. - -Save application description inside `description.txt`: -``` -Create a FastStream application using localhost broker for testing and use the -default port number. - -It should consume messages from the 'input_data' topic, where each message is a -JSON encoded object containing a single attribute: 'data'. - -While consuming from the topic, increment the value of the data attribute by 1. - -Finally, send message to the 'output_data' topic. -``` - -and run the following command to create a new **FastStream** project: -``` shell -faststream_gen -i description.txt -``` - -``` shell -✨ Generating a new FastStream application! - ✔ Application description validated. - ✔ FastStream app skeleton code generated. Takes around 15 to 45 seconds)... - ✔ The app and the tests are generated. around 30 to 90 seconds)... - ✔ New FastStream project created. - ✔ Integration tests were successfully completed. - Tokens used: 10768 - Total Cost (USD): $0.03284 -✨ All files were successfully generated! -``` - -### Tutorial - -We also invite you to explore our tutorial, where we will guide you through the process of utilizing the [faststream-gen](https://faststream-gen.airt.ai) Python library to effortlessly create **FastStream** applications: - -- [Cryptocurrency analysis with FastStream](https://faststream-gen.airt.ai/Tutorial/Cryptocurrency_Tutorial/) - ---- - ## Stay in touch Please show your support and stay in touch by: diff --git a/docs/docs/en/faststream.md b/docs/docs/en/faststream.md index 62e211745d..d068d434a6 100644 --- a/docs/docs/en/faststream.md +++ b/docs/docs/en/faststream.md @@ -220,57 +220,6 @@ Just import a **StreamRouter** you need and declare the message handler with the --- -## Code generator - -As evident, **FastStream** is an incredibly user-friendly framework. However, we've taken it a step further and made it even more user-friendly! Introducing [**faststream-gen**](https://faststream-gen.airt.ai){.external-link target="_blank"}, a Python library that harnesses the power of generative AI to effortlessly generate **FastStream** applications. Simply describe your application requirements, and [**faststream-gen**](https://faststream-gen.airt.ai){.external-link target="_blank"} will generate a production-grade **FastStream** project that is ready to deploy in no time. - -Save application description inside `description.txt`: - -``` -{! docs_src/index/app_description.txt !} -``` - -and run the following command to create a new **FastStream** project: - -```shell -faststream_gen -i description.txt -``` - -```{.shell .no-copy} -✨ Generating a new FastStream application! - ✔ Application description validated. - ✔ FastStream app skeleton code generated. Takes around 15 to 45 seconds)... - ✔ The app and the tests are generated. around 30 to 90 seconds)... - ✔ New FastStream project created. - ✔ Integration tests were successfully completed. - Tokens used: 10768 - Total Cost (USD): $0.03284 -✨ All files were successfully generated! -``` -{ data-search-exclude } - -### Tutorial - -We also invite you to explore our tutorial, where we will guide you through the process of utilizing the [**faststream-gen**](https://faststream-gen.airt.ai){.external-link target="_blank"} Python library to effortlessly create **FastStream** applications: - -- [Cryptocurrency analysis with FastStream](https://faststream-gen.airt.ai/Tutorial/Cryptocurrency_Tutorial/){.external-link target="_blank"} - ---- - -## Stay in touch - -Please show your support and stay in touch by: - -- giving our [GitHub repository](https://github.com/airtai/faststream/){.external-link target="_blank"} a star, and - -- joining our [Discord server](https://discord.gg/qFm6aSqq59){.external-link target="_blank"} - -Your support helps us to stay in touch with you and encourages us to -continue developing and improving the framework. Thank you for your -support! - ---- - ## Contributors Thanks to all of these amazing people who made the project better!