+ 
-
+
Designed for simplicity, customization, and developer productivity. @@ -82,7 +82,7 @@ Let's take a look at some possible customizations created by readme-ai:
+ 
--image custom --badge-color FF4B4B --badge-style flat-square --header-style classic
+ 
--image cloud --header-style compact --toc-style fold
+ 
--badge-style for-the-badge --header-style svg
+ 
+ --header-style ascii
+ 
+ --header-style ascii_box
+ 
--align left --badge-style flat-square --image cloud
+ 
--align left --badge-style flat --image gradient
+ 
--badge-style flat --image custom
+ 
--badge-style skills-light --image grey
+ 
--badge-style flat-square
+ 
--badge-style flat --image black
+ 
--image custom --badge-color 00ffe9 --badge-style flat-square --header-style classic
+ 
--image llm --badge-style plastic --header-style classic
+ 
-i custom -bc BA0098 -bs flat-square -hs modern -ts fold
- --header-style ascii
- 
- --header-style ascii_box
- 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
](https://pypi.org/project/readmeai/)
-->
-### <img width=){kind=icon}
Pip
```sh
โฏ pip install readmeai
@@ -349,7 +350,7 @@ Choose your preferred installation method:
[](https://pipxproject.github.io/pipx/installation/)
-->
-### Pipx
+### Pipx
```sh
โฏ pipx install readmeai
@@ -363,7 +364,7 @@ Choose your preferred installation method:
[](https://hub.docker.com/r/zeroxeli/readme-ai)
-->
-### Docker
+### Docker
Pull the latest Docker image from the Docker Hub repository.
@@ -371,7 +372,7 @@ Pull the latest Docker image from the Docker Hub repository.
โฏ docker pull zeroxeli/readme-ai:latest
```
-### From source
+### From source
Bash
+### Bash
1. **Run the setup script:**
@@ -405,7 +406,7 @@ Alternatively, the project can be setup using the bash script below:
Or, use `poetry` to build the project:
-### Poetry
+### Poetry
1. **Install dependencies using Poetry:**
@@ -534,23 +535,23 @@ Add more customization options:
--emojis
```
-### Docker
+### Docker
Run the Docker container with the OpenAI client:
```sh
โฏ docker run -it --rm \
- -e OPENAI_API_KEY=$OPENAI_API_KEY \
- -v "$(pwd)":/app zeroxeli/readme-ai:latest \
- -r https://github.com/eli64s/readme-ai \
- --api openai
+ -e OPENAI_API_KEY=$OPENAI_API_KEY \
+ -v "$(pwd)":/app zeroxeli/readme-ai:latest \
+ --repository https://github.com/eli64s/readme-ai \
+ --api openai
```
-### From source
+### From source
Bash
+### Bash
If you installed the project from source with the bash script, run the following command:
@@ -566,7 +567,7 @@ If you installed the project from source with the bash script, run the following
โฏ python3 -m readmeai.cli.main -r https://github.com/eli64s/readme-ai
```
-### Poetry
+### Poetry
1. **Activate the virtual environment:**
@@ -582,7 +583,7 @@ If you installed the project from source with the bash script, run the following
Streamlit
+### Streamlit
Try readme-ai directly in your browser, no installation required. See the readme-ai-streamlit repository for more details.
@@ -642,33 +643,32 @@ Customize your README generation using these CLI options:
| `--temperature` | Creativity level for content generation | `0.1` |
| `--tree-depth` | Maximum depth of the directory tree structure | `2` |
-For a full list of options, run:
+Run the following command to view all available options:
```sh
-readmeai --help
+โฏ readmeai --help
```
-Visit the [Official Documentation][mkdocs] for more detailed information on configuration options, examples, and best practices.
+Visit the [Official Documentation][mkdocs] for more detailed information on configuration options, examples, and best practices.
---
## ๐จ Examples
-| Language/Framework | Output File | Input Repository | Description |
-| :--: | :--: | :--: | :--: |
-| Python | [readme-python.md][0a] | [readme-ai][0b] | Core readme-ai project |
-| TypeScript & React | [readme-typescript.md][1a] | [ChatGPT App][1b] | React Native ChatGPT app |
-| PostgreSQL & DuckDB | [readme-postgres.md][2a] | [Buenavista][2b] | Postgres proxy server |
-| Kotlin & Android | [readme-kotlin.md][3a] | [file.io Client][3b] | Android file sharing app |
-| Streamlit | [readme-streamlit.md][4a] | [readme-ai-streamlit][4b] | Streamlit UI for readme-ai app |
-| Rust & C | [readme-rust-c.md][5a] | [CallMon][5b] | System call monitoring tool |
-| Docker & Go | [readme-go.md][6a] | [docker-gs-ping][6b] | Dockerized Go app |
-| Java | [readme-java.md][7a] | [Minimal-Todo][7b] | Minimalist todo Java app |
-| FastAPI & Redis | [readme-fastapi-redis.md][8a] | [async-ml-inference][8b] | Async ML inference service |
-| Jupyter Notebook | [readme-mlops.md][9a] | [mlops-course][9b] | MLOps course repository |
-| Apache Flink | [readme-local.md][10a] | Local Directory | Example using a local directory |
-
-Find more examples [here](https://github.com/eli64s/readme-ai/tree/main/examples).
+| Technology | Example Output | Repository | Description |
+|------------|---------------|------------|-------------|
+| Readme-ai | [readme-ai.md][default] | [readme-ai][readme-ai] | Readme-ai project |
+| Apache Flink | [readme-pyflink.md][modern-header] | [pyflink-poc][pyflink] | Pyflink project |
+| Streamlit | [readme-streamlit.md][svg-banner] | [readme-ai-streamlit][streamlit] | Streamlit web app |
+| Vercel & NPM | [readme-vercel.md][dalle-logo] | [github-readme-quotes][vercel] | Vercel deployment |
+| Go & Docker | [readme-docker-go.md][for-the-badge] | [docker-gs-ping][docker-golang] | Dockerized Go app |
+| FastAPI & Redis | [readme-fastapi-redis.md][fastapi-redis] | [async-ml-inference][fastapi] | Async ML inference service |
+| Java | [readme-java.md][compact-header] | [Minimal-Todo][java] | Minimalist todo Java app |
+| PostgreSQL & DuckDB | [readme-postgres.md][classic-header] | [Buenavista][postgres] | Postgres proxy server |
+| Kotlin | [readme-kotlin.md][readme-kotlin] | [android-client][kotlin] | Android client app |
+| Offline Mode | [offline-mode.md][offline-mode] | [litellm][litellm] | LLM API service |
+
+Find additional README examples in the [examples directory](https://github.com/eli64s/readme-ai/tree/main/examples).
---
@@ -717,37 +717,8 @@ README-AI is released under the terms of the [MIT License][license].
---
-
-[overview]: #-overview "๐ฎ Overview"
-[demo]: (#-demo) "๐พ Demo"
-[features]: (#-features) "โ๏ธ Features"
-[getting-started]: (#-getting-started) "๐ธ Getting Started"
-[configuration]: (#-configuration) "๐ก Configuration"
-[examples]: (#-examples) "๐จ Examples"
-[contributing]: (#-contributing) "๐ฐ Contributing"
-
-
-[0a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-ai.md "readme-python.md"
-[0b]: https://github.com/eli64s/readme-ai "readme-ai"
-[1a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-typescript.md "readme-typescript.md"
-[1b]: https://github.com/Yuberley/ChatGPT-App-React-Native-TypeScript "ChatGPT App"
-[2a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-postgres.md "readme-postgres.md"
-[2b]: https://github.com/jwills/buenavista "Buenavista"
-[3a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-kotlin.md "readme-kotlin.md"
-[3b]: https://github.com/rumaan/file.io-Android-Client "file.io Client"
-[4a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-streamlit-v0.5.88.md "readme-streamlit.md"
-[4b]: https://github.com/eli64s/readme-ai-streamlit "readme-ai-streamlit"
-[5a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-rust-c.md "readme-rust-c.md"
-[5b]: https://github.com/DownWithUp/CallMon "CallMon"
-[6a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-docker-go.md "readme-docker-go.md"
-[6b]: https://github.com/olliefr/docker-gs-ping "docker-gs-ping"
-[7a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-java.md "readme-java.md"
-[7b]: https://github.com/avjinder/Minimal-Todo "Minimal-Todo"
-[8a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-fastapi-redis.md "readme-fastapi-redis.md"
-[8b]: https://github.com/FerrariDG/async-ml-inference "async-ml-inference"
-[9a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-mlops.md "readme-mlops.md"
-[9b]: https://github.com/GokuMohandas/mlops-course "mlops-course"
-[10a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-local.md "readme-local.md"
+
+[mkdocs]: https://eli64s.github.io/readme-ai "Official Documentation"
[contributing]: https://github.com/eli64s/readme-ai/blob/main/CONTRIBUTING.md
@@ -755,5 +726,27 @@ README-AI is released under the terms of the [MIT License][license].
[discussions]: https://github.com/eli64s/readme-ai/discussions
[license]: https://github.com/eli64s/readme-ai/blob/main/LICENSE
-
-[mkdocs]: https://eli64s.github.io/readme-ai "Official Documentation"
+
+[default]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-ai.md "readme-python.md"
+[ascii-header]: https://github.com/eli64s/readme-ai/blob/main/examples/headers/ascii.md "ascii.md"
+[classic-header]: https://github.com/eli64s/readme-ai/blob/main/examples/headers/classic.md "readme-postgres.md"
+[compact-header]: https://github.com/eli64s/readme-ai/blob/main/examples/headers/compact.md "readme-java.md"
+[modern-header]: https://github.com/eli64s/readme-ai/blob/main/examples/headers/modern.md "readme-pyflink.md"
+[svg-banner]: https://github.com/eli64s/readme-ai/blob/main/examples/banners/svg-banner.md "readme-streamlit.md"
+[dalle-logo]: https://github.com/eli64s/readme-ai/blob/main/examples/logos/dalle.md "readme-vercel.md"
+[readme-kotlin]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-kotlin.md "readme-kotlin.md"
+[for-the-badge]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-docker-go.md "readme-docker-go.md"
+[fastapi-redis]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-fastapi-redis.md "readme-fastapi-redis.md"
+[offline-mode]: https://github.com/eli64s/readme-ai/blob/main/examples/offline-mode/readme-litellm.md "readme-litellm.md"
+
+
+[readme-ai]: https://github.com/eli64s/readme-ai "readme-ai"
+[pyflink]: https://github.com/eli64s/pyflink-poc "pyflink-poc"
+[postgres]: https://github.com/jwills/buenavista "Buenavista"
+[java]: https://github.com/avjinder/Minimal-Todo "minimal-todo"
+[kotlin]: https://github.com/rumaan/file.io-Android-Client "android-client"
+[docker-golang]: https://github.com/olliefr/docker-gs-ping "docker-gs-ping"
+[vercel]: https://github.com/PiyushSuthar/github-readme-quotes "github-readme-quotes"
+[streamlit]: https://github.com/eli64s/readme-ai-streamlit "readme-ai-streamlit"
+[fastapi]: https://github.com/FerrariDG/async-ml-inference "async-ml-inference"
+[litellm]: https://github.com/BerriAI/litellm "offline-mode"
diff --git a/docs/docs/assets/img/project-structure/file-summaries.png b/docs/docs/assets/img/project-structure/file-summaries.png
index 59061690..62f5fdc0 100644
Binary files a/docs/docs/assets/img/project-structure/file-summaries.png and b/docs/docs/assets/img/project-structure/file-summaries.png differ
diff --git a/examples/anthropic/.gitkeep b/examples/anthropic/.gitkeep
new file mode 100644
index 00000000..e69de29b
diff --git a/examples/gemini/.gitkeep b/examples/gemini/.gitkeep
new file mode 100644
index 00000000..e69de29b
diff --git a/examples/headers/ascii.md b/examples/headers/ascii.md
new file mode 100644
index 00000000..4fa9b697
--- /dev/null
+++ b/examples/headers/ascii.md
@@ -0,0 +1,823 @@
++โโโโโโ โโโโโโ โโ โโโโ โโ โโ โโโโโโ โโ โโโโโโ +โโ โโ โโ โโโโ โโ โโ โโโ โโโ โโ โโโโ โโ +โโโโโโ โโโโ โโ โโ โโ โโ โโ โ โโ โโโโ โโโโโโ โโ โโ โโ +โโ โโ โโ โโโโโโ โโ โโ โโ โโ โโ โโโโโโ โโ +โโ โโ โโโโโโ โโ โโ โโโโ โโ โโ โโโโโโ โโ โโ โโโโโโ ++
+ โฏ REPLACE-ME
+
+
+
++ +
+โฏ REPLACE-ME
+
+---
+
+## ๐พ Features
+
+โฏ REPLACE-ME
+
+---
+
+## ๐ Project Structure
+
+```sh
+โโโ readme-ai/
+ โโโ .github
+ โ โโโ release-drafter.yml
+ โ โโโ workflows
+ โโโ CHANGELOG.md
+ โโโ CODE_OF_CONDUCT.md
+ โโโ CONTRIBUTING.md
+ โโโ Dockerfile
+ โโโ LICENSE
+ โโโ Makefile
+ โโโ README.md
+ โโโ docs
+ โ โโโ .overrides
+ โ โโโ assets
+ โ โโโ blog
+ โ โโโ configuration
+ โ โโโ contributing.md
+ โ โโโ css
+ โ โโโ examples
+ โ โโโ faq.md
+ โ โโโ guides
+ โ โโโ index.md
+ โ โโโ js
+ โ โโโ llms
+ โ โโโ philosophy.md
+ โ โโโ quickstart
+ โ โโโ troubleshooting.md
+ โ โโโ usage
+ โ โโโ why.md
+ โโโ examples
+ โ โโโ readme-ai.md
+ โ โโโ readme-chunking.md
+ โ โโโ readme-docker-go.md
+ โ โโโ readme-fastapi-redis.md
+ โ โโโ readme-gemini.md
+ โ โโโ readme-header-padded.md
+ โ โโโ readme-java.md
+ โ โโโ readme-javascript.md
+ โ โโโ readme-kotlin.md
+ โ โโโ readme-litellm.md
+ โ โโโ readme-local.md
+ โ โโโ readme-mlops.md
+ โ โโโ readme-offline.md
+ โ โโโ readme-ollama.md
+ โ โโโ readme-postgres.md
+ โ โโโ readme-python-v0.5.87.md
+ โ โโโ readme-python.md
+ โ โโโ readme-readmeai.md
+ โ โโโ readme-rust-c.md
+ โ โโโ readme-sqlmesh.md
+ โ โโโ readme-streamlit-dalle.md
+ โ โโโ readme-streamlit-minimal.md
+ โ โโโ readme-streamlit-v0.5.88.md
+ โ โโโ readme-streamlit-v0.588.md
+ โ โโโ readme-streamlit.md
+ โ โโโ readme-typescript.md
+ โ โโโ readme-vercel.md
+ โโโ mkdocs.yml
+ โโโ noxfile.py
+ โโโ poetry.lock
+ โโโ pyproject.toml
+ โโโ readmeai
+ โ โโโ __init__.py
+ โ โโโ __main__.py
+ โ โโโ cli
+ โ โโโ config
+ โ โโโ errors.py
+ โ โโโ generators
+ โ โโโ ingestion
+ โ โโโ logger.py
+ โ โโโ models
+ โ โโโ parsers
+ โ โโโ postprocessor
+ โ โโโ preprocessor
+ โ โโโ readers
+ โ โโโ templates
+ โ โโโ utils
+ โโโ scripts
+ โ โโโ clean.sh
+ โ โโโ docker.sh
+ โ โโโ pypi.sh
+ โ โโโ run_batch.sh
+ โ โโโ run_batch_random.sh
+ โโโ setup
+ โ โโโ environment.yaml
+ โ โโโ requirements.txt
+ โ โโโ setup.sh
+ โโโ tests
+ โโโ __init__.py
+ โโโ cli
+ โโโ config
+ โโโ conftest.py
+ โโโ generators
+ โโโ ingestion
+ โโโ models
+ โโโ parsers
+ โโโ postprocessor
+ โโโ preprocessor
+ โโโ readers
+ โโโ templates
+ โโโ test_errors.py
+ โโโ test_logger.py
+ โโโ test_main.py
+ โโโ utils
+```
+
+
+### ๐ Project Index
+README-AI/+++
++ +mkdocs.yml ++ โฏ REPLACE-ME+ +Dockerfile ++ โฏ REPLACE-ME+ +Makefile ++ โฏ REPLACE-ME+ +pyproject.toml ++ โฏ REPLACE-ME+ +noxfile.py ++ โฏ REPLACE-ME
+++
++ +setup.sh ++ โฏ REPLACE-ME+ +requirements.txt ++ โฏ REPLACE-ME+ +environment.yaml ++ โฏ REPLACE-ME
+++
++ +run_batch.sh ++ โฏ REPLACE-ME+ +pypi.sh ++ โฏ REPLACE-ME+ +clean.sh ++ โฏ REPLACE-ME+ +run_batch_random.sh ++ โฏ REPLACE-ME+ +docker.sh ++ โฏ REPLACE-ME
+++
++ +release-drafter.yml ++ โฏ REPLACE-ME++workflows
++++
++ +coverage.yml ++ โฏ REPLACE-ME+ +mkdocs.yml ++ โฏ REPLACE-ME+ +release-pipeline.yml ++ โฏ REPLACE-ME+ +release-drafter.yml ++ โฏ REPLACE-ME
+++
++ +logger.py ++ โฏ REPLACE-ME+ +errors.py ++ โฏ REPLACE-ME+ +__main__.py ++ โฏ REPLACE-ME++parsers
++++
++ +properties.py ++ โฏ REPLACE-ME+ +factory.py ++ โฏ REPLACE-ME+ +docker.py ++ โฏ REPLACE-ME+ +npm.py ++ โฏ REPLACE-ME+ +cpp.py ++ โฏ REPLACE-ME+ +gradle.py ++ โฏ REPLACE-ME+ +swift.py ++ โฏ REPLACE-ME+ +python.py ++ โฏ REPLACE-ME+ +go.py ++ โฏ REPLACE-ME+ +maven.py ++ โฏ REPLACE-ME+ +base.py ++ โฏ REPLACE-ME+ +rust.py ++ โฏ REPLACE-ME++ingestion
++++
++ +models.py ++ โฏ REPLACE-ME+ +file_processor.py ++ โฏ REPLACE-ME+ +metadata_extractor.py ++ โฏ REPLACE-ME+ +pipeline.py ++ โฏ REPLACE-ME++config
++++
++ +constants.py ++ โฏ REPLACE-ME+ +settings.py ++ โฏ REPLACE-ME++settings
++++
++ +prompts.toml ++ โฏ REPLACE-ME+ +parsers.toml ++ โฏ REPLACE-ME+ +quickstart.toml ++ โฏ REPLACE-ME+ +quickstart_config.toml ++ โฏ REPLACE-ME+ +tooling.toml ++ โฏ REPLACE-ME+ +languages.toml ++ โฏ REPLACE-ME+ +config.toml ++ โฏ REPLACE-ME+ +tool_config.toml ++ โฏ REPLACE-ME+ +ignore_list.toml ++ โฏ REPLACE-ME+ +commands.toml ++ โฏ REPLACE-ME++postprocessor
++++
++ +markdown_converter.py ++ โฏ REPLACE-ME+ +response_cleaner.py ++ โฏ REPLACE-ME++utils
++++
++ +file_handler.py ++ โฏ REPLACE-ME+ +file_resource.py ++ โฏ REPLACE-ME+ +helpers.py ++ โฏ REPLACE-ME++models
++++
++ +offline.py ++ โฏ REPLACE-ME+ +gemini.py ++ โฏ REPLACE-ME+ +tokens.py ++ โฏ REPLACE-ME+ +dalle.py ++ โฏ REPLACE-ME+ +factory.py ++ โฏ REPLACE-ME+ +prompts.py ++ โฏ REPLACE-ME+ +openai.py ++ โฏ REPLACE-ME+ +anthropic.py ++ โฏ REPLACE-ME+ +base.py ++ โฏ REPLACE-ME++cli
++++
++ +options.py ++ โฏ REPLACE-ME+ +main.py ++ โฏ REPLACE-ME++templates
++++
++ +table_of_contents.py ++ โฏ REPLACE-ME+ +header.py ++ โฏ REPLACE-ME+ +base.py ++ โฏ REPLACE-ME+ +quickstart.py ++ โฏ REPLACE-ME++generators
++++
++ +tree.py ++ โฏ REPLACE-ME+ +emojis.py ++ โฏ REPLACE-ME+ +builder.py ++ โฏ REPLACE-ME+ +badges.py ++ โฏ REPLACE-ME+ +tables.py ++ โฏ REPLACE-ME+ +banner.py ++ โฏ REPLACE-ME+ +quickstart.py ++ โฏ REPLACE-ME++svg
++++
++ +skill_icons.json ++ โฏ REPLACE-ME+ +shieldsio_icons.json ++ โฏ REPLACE-ME++readers
+++++git
++++
++ +metadata.py ++ โฏ REPLACE-ME+ +providers.py ++ โฏ REPLACE-ME+ +repository.py ++ โฏ REPLACE-ME++preprocessor
++++
++ +file_filter.py ++ โฏ REPLACE-ME+ +directory_cleaner.py ++ โฏ REPLACE-ME+ +document_cleaner.py ++ โฏ REPLACE-ME
](https://python-poetry.org/)
+
+```sh
+โฏ poetry install
+```
+
+
+**Using `pip`** [](https://pypi.org/project/pip/)
+
+```sh
+โฏ pip install -r setup/requirements.txt
+```
+
+
+**Using `conda`** [](https://docs.conda.io/)
+
+```sh
+โฏ conda env create -f setup/environment.yaml
+```
+
+
+**Using `docker`** [](https://www.docker.com/)
+
+```sh
+โฏ docker build -t eli64s/readme-ai .
+```
+
+
+
+
+### ๐ค Usage
+Run readme-ai using the following command:
+**Using `poetry`** [](https://python-poetry.org/)
+
+```sh
+โฏ poetry run python {entrypoint}
+```
+
+
+**Using `pip`** [](https://pypi.org/project/pip/)
+
+```sh
+โฏ python {entrypoint}
+```
+
+
+**Using `conda`** [](https://docs.conda.io/)
+
+```sh
+โฏ conda activate {venv}
+โฏ python {entrypoint}
+```
+
+
+**Using `docker`** [](https://www.docker.com/)
+
+```sh
+โฏ docker run -it {image_name}
+```
+
+
+### ๐งช Testing
+Run the test suite using the following command:
+**Using `poetry`** [](https://python-poetry.org/)
+
+```sh
+โฏ poetry run pytest
+```
+
+
+**Using `pip`** [](https://pypi.org/project/pip/)
+
+```sh
+โฏ pytest
+```
+
+
+**Using `conda`** [](https://docs.conda.io/)
+
+```sh
+โฏ conda activate {venv}
+โฏ pytest
+```
+
+
+---
+## ๐ Project Roadmap
+
+- [X] **`Task 1`**:
+
+
+ Elevating data processing and API excellence. +
+
+
Built with the tools and technologies:
+
+
+
+
+
+
+
+
+
+
+
+
BUENAVISTA/+++
++ +dev-requirements.txt +- Enables fast data processing and API development by specifying necessary dependencies +
- It facilitates seamless integration of DuckDB, FastAPI, psycopg, psycopg-pool, and others for efficient data querying and web service creation within the project architecture.+ +setup.py +- Define and configure project metadata for Buenavista, including package name, version, description, authorship details, and dependencies +
- This setup file enables seamless integration and distribution of the project, ensuring correct attribution, documentation, and installation of required components.
+++
++ +download_data.sh +Download example data (iris.parquet and chinook.db) to the ./data directory using curl commands. ++ +Dockerfile +- Facilitates building and running Python applications within a Docker container +
- Sets up necessary environment variables, installs dependencies, configures time zone, and specifies entry point for the application
- This file aids in creating a consistent and reproducible environment for deploying the project.+ +Makefile +- The Makefile in the docker directory facilitates building the Docker image for the project and orchestrating Docker containers +
- It streamlines tasks like building the image, starting containers, and downloading example data
- This file plays a crucial role in managing the project's Docker-related operations.+ +docker-compose.yml +Define Docker services for cloud-based development environment with CloudBeaver and Buenavista, ensuring seamless integration and accessibility. +
+++
++ +bv_dialects.py +- Enhances SQL dialects for DuckDB, Postgres, and Trino, enabling custom functions, token handling, and command transformations +
- Modifies Trino with keywords and functions, extends Postgres, and tailors DuckDB command handling
- Improves DuckDB's generator with custom transforms for expressions like CurrentTimestamp and ToISO8601, ensuring accurate SQL generation.+ +core.py +- Defines core classes for representing query results, managing sessions, and translating data sources +
- Implements methods for executing SQL queries, handling sessions, and checking JSON validity
- Facilitates interaction between data sources and query results within the project architecture.+ +postgres.py +- The code file buenavista/postgres.py provides functionality for handling server responses in the PG wire protocol +
- It includes byte codes for various responses such as authentication requests, data rows, error responses, and more
- This code file plays a crucial role in managing communication between the project and a PostgreSQL database server, ensuring smooth interaction and data exchange.+ +rewrite.py +- Enables SQL query rewriting based on defined relations +
- Parses and transforms SQL expressions using specified dialects for reading and writing
- Supports custom relation definitions for subquery generation
- Allows for seamless integration with Presto and DuckDB dialects.++backends
++++
++ +postgres.py +- Facilitates PostgreSQL interactions, defining QueryResult and Session classes for managing data retrieval and connections +
- Implements functions for executing SQL queries, loading data into DataFrames, and handling transactions within the database
- The PGConnection class manages connection pooling and session creation, ensuring efficient communication with the PostgreSQL server.+ +duckdb.py +- The code file in buenavista/backends/duckdb.py handles DuckDB data types, query results, and session management for the project's DuckDB connection +
- It converts Arrow data types to Buenavista types, processes query results, and manages SQL execution within a transactional context.++http
++++
++ +type_mapping.py +- Defines type mappings and converters for different data types in the Buenavista project, facilitating the conversion of types to Trino-compatible formats +
- The code file `type_mapping.py` contains functions to handle various data types and their representations in the project, ensuring seamless data type conversion within the codebase architecture.+ +context.py +- Facilitates request handling, session management, and SQL execution within the project context +
- Manages headers, session pools, and transaction IDs for efficient interaction with external data sources
- Enables execution of SQL queries and handles transaction lifecycle while maintaining session integrity.+ +schemas.py +- Defines data models for handling HTTP responses in a camel-case format, enhancing readability and consistency across the codebase +
- This schema file organizes structures for client types, columns, statement statistics, query errors, warnings, and result handling for efficient data processing and error management in the project architecture.+ +main.py +- Implements HTTP endpoints to execute SQL queries, returning results in Buenavista's backend system +
- Handles query execution, result conversion, and error handling
- Enables clients to interact with the system through a RESTful API, providing information on the system's status and executing SQL statements.++examples
++++
++ +duckdb_postgres.py +- Rewrite SQL queries for PostgreSQL compatibility using DuckDB, enabling seamless integration with BuenaVista servers +
- This code file creates a server instance with rewriter support, allowing users to interact with DuckDB databases via the BuenaVista platform effortlessly.+ +duckdb_http.py +- Enables rewriting and serving HTTP queries using FastAPI, DuckDB, and Buenavista's custom dialects +
- Handles requests for JDBC metadata like tables, schemas, and columns
- Supports running DuckDB in-memory or from a file
- Integrates with Buenavista's Presto API for query processing.+ +postgres_proxy.py +- The code file establishes a proxy server to handle PostgreSQL connections +
- It configures a BuenaVista server to listen on a specific address and port, forwarding requests to a PostgreSQL database
- The file plays a critical role in the project's architecture by enabling communication between clients and the database through a proxy mechanism.
++++workflows
++++
++ +push.yaml +Automate the Docker image build and push process to ghcr.io based on branch updates. ++ +main.yml +- Automates unit testing for Buena Vista app on GitHub +
- Runs tests on PRs to main branch using multiple Python versions
- Installs dependencies, sets up Python environment, and executes tests with pytest.
](https://pypi.org/project/pip/)
+
+```sh
+โฏ pip install -r dev-requirements.txt
+```
+
+
+**Using `docker`** [](https://www.docker.com/)
+
+```sh
+โฏ docker build -t jwills/buenavista .
+```
+
+
+
+
+### Usage
+Run buenavista using the following command:
+**Using `pip`** [](https://pypi.org/project/pip/)
+
+```sh
+โฏ python {entrypoint}
+```
+
+
+**Using `docker`** [](https://www.docker.com/)
+
+```sh
+โฏ docker run -it {image_name}
+```
+
+
+### Testing
+Run the test suite using the following command:
+**Using `pip`** [](https://pypi.org/project/pip/)
+
+```sh
+โฏ pytest
+```
+
+
+---
+## Project Roadmap
+
+- [X] **`Task 1`**:
+ + Streamline Tasks, Empower Productivity! +
+
+
Built with the tools and technologies:
+
+
+
+
+
+
MINIMAL-TODO/+++
++ +build.gradle +- Configure common build options and dependencies across all modules in the project, including repositories like jcenter and Google, using the build.gradle file +
- This file manages top-level configurations for sub-projects/modules such as Android tools, Google services, and Butter Knife plugin, ensuring consistent settings for the entire codebase architecture.+ +gradlew.bat +Initialize Gradle setup on Windows by locating Java and setting necessary environment variables for the project to run smoothly. ++ +settings.gradle +- Defines project modules for Gradle build system, specifically including the 'app' module +
- Organizes project structure by specifying which modules are part of the build
- Helps Gradle manage dependencies and build configurations for different modules within the project.
+++
++ +proguard-rules.pro +- Define and maintain project-specific ProGuard rules to optimize and secure the Android app's code +
- Refine the default ProGuard flags with tailored settings for Google libraries and avoid warnings for specific classes
- Ensure that the app's code remains efficient and protected during the build process.+ +build.gradle +- Configure Android application settings, dependencies, and build types to support the project's functionality and integrate necessary plugins for smooth operation. ++ +google-services.json +- Define Google services configuration for Android apps in the provided JSON file +
- The file specifies project info, clients, and associated services such as analytics and cloud messaging
- It serves as a crucial configuration file for integrating Google services into the Android app architecture.+ +app-release.apk +- Summary: +The provided code file serves as a critical component within the project's architecture, facilitating seamless communication and integration between various modules +
- It plays a pivotal role in orchestrating data flow and enhancing the overall functionality of the codebase.++src
+++++androidTest
+++++java
+++++com
+++++example
+++++avjindersinghsekhon
+++++minimaltodo
++++
++ +TestStoreRetrieveData.java +- Verifies and ensures data integrity by writing and reading items to/from storage in the app +
- It confirms the correct storage and retrieval of data items, validates JSONArray conversion, and guarantees the accuracy of data in storage
- The code is vital for maintaining the reliability of data operations within the app's functionality.+ +ApplicationTest.java +- Tests the Android application's fundamental functionality by extending the ApplicationTestCase class +
- This class helps validate the core behavior of the application, ensuring proper functionality before deployment.+ +TestTodoItem.java +Verifies and tests functionality of ToDoItem class, ensuring construction and marshalling of objects to JSON, as well as unmarshalling from JSON data. +++main
+++++java
+++++com
+++++example
+++++avjindersinghsekhon
+++++minimaltodo
+++++Settings
++++
++ +SettingsFragment.java +- Manages user settings and preferences, including a night mode feature, for the mobile app +
- Captures user selection changes and triggers interface updates accordingly
- Enables customization of app themes and analytics tracking for user behavior insights
- Centralizes and organizes user preferences for a seamless user experience.+ +SettingsActivity.java +- Implements the SettingsActivity class in the app structure +
- Manages settings presentation and navigation, including theme configuration and back navigation actions, providing a seamless user experience within the application's settings section.++Reminder
++++
++ +ReminderFragment.java +- Implements a ReminderFragment in the app to handle reminders for to-do items +
- Allows users to view and manage reminders, including snoozing and marking tasks as done
- Handles theme preferences, data storage, and notification services
- Includes functionalities for modifying reminder timings and updating to-do items.+ +ReminderActivity.java +Generates the reminder UI layout and initializes the initial fragment for the Minimal Todo app. +++About
++++
++ +AboutActivity.java +- Handle the creation and display of the About section in the Minimal Todo app, including version information and contact details +
- This code ensures proper theming, toolbar setup, and navigation functionalities for a cohesive user experience within the app's architecture.+ +AboutFragment.java +- Manages display of app information, version, and feedback contact in the About section of the project +
- Utilizes the AppDefaultFragment superclass to ensure consistent UI across the app
- Interacts with the AnalyticsApplication to track user actions for analytics purposes.++AddToDo
++++
++ +AddToDoFragment.java +- The provided code file `AddToDoFragment.java` in the `AddToDo` package is responsible for managing the user interface related to adding a new to-do item in the MinimalToDo project +
- It handles user input, interactions, and transitions within the add to-do functionality
- This fragment is crucial for enabling users to efficiently create and manage their tasks within the application.+ +AddToDoActivity.java +- Enables adding to-dos via a user-friendly interface +
- Extends the base activity to set up the layout and initial fragment
- Implementations for onCreate, contentViewLayoutRes, createInitialFragment, and onResume maintain the seamless flow for users.++Main
++++
++ +MainActivity.java +- Defines the main screen behavior of the app, handling toolbar setup, menu creation, and item selection actions +
- It navigates to other activities like About and Settings when corresponding menu items are selected.+ +CustomRecyclerScrollViewListener.java +- Implements a scroll listener for RecyclerView to toggle visibility of elements based on scroll direction +
- Integrates show and hide actions to manage view visibility dynamically during scrolling.+ +MainFragment.java +- The MainFragment.java file in the project serves as a central component responsible for managing the user interface elements and interactions within the application +
- It coordinates the display of tasks, animations, and user feedback mechanisms, ensuring a seamless user experience
- This file encapsulates the key functionalities of the main screen of the app, facilitating efficient task management and user engagement.++Analytics
++++
++ +AnalyticsApplication.java +- Facilitates sending analytics data to Google Analytics by tracking screen views and events in the Android application +
- Manages the creation and configuration of a Google Analytics tracker, ensuring proper reporting of user interactions and app usage for data-driven insights.++AppDefault
++++
++ +AppDefaultFragment.java +Generates default fragments in the project architecture to maintain a consistent layout across different screens. ++ +AppDefaultActivity.java +- Defines a template for activities in the app, setting up the initial fragment and content view layout +
- The abstract class specifies methods to define layout and create the first fragment, binding the core structure of app screens to maintain consistency across activities.++Utility
++++
++ +TodoNotificationService.java +- Manages creation and display of notifications for to-do items, including handling user interactions +
- Uses Android's NotificationManager to show notifications with title and icon
- Enables users to interact with notifications for reminders and deletion
- Key components include IntentService and Notification.Builder for seamless notification handling within the app's architecture.+ +ScrollingFABBehaviour.java +- Enables floating action button behavior based on scrolling events in the app's UI, ensuring its position corresponds to toolbar movements +
- Decides the floating button view adjustment by detecting interactions with various UI components like Snackbar and Toolbar.+ +ToDoItem.java +- Defines a data model for to-do items with text, description, reminder, color, date, and identifier properties +
- Supports conversion to/from JSON format
- Allows setting and getting text, description, reminder status, color, date, and identifier.+ +CustomTextInputLayout.java +- Enhances TextInputLayout behavior to preserve hint value when EditText is added +
- Resets hint if changed programmatically for consistent display
- Improves user experience by maintaining hint visibility, avoiding loss of information.+ +StoreRetrieveData.java +- Manages storage and retrieval of ToDoItems using JSON serialization for the MinimalToDo app +
- Handles saving items to a file and loading them back into the app, supporting basic file I/O operations and JSON parsing with error handling.+ +Utils.java +Calculates toolbar height for the Android app's UI based on specified action bar size attribute in the project's utility class. ++ +DeleteNotificationService.java +- Handles deleting notification-triggered to-do items by retrieving, updating, and saving data in shared preferences +
- Manages a list of to-do items, identifies the item to delete, and saves the updated list
- Maintains a notification service for to-do items in the Minimal ToDo app, ensuring data integrity and accurate deletion operations.+ +ItemTouchHelperClass.java +- Enables drag-and-drop and swipe functionalities for RecyclerView items, facilitating reordering and deletion +
- This class acts as a mediator, allowing seamless interaction between user actions and the RecyclerView adapter, enhancing the user experience within the to-do list app.+ +PreferenceKeys.java +Defines preference keys for the project settings, facilitating easy access to the night mode preference key stored in resources. ++ +RecyclerViewEmptySupport.java +- Enables a RecyclerView to display an empty view when no items are present +
- Automatically shows or hides the empty view based on the adapter's item count
- Integrated with observer methods to handle changes in data set
- Enhances user experience by providing visual feedback in empty states, contributing to a more informative UI.
](https://gradle.org/)
+
+```sh
+โฏ gradle build
+```
+
+
+
+
+### ๐ค Usage
+Run Minimal-Todo using the following command:
+**Using `gradle`** [](https://gradle.org/)
+
+```sh
+โฏ gradle run
+```
+
+
+### ๐งช Testing
+Run the test suite using the following command:
+**Using `gradle`** [](https://gradle.org/)
+
+```sh
+โฏ gradle test
+```
+
+
+---
+## ๐ Project Roadmap
+
+- [X] **`Task 1`**:
++ Streamlining data flow with PyFlink power! +
+
+
Built with the tools and technologies:
+
+
+
+
+
+
+
+
PYFLINK-POC/+++
++ +requirements.txt +- Enables real-time data streaming and processing by integrating Apache Flink and Apache Kafka with asynchronous HTTP requests +
- Facilitates efficient data handling and manipulation using Pandas library while leveraging asyncio for concurrent operations
- The codebase emphasizes scalability and performance in handling large datasets through its lightweight and responsive architecture.+ +setup.py +- Configures project dependencies and packages for STREAM-ON through setup.py +
- Sets up various packages for documentation, style checking, and testing, enhancing the overall project structure and management.
+++
++ +setup.sh +- Facilitates setup and configuration of project dependencies and environment variables +
- Installs Java 11, Python 3.7, and PyFlink, sets environment variables, and creates aliases for zsh
- Enables seamless integration and execution of PyFlink within the development environment.
+++
++ +run.sh +Initiate Flink cluster, execute PyFlink job, and terminate Flink cluster using the provided run.sh script. ++ +clean.sh +- Clean script file removes backup files, Python caches, build artifacts, Jupyter notebook checkpoints, and pytest cache from the project directory +
- It ensures the project remains clutter-free by deleting unnecessary files and directories to streamline development and maintenance processes.
+++
++ +flink-config.yaml +Define Flink cluster configuration parameters in the provided YAML file to ensure optimal resource allocation, fault tolerance, and scalability for distributed data processing. ++ +conf.toml +Define project-wide configuration constants for Kafka and Flink services in the conf.toml file. +
+++
++ +alerts_handler.py +- Handles the sending of alerts to an API in batches using asyncio and aiohttp +
- The code serializes alerts using Apache Avro before sending them to the designated API endpoint
- Additionally, it includes functionality to buffer alerts and send them in batches when a certain threshold is reached.+ +logger.py +- The Logger class provides structured logging capabilities for the project, enabling different log levels and colored output +
- It enhances the codebase architecture by ensuring effective logging of critical information, warnings, and errors, thereby facilitating debugging and monitoring activities across the system.+ +consumer.py +- Implements data stream processing with Apache Flink and Python, orchestrating streaming and batch data comparisons for anomaly detection +
- Manages state and fault tolerance through checkpointing and processes flagged records to trigger alerts, enhancing the real-time monitoring system.
](https://pypi.org/project/pip/)
+
+```sh
+โฏ pip install -r requirements.txt
+```
+
+
+
+
+### ๐ค Usage
+Run pyflink-poc using the following command:
+**Using `pip`** [](https://pypi.org/project/pip/)
+
+```sh
+โฏ python {entrypoint}
+```
+
+
+### ๐งช Testing
+Run the test suite using the following command:
+**Using `pip`** [](https://pypi.org/project/pip/)
+
+```sh
+โฏ pytest
+```
+
+
+---
+## ๐ Project Roadmap
+
+- [X] **`Task 1`**:
++ README magic, AI-powered documentation made easy! +
+
+
Built with the tools and technologies:
+
+
+
+
+
+
+
+
+
README-AI-STREAMLIT/+++
++ +Makefile +- Facilitates project maintenance and development tasks such as cleaning artifacts, managing dependencies with Poetry, formatting and linting codebase, running tests, and launching the Streamlit application locally +
- Additionally, provides utility commands for version control tasks like displaying git logs, removing files from the cache, and exporting requirements.+ +pyproject.toml +Generates README files automatically for the project using Streamlit and GPT models, enhancing documentation efficiency and consistency across the codebase. +
+++
++ +clean.sh +- Cleans various artifacts like build files, Python artifacts, test and coverage artifacts, backup and cache files from the project directory +
- It provides commands to remove specific types of files, enhancing the project's cleanliness and maintainability.
+++
++ +cli.py +- Defines CLI configuration settings for the README-AI Streamlit web app +
- Presents a user-friendly interface to input repository details, API key, and various styling options for badge, project logo, and header
- Facilitates README generation with customizable parameters like language model, temperature, and tree depth
- Allows users to generate or reset the README file.+ +app.py +- The code file `app.py` serves as a Streamlit web app for the README-AI CLI Python package +
- It enables users to generate README.md files powered by AI, providing a user-friendly interface to customize and download the generated content
- The app integrates with various settings and commands to facilitate seamless README generation.+ +commands.py +- Generates CLI commands for the README-AI Streamlit web app, building and executing commands to process repository data +
- Handles command execution, capturing and displaying output while processing repositories using specified parameters like API key, alignment, badge style, logo, and more.
](https://python-poetry.org/)
+
+```sh
+โฏ poetry install
+```
+
+
+
+
+### ๐ค Usage
+Run readme-ai-streamlit using the following command:
+**Using `poetry`** [](https://python-poetry.org/)
+
+```sh
+โฏ poetry run python {entrypoint}
+```
+
+
+### ๐งช Testing
+Run the test suite using the following command:
+**Using `poetry`** [](https://python-poetry.org/)
+
+```sh
+โฏ poetry run pytest
+```
+
+
+---
+## ๐ Project Roadmap
+
+- [X] **`Task 1`**:
-
+
Unleash Efficiency, Embrace Innovation!
diff --git a/examples/logos/dalle-rag.png b/examples/logos/dalle-rag.png new file mode 100644 index 00000000..e0e8ed99 Binary files /dev/null and b/examples/logos/dalle-rag.png differ diff --git a/examples/readme-vercel.md b/examples/logos/dalle.md similarity index 99% rename from examples/readme-vercel.md rename to examples/logos/dalle.md index 582a423e..4ba582d3 100644 --- a/examples/readme-vercel.md +++ b/examples/logos/dalle.md @@ -1,5 +1,5 @@
-
+
Code consistency, creativity, and motivation unleashed!
diff --git a/examples/logos/dalle.png b/examples/logos/dalle.png new file mode 100644 index 00000000..276d345f Binary files /dev/null and b/examples/logos/dalle.png differ diff --git a/examples/readme-offline.md b/examples/offline-mode/readme-ai.md similarity index 100% rename from examples/readme-offline.md rename to examples/offline-mode/readme-ai.md diff --git a/examples/offline-mode/readme-litellm.md b/examples/offline-mode/readme-litellm.md new file mode 100644 index 00000000..d002420c --- /dev/null +++ b/examples/offline-mode/readme-litellm.md @@ -0,0 +1,4349 @@ +
+
+
+ โฏ REPLACE-ME
+
+
Built with the tools and technologies:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
โฏ REPLACE-ME
+
+---
+
+## ๐พ Features
+
+โฏ REPLACE-ME
+
+---
+
+## ๐ Project Structure
+
+```sh
+โโโ litellm/
+ โโโ .github
+ โโโ Dockerfile
+ โโโ LICENSE
+ โโโ README.md
+ โโโ ci_cd
+ โโโ codecov.yaml
+ โโโ cookbook
+ โโโ db_scripts
+ โโโ deploy
+ โโโ docker
+ โโโ docker-compose.yml
+ โโโ docs
+ โโโ enterprise
+ โโโ index.yaml
+ โโโ litellm
+ โโโ litellm-js
+ โโโ model_prices_and_context_window.json
+ โโโ mypy.ini
+ โโโ package-lock.json
+ โโโ package.json
+ โโโ poetry.lock
+ โโโ prometheus.yml
+ โโโ proxy_server_config.yaml
+ โโโ pyproject.toml
+ โโโ pyrightconfig.json
+ โโโ render.yaml
+ โโโ requirements.txt
+ โโโ ruff.toml
+ โโโ schema.prisma
+ โโโ security.md
+ โโโ tests
+ โโโ ui
+```
+
+
+### ๐ Project Index
+LITELLM/+++
++ +render.yaml ++ โฏ REPLACE-ME+ +pyrightconfig.json ++ โฏ REPLACE-ME+ +requirements.txt ++ โฏ REPLACE-ME+ +codecov.yaml ++ โฏ REPLACE-ME+ +proxy_server_config.yaml ++ โฏ REPLACE-ME+ +Dockerfile ++ โฏ REPLACE-ME+ +schema.prisma ++ โฏ REPLACE-ME+ +pyproject.toml ++ โฏ REPLACE-ME+ +mypy.ini ++ โฏ REPLACE-ME+ +package-lock.json ++ โฏ REPLACE-ME+ +package.json ++ โฏ REPLACE-ME+ +ruff.toml ++ โฏ REPLACE-ME+ +docker-compose.yml ++ โฏ REPLACE-ME+ +model_prices_and_context_window.json ++ โฏ REPLACE-ME+ +prometheus.yml ++ โฏ REPLACE-ME+ +index.yaml ++ โฏ REPLACE-ME
+++
++ +requirements.txt ++ โฏ REPLACE-ME+ +Dockerfile ++ โฏ REPLACE-ME+ +admin.py ++ โฏ REPLACE-ME+ +package-lock.json ++ โฏ REPLACE-ME+ +package.json ++ โฏ REPLACE-ME++litellm-dashboard
++++
++ +build_ui_custom_path.sh ++ โฏ REPLACE-ME+ +tailwind.config.js ++ โฏ REPLACE-ME+ +next.config.mjs ++ โฏ REPLACE-ME+ +build_ui.sh ++ โฏ REPLACE-ME+ +ui_colors.json ++ โฏ REPLACE-ME+ +tailwind.config.ts ++ โฏ REPLACE-ME+ +package-lock.json ++ โฏ REPLACE-ME+ +package.json ++ โฏ REPLACE-ME+ +tsconfig.json ++ โฏ REPLACE-ME+ +postcss.config.js ++ โฏ REPLACE-ME+ +.eslintrc.json ++ โฏ REPLACE-ME++out
++++
++ +model_hub.txt ++ โฏ REPLACE-ME+ +index.html ++ โฏ REPLACE-ME+ +index.txt ++ โฏ REPLACE-ME+ +404.html ++ โฏ REPLACE-ME+ +model_hub.html ++ โฏ REPLACE-ME+ +onboarding.txt ++ โฏ REPLACE-ME+ +onboarding.html ++ โฏ REPLACE-ME++src
+++++app
++++
++ +layout.tsx ++ โฏ REPLACE-ME+ +page.tsx ++ โฏ REPLACE-ME+ +globals.css ++ โฏ REPLACE-ME++model_hub
++++
++ +page.tsx ++ โฏ REPLACE-ME++onboarding
++++
++ +page.tsx ++ โฏ REPLACE-ME++components
++++
++ +settings.tsx ++ โฏ REPLACE-ME+ +view_users.tsx ++ โฏ REPLACE-ME+ +navbar.tsx ++ โฏ REPLACE-ME+ +request_model_access.tsx ++ โฏ REPLACE-ME+ +networking.tsx ++ โฏ REPLACE-ME+ +edit_user.tsx ++ โฏ REPLACE-ME+ +dashboard_default_team.tsx ++ โฏ REPLACE-ME+ +onboarding_link.tsx ++ โฏ REPLACE-ME+ +create_key_button.tsx ++ โฏ REPLACE-ME+ +view_key_table.tsx ++ โฏ REPLACE-ME+ +key_value_input.tsx ++ โฏ REPLACE-ME+ +user_dashboard.tsx ++ โฏ REPLACE-ME+ +delete_model_button.tsx ++ โฏ REPLACE-ME+ +api_ref.tsx ++ โฏ REPLACE-ME+ +model_hub.tsx ++ โฏ REPLACE-ME+ +model_dashboard.tsx ++ โฏ REPLACE-ME+ +add_fallbacks.tsx ++ โฏ REPLACE-ME+ +pass_through_settings.tsx ++ โฏ REPLACE-ME+ +add_pass_through.tsx ++ โฏ REPLACE-ME+ +leftnav.tsx ++ โฏ REPLACE-ME+ +usage.tsx ++ โฏ REPLACE-ME+ +cache_dashboard.tsx ++ โฏ REPLACE-ME+ +view_user_spend.tsx ++ โฏ REPLACE-ME+ +chat_ui.tsx ++ โฏ REPLACE-ME+ +view_user_team.tsx ++ โฏ REPLACE-ME+ +teams.tsx ++ โฏ REPLACE-ME+ +create_user_button.tsx ++ โฏ REPLACE-ME+ +general_settings.tsx ++ โฏ REPLACE-ME+ +enter_proxy_url.tsx ++ โฏ REPLACE-ME+ +admins.tsx ++ โฏ REPLACE-ME++alerting
++++
++ +alerting_settings.tsx ++ โฏ REPLACE-ME+ +dynamic_form.tsx ++ โฏ REPLACE-ME++model_metrics
++++
++ +time_to_first_token.tsx ++ โฏ REPLACE-ME++model_add
++++
++ +dynamic_form.tsx ++ โฏ REPLACE-ME++budgets
++++
++ +budget_settings.tsx ++ โฏ REPLACE-ME+ +edit_budget_modal.tsx ++ โฏ REPLACE-ME+ +budget_modal.tsx ++ โฏ REPLACE-ME+ +budget_panel.tsx ++ โฏ REPLACE-ME++pages
++++
++ +user.py ++ โฏ REPLACE-ME
+++
++ +Dockerfile.alpine ++ โฏ REPLACE-ME+ +Dockerfile.non_root ++ โฏ REPLACE-ME+ +build_admin_ui.sh ++ โฏ REPLACE-ME+ +.env.example ++ โฏ REPLACE-ME+ +Dockerfile.database ++ โฏ REPLACE-ME+ +Dockerfile.custom_ui ++ โฏ REPLACE-ME+ +entrypoint.sh ++ โฏ REPLACE-ME
+++
++ +check_file_length.py ++ โฏ REPLACE-ME+ +check_files_match.py ++ โฏ REPLACE-ME
+++
++ +utils.py ++ โฏ REPLACE-ME++enterprise_callbacks
++++
++ +generic_api_callback.py ++ โฏ REPLACE-ME+ +example_logging_api.py ++ โฏ REPLACE-ME++cloudformation_stack
++++
++ +litellm.yaml ++ โฏ REPLACE-ME++enterprise_hooks
++++
++ +blocked_user_list.py ++ โฏ REPLACE-ME+ +aporia_ai.py ++ โฏ REPLACE-ME+ +openai_moderation.py ++ โฏ REPLACE-ME+ +secret_detection.py ++ โฏ REPLACE-ME+ +google_text_moderation.py ++ โฏ REPLACE-ME+ +llm_guard.py ++ โฏ REPLACE-ME+ +llama_guard.py ++ โฏ REPLACE-ME+ +banned_keywords.py ++ โฏ REPLACE-ME++secrets_plugins
++++
++ +bitbucket.py ++ โฏ REPLACE-ME+ +microsoft_teams_webhook.py ++ โฏ REPLACE-ME+ +scalingo_api_token.py ++ โฏ REPLACE-ME+ +messagebird.py ++ โฏ REPLACE-ME+ +sendinblue_api_token.py ++ โฏ REPLACE-ME+ +twitch_api_token.py ++ โฏ REPLACE-ME+ +lob.py ++ โฏ REPLACE-ME+ +openai_api_key.py ++ โฏ REPLACE-ME+ +authress_access_key.py ++ โฏ REPLACE-ME+ +pulumi_api_token.py ++ โฏ REPLACE-ME+ +age_secret_key.py ++ โฏ REPLACE-ME+ +heroku_api_key.py ++ โฏ REPLACE-ME+ +telegram_bot_api_token.py ++ โฏ REPLACE-ME+ +atlassian_api_token.py ++ โฏ REPLACE-ME+ +finnhub_access_token.py ++ โฏ REPLACE-ME+ +asana.py ++ โฏ REPLACE-ME+ +nytimes_access_token.py ++ โฏ REPLACE-ME+ +shopify.py ++ โฏ REPLACE-ME+ +gitlab.py ++ โฏ REPLACE-ME+ +finicity.py ++ โฏ REPLACE-ME+ +datadog_access_token.py ++ โฏ REPLACE-ME+ +fastly_api_token.py ++ โฏ REPLACE-ME+ +adafruit.py ++ โฏ REPLACE-ME+ +linear.py ++ โฏ REPLACE-ME+ +readme_api_token.py ++ โฏ REPLACE-ME+ +discord.py ++ โฏ REPLACE-ME+ +rubygems_api_token.py ++ โฏ REPLACE-ME+ +postman_api_token.py ++ โฏ REPLACE-ME+ +freshbooks_access_token.py ++ โฏ REPLACE-ME+ +okta_access_token.py ++ โฏ REPLACE-ME+ +easypost.py ++ โฏ REPLACE-ME+ +yandex.py ++ โฏ REPLACE-ME+ +flutterwave.py ++ โฏ REPLACE-ME+ +hashicorp_tf_api_token.py ++ โฏ REPLACE-ME+ +grafana.py ++ โฏ REPLACE-ME+ +frameio_api_token.py ++ โฏ REPLACE-ME+ +digitalocean.py ++ โฏ REPLACE-ME+ +prefect_api_token.py ++ โฏ REPLACE-ME+ +gocardless_api_token.py ++ โฏ REPLACE-ME+ +codecov_access_token.py ++ โฏ REPLACE-ME+ +kucoin.py ++ โฏ REPLACE-ME+ +jfrog.py ++ โฏ REPLACE-ME+ +clojars_api_token.py ++ โฏ REPLACE-ME+ +sumologic.py ++ โฏ REPLACE-ME+ +contentful_api_token.py ++ โฏ REPLACE-ME+ +dropbox.py ++ โฏ REPLACE-ME+ +confluent.py ++ โฏ REPLACE-ME+ +coinbase_access_token.py ++ โฏ REPLACE-ME+ +airtable_api_key.py ++ โฏ REPLACE-ME+ +bittrex.py ++ โฏ REPLACE-ME+ +flickr_access_token.py ++ โฏ REPLACE-ME+ +new_relic.py ++ โฏ REPLACE-ME+ +sendgrid_api_token.py ++ โฏ REPLACE-ME+ +dynatrace_api_token.py ++ โฏ REPLACE-ME+ +vault.py ++ โฏ REPLACE-ME+ +twitter.py ++ โฏ REPLACE-ME+ +travisci_access_token.py ++ โฏ REPLACE-ME+ +rapidapi_access_token.py ++ โฏ REPLACE-ME+ +pypi_upload_token.py ++ โฏ REPLACE-ME+ +huggingface.py ++ โฏ REPLACE-ME+ +mailgun.py ++ โฏ REPLACE-ME+ +mattermost_access_token.py ++ โฏ REPLACE-ME+ +linkedin.py ++ โฏ REPLACE-ME+ +algolia_api_key.py ++ โฏ REPLACE-ME+ +mapbox_api_token.py ++ โฏ REPLACE-ME+ +alibaba.py ++ โฏ REPLACE-ME+ +shippo_api_token.py ++ โฏ REPLACE-ME+ +planetscale.py ++ โฏ REPLACE-ME+ +github_token.py ++ โฏ REPLACE-ME+ +intercom_api_key.py ++ โฏ REPLACE-ME+ +etsy_access_token.py ++ โฏ REPLACE-ME+ +typeform_api_token.py ++ โฏ REPLACE-ME+ +facebook_access_token.py ++ โฏ REPLACE-ME+ +sentry_access_token.py ++ โฏ REPLACE-ME+ +defined_networking_api_token.py ++ โฏ REPLACE-ME+ +hubspot_api_key.py ++ โฏ REPLACE-ME+ +gitter_access_token.py ++ โฏ REPLACE-ME+ +netlify_access_token.py ++ โฏ REPLACE-ME+ +slack.py ++ โฏ REPLACE-ME+ +launchdarkly_access_token.py ++ โฏ REPLACE-ME+ +databricks_api_token.py ++ โฏ REPLACE-ME+ +duffel_api_token.py ++ โฏ REPLACE-ME+ +squarespace_access_token.py ++ โฏ REPLACE-ME+ +doppler_api_token.py ++ โฏ REPLACE-ME+ +jwt.py ++ โฏ REPLACE-ME+ +gcp_api_key.py ++ โฏ REPLACE-ME+ +kraken_access_token.py ++ โฏ REPLACE-ME+ +snyk_api_token.py ++ โฏ REPLACE-ME+ +droneci_access_token.py ++ โฏ REPLACE-ME+ +sendbird.py ++ โฏ REPLACE-ME+ +adobe.py ++ โฏ REPLACE-ME+ +beamer_api_token.py ++ โฏ REPLACE-ME+ +zendesk_secret_key.py ++ โฏ REPLACE-ME++enterprise_ui
++++
++ +_enterprise_colors.json ++ โฏ REPLACE-ME
+++
++ +Dockerfile.ghcr_base ++ โฏ REPLACE-ME++charts
+++++litellm-helm
++++
++ +Chart.yaml ++ โฏ REPLACE-ME+ +.helmignore ++ โฏ REPLACE-ME+ +values.yaml ++ โฏ REPLACE-ME++charts
++++
++ +postgresql-14.3.1.tgz ++ โฏ REPLACE-ME+ +redis-18.19.1.tgz ++ โฏ REPLACE-ME++templates
++++
++ +deployment.yaml ++ โฏ REPLACE-ME+ +configmap-litellm.yaml ++ โฏ REPLACE-ME+ +NOTES.txt ++ โฏ REPLACE-ME+ +ingress.yaml ++ โฏ REPLACE-ME+ +secret-dbcredentials.yaml ++ โฏ REPLACE-ME+ +service.yaml ++ โฏ REPLACE-ME+ +hpa.yaml ++ โฏ REPLACE-ME+ +serviceaccount.yaml ++ โฏ REPLACE-ME+ +secret-masterkey.yaml ++ โฏ REPLACE-ME+ +_helpers.tpl ++ โฏ REPLACE-ME++kubernetes
++++
++ +kub.yaml ++ โฏ REPLACE-ME+ +service.yaml ++ โฏ REPLACE-ME++azure_resource_manager
++++
++ +main.bicep ++ โฏ REPLACE-ME++azure_marketplace
++++
++ +mainTemplate.json ++ โฏ REPLACE-ME+ +createUiDefinition.json ++ โฏ REPLACE-ME
++++benchmark
++++
++ +benchmark.py ++ โฏ REPLACE-ME++eval_suites_mlflow_autoevals
++++
++ +auto_evals.py ++ โฏ REPLACE-ME++ +misc
++++
++ +sagmaker_streaming.py ++ โฏ REPLACE-ME+ +migrate_proxy_config.py ++ โฏ REPLACE-ME+ +config.yaml ++ โฏ REPLACE-ME+ +openai_timeouts.py ++ โฏ REPLACE-ME+ +dev_release.txt ++ โฏ REPLACE-ME+ +add_new_models.py ++ โฏ REPLACE-ME++community-resources
++++
++ +get_hf_models.py ++ โฏ REPLACE-ME+ +max_tokens.json ++ โฏ REPLACE-ME++litellm_proxy_server
+++++grafana_dashboard
+++++dashboard_1
++++
++ +grafana_dashboard.json ++ โฏ REPLACE-ME++dashboard_v2
++++
++ +grafana_dashboard.json ++ โฏ REPLACE-ME++litellm_router
++++
++ +error_log.txt ++ โฏ REPLACE-ME+ +load_test_proxy.py ++ โฏ REPLACE-ME+ +load_test_queuing.py ++ โฏ REPLACE-ME+ +request_log.txt ++ โฏ REPLACE-ME+ +response_log.txt ++ โฏ REPLACE-ME+ +load_test_router.py ++ โฏ REPLACE-ME++test_questions
++++
++ +question3.txt ++ โฏ REPLACE-ME+ +question2.txt ++ โฏ REPLACE-ME+ +question1.txt ++ โฏ REPLACE-ME++litellm_router_load_test
++++
++ +test_loadtest_router_withs3_cache.py ++ โฏ REPLACE-ME+ +test_loadtest_router.py ++ โฏ REPLACE-ME+ +test_loadtest_openai_client.py ++ โฏ REPLACE-ME++memory_usage
++++
++ +router_memory_usage copy.py ++ โฏ REPLACE-ME+ +router_endpoint.py ++ โฏ REPLACE-ME+ +send_request.py ++ โฏ REPLACE-ME+ +router_memory_usage.py ++ โฏ REPLACE-ME++logging_observability
++++
++ +LiteLLM_Langfuse.ipynb ++ โฏ REPLACE-ME+ +LiteLLM_Lunary.ipynb ++ โฏ REPLACE-ME++litellm-ollama-docker-image
++++
++ +requirements.txt ++ โฏ REPLACE-ME+ +Dockerfile ++ โฏ REPLACE-ME+ +test.py ++ โฏ REPLACE-ME+ +start.sh ++ โฏ REPLACE-ME
++++proxy
++++
++ +package.json ++ โฏ REPLACE-ME+ +tsconfig.json ++ โฏ REPLACE-ME+ +wrangler.toml ++ โฏ REPLACE-ME++src
++++
++ +index.ts ++ โฏ REPLACE-ME++spend-logs
++++
+ ++ +Dockerfile ++ โฏ REPLACE-ME+ +schema.prisma ++ โฏ REPLACE-ME+ +package-lock.json ++ โฏ REPLACE-ME+ +package.json ++ โฏ REPLACE-ME+ +tsconfig.json ++ โฏ REPLACE-ME
+++
++ +update_unassigned_teams.py ++ โฏ REPLACE-ME+ +create_views.py ++ โฏ REPLACE-ME
+++
++ +FUNDING.yml ++ โฏ REPLACE-ME+ +template.yaml ++ โฏ REPLACE-ME+ +dependabot.yaml ++ โฏ REPLACE-ME++workflows
++++
++ +update_release.py ++ โฏ REPLACE-ME+ +locustfile.py ++ โฏ REPLACE-ME+ +lint.yml ++ โฏ REPLACE-ME+ +read_pyproject_version.yml ++ โฏ REPLACE-ME+ +ghcr_helm_deploy.yml ++ โฏ REPLACE-ME+ +auto_update_price_and_context_window_file.py ++ โฏ REPLACE-ME+ +auto_update_price_and_context_window.yml ++ โฏ REPLACE-ME+ +ghcr_deploy.yml ++ โฏ REPLACE-ME+ +load_test.yml ++ โฏ REPLACE-ME+ +interpret_load_test.py ++ โฏ REPLACE-ME+ +redeploy_proxy.py ++ โฏ REPLACE-ME+ +main.yml ++ โฏ REPLACE-ME++actions
+++++helm-oci-chart-releaser
++++
++ +action.yml ++ โฏ REPLACE-ME++ISSUE_TEMPLATE
++++
++ +feature_request.yml ++ โฏ REPLACE-ME+ +bug_report.yml ++ โฏ REPLACE-ME+ +config.yml ++ โฏ REPLACE-ME
+++
++ +_logging.py ++ โฏ REPLACE-ME+ +requirements.txt ++ โฏ REPLACE-ME+ +_version.py ++ โฏ REPLACE-ME+ +cost_calculator.py ++ โฏ REPLACE-ME+ +cost.json ++ โฏ REPLACE-ME+ +timeout.py ++ โฏ REPLACE-ME+ +model_prices_and_context_window_backup.json ++ โฏ REPLACE-ME+ +utils.py ++ โฏ REPLACE-ME+ +py.typed ++ โฏ REPLACE-ME+ +exceptions.py ++ โฏ REPLACE-ME+ +scheduler.py ++ โฏ REPLACE-ME+ +router.py ++ โฏ REPLACE-ME+ +main.py ++ โฏ REPLACE-ME+ +budget_manager.py ++ โฏ REPLACE-ME+ +_redis.py ++ โฏ REPLACE-ME+ +_service_logger.py ++ โฏ REPLACE-ME++types
++++
++ +rerank.py ++ โฏ REPLACE-ME+ +files.py ++ โฏ REPLACE-ME+ +services.py ++ โฏ REPLACE-ME+ +completion.py ++ โฏ REPLACE-ME+ +embedding.py ++ โฏ REPLACE-ME+ +adapter.py ++ โฏ REPLACE-ME+ +caching.py ++ โฏ REPLACE-ME+ +utils.py ++ โฏ REPLACE-ME+ +guardrails.py ++ โฏ REPLACE-ME+ +router.py ++ โฏ REPLACE-ME++integrations
++++
++ +langfuse.py ++ โฏ REPLACE-ME+ +prometheus.py ++ โฏ REPLACE-ME+ +slack_alerting.py ++ โฏ REPLACE-ME+ +argilla.py ++ โฏ REPLACE-ME+ +arize.py ++ โฏ REPLACE-ME++llms
++++
++ +openai.py ++ โฏ REPLACE-ME+ +vertex_ai.py ++ โฏ REPLACE-ME+ +anthropic.py ++ โฏ REPLACE-ME+ +custom_llm.py ++ โฏ REPLACE-ME+ +databricks.py ++ โฏ REPLACE-ME+ +cohere.py ++ โฏ REPLACE-ME+ +ollama.py ++ โฏ REPLACE-ME+ +bedrock.py ++ โฏ REPLACE-ME+ +azure_ai.py ++ โฏ REPLACE-ME++proxy
++++
++ +prisma_migration.py ++ โฏ REPLACE-ME+ +_new_secret_config.yaml ++ โฏ REPLACE-ME+ +_types.py ++ โฏ REPLACE-ME+ +_logging.py ++ โฏ REPLACE-ME+ +proxy_config.yaml ++ โฏ REPLACE-ME+ +proxy_cli.py ++ โฏ REPLACE-ME+ +llamaguard_prompt.txt ++ โฏ REPLACE-ME+ +litellm_pre_call_utils.py ++ โฏ REPLACE-ME+ +lambda.py ++ โฏ REPLACE-ME+ +schema.prisma ++ โฏ REPLACE-ME+ +caching_routes.py ++ โฏ REPLACE-ME+ +proxy_server.py ++ โฏ REPLACE-ME+ +utils.py ++ โฏ REPLACE-ME+ +health_check.py ++ โฏ REPLACE-ME+ +_super_secret_config.yaml ++ โฏ REPLACE-ME+ +custom_sso.py ++ โฏ REPLACE-ME+ +openapi.json ++ โฏ REPLACE-ME+ +start.sh ++ โฏ REPLACE-ME+ +post_call_rules.py ++ โฏ REPLACE-ME+ +route_llm_request.py ++ โฏ REPLACE-ME++common_utils
++++
++ +load_config_utils.py ++ โฏ REPLACE-ME+ +callback_utils.py ++ โฏ REPLACE-ME+ +openai_endpoint_utils.py ++ โฏ REPLACE-ME+ +http_parsing_utils.py ++ โฏ REPLACE-ME+ +encrypt_decrypt_utils.py ++ โฏ REPLACE-ME+ +swagger_utils.py ++ โฏ REPLACE-ME+ +admin_ui_utils.py ++ โฏ REPLACE-ME+ +debug_utils.py ++ โฏ REPLACE-ME++guardrails
++++
++ +init_guardrails.py ++ โฏ REPLACE-ME+ +guardrail_helpers.py ++ โฏ REPLACE-ME++guardrail_hooks
++++
++ +aporia_ai.py ++ โฏ REPLACE-ME+ +bedrock_guardrails.py ++ โฏ REPLACE-ME+ +presidio.py ++ โฏ REPLACE-ME+ +custom_guardrail.py ++ โฏ REPLACE-ME+ +lakera_ai.py ++ โฏ REPLACE-ME+ +guardrails_ai.py ++ โฏ REPLACE-ME++spend_tracking
++++
++ +spend_management_endpoints.py ++ โฏ REPLACE-ME+ +spend_tracking_utils.py ++ โฏ REPLACE-ME++health_endpoints
++++
++ +_health_endpoints.py ++ โฏ REPLACE-ME++config_management_endpoints
++++
++ +pass_through_endpoints.py ++ โฏ REPLACE-ME++vertex_ai_endpoints
++++
++ +vertex_endpoints.py ++ โฏ REPLACE-ME+ +langfuse_endpoints.py ++ โฏ REPLACE-ME+ +google_ai_studio_endpoints.py ++ โฏ REPLACE-ME++_experimental
++++
++ +post_call_rules.py ++ โฏ REPLACE-ME++out
++++
++ +model_hub.txt ++ โฏ REPLACE-ME+ +index.html ++ โฏ REPLACE-ME+ +index.txt ++ โฏ REPLACE-ME+ +onboarding.txt ++ โฏ REPLACE-ME++openai_files_endpoints
++++
++ +files_endpoints.py ++ โฏ REPLACE-ME++auth
++++
++ +route_checks.py ++ โฏ REPLACE-ME+ +service_account_checks.py ++ โฏ REPLACE-ME+ +auth_checks.py ++ โฏ REPLACE-ME+ +oauth2_check.py ++ โฏ REPLACE-ME+ +model_checks.py ++ โฏ REPLACE-ME+ +oauth2_proxy_hook.py ++ โฏ REPLACE-ME+ +auth_utils.py ++ โฏ REPLACE-ME+ +auth_checks_organization.py ++ โฏ REPLACE-ME+ +handle_jwt.py ++ โฏ REPLACE-ME+ +rds_iam_token.py ++ โฏ REPLACE-ME+ +user_api_key_auth.py ++ โฏ REPLACE-ME+ +litellm_license.py ++ โฏ REPLACE-ME++analytics_endpoints
++++
++ +analytics_endpoints.py ++ โฏ REPLACE-ME++fine_tuning_endpoints
++++
++ +endpoints.py ++ โฏ REPLACE-ME++proxy_load_test
++++
++ +litellm_proxy_config.yaml ++ โฏ REPLACE-ME+ +locustfile.py ++ โฏ REPLACE-ME+ +openai_endpoint.py ++ โฏ REPLACE-ME+ +simple_litellm_router_proxy.py ++ โฏ REPLACE-ME+ +simple_litellm_proxy.py ++ โฏ REPLACE-ME+ +simple_proxy.py ++ โฏ REPLACE-ME++litellm_router_proxy
++++
++ +Dockerfile ++ โฏ REPLACE-ME+ +main.py ++ โฏ REPLACE-ME++rerank_endpoints
++++
++ +endpoints.py ++ โฏ REPLACE-ME++management_helpers
++++
++ +utils.py ++ โฏ REPLACE-ME++hooks
++++
++ +cache_control_check.py ++ โฏ REPLACE-ME+ +batch_redis_get.py ++ โฏ REPLACE-ME+ +dynamic_rate_limiter.py ++ โฏ REPLACE-ME+ +presidio_pii_masking.py ++ โฏ REPLACE-ME+ +prompt_injection_detection.py ++ โฏ REPLACE-ME+ +max_budget_limiter.py ++ โฏ REPLACE-ME+ +parallel_request_limiter.py ++ โฏ REPLACE-ME+ +example_presidio_ad_hoc_recognizer.json ++ โฏ REPLACE-ME+ +azure_content_safety.py ++ โฏ REPLACE-ME++ui_crud_endpoints
++++
++ +proxy_setting_endpoints.py ++ โฏ REPLACE-ME++management_endpoints
++++
++ +key_management_endpoints.py ++ โฏ REPLACE-ME+ +team_endpoints.py ++ โฏ REPLACE-ME+ +sso_helper_utils.py ++ โฏ REPLACE-ME+ +organization_endpoints.py ++ โฏ REPLACE-ME+ +ui_sso.py ++ โฏ REPLACE-ME+ +internal_user_endpoints.py ++ โฏ REPLACE-ME+ +team_callback_endpoints.py ++ โฏ REPLACE-ME++db
++++
++ +base_client.py ++ โฏ REPLACE-ME+ +prisma_client.py ++ โฏ REPLACE-ME+ +create_views.py ++ โฏ REPLACE-ME+ +dynamo_db.py ++ โฏ REPLACE-ME+ +check_migration.py ++ โฏ REPLACE-ME++example_config_yaml
++++
++ +otel_test_config.yaml ++ โฏ REPLACE-ME+ +custom_auth.py ++ โฏ REPLACE-ME+ +azure_config.yaml ++ โฏ REPLACE-ME+ +aliases_config.yaml ++ โฏ REPLACE-ME+ +custom_auth_basic.py ++ โฏ REPLACE-ME+ +bad_schema.prisma ++ โฏ REPLACE-ME+ +opentelemetry_config.yaml ++ โฏ REPLACE-ME+ +disable_schema_update.yaml ++ โฏ REPLACE-ME+ +simple_config.yaml ++ โฏ REPLACE-ME+ +load_balancer.yaml ++ โฏ REPLACE-ME+ +pass_through_config.yaml ++ โฏ REPLACE-ME+ +langfuse_config.yaml ++ โฏ REPLACE-ME+ +custom_guardrail.py ++ โฏ REPLACE-ME+ +custom_callbacks1.py ++ โฏ REPLACE-ME+ +_health_check_test_config.yaml ++ โฏ REPLACE-ME+ +custom_handler.py ++ โฏ REPLACE-ME+ +custom_callbacks.py ++ โฏ REPLACE-ME++pass_through_endpoints
++++
++ +pass_through_endpoints.py ++ โฏ REPLACE-ME+ +types.py ++ โฏ REPLACE-ME+ +success_handler.py ++ โฏ REPLACE-ME+ +streaming_handler.py ++ โฏ REPLACE-ME++ +fine_tuning
++++
++ +main.py ++ โฏ REPLACE-ME++secret_managers
++++
++ +google_secret_manager.py ++ โฏ REPLACE-ME+ +google_kms.py ++ โฏ REPLACE-ME+ +aws_secret_manager.py ++ โฏ REPLACE-ME+ +main.py ++ โฏ REPLACE-ME+ +get_azure_ad_token_provider.py ++ โฏ REPLACE-ME++rerank_api
++++
++ +main.py ++ โฏ REPLACE-ME++realtime_api
++++
++ +main.py ++ โฏ REPLACE-ME++integrations
++++
++ +arize_ai.py ++ โฏ REPLACE-ME+ +dynamodb.py ++ โฏ REPLACE-ME+ +supabase.py ++ โฏ REPLACE-ME+ +helicone.py ++ โฏ REPLACE-ME+ +prometheus_services.py ++ โฏ REPLACE-ME+ +langsmith.py ++ โฏ REPLACE-ME+ +galileo.py ++ โฏ REPLACE-ME+ +lago.py ++ โฏ REPLACE-ME+ +traceloop.py ++ โฏ REPLACE-ME+ +braintrust_logging.py ++ โฏ REPLACE-ME+ +opentelemetry.py ++ โฏ REPLACE-ME+ +custom_logger.py ++ โฏ REPLACE-ME+ +logfire_logger.py ++ โฏ REPLACE-ME+ +langtrace.py ++ โฏ REPLACE-ME+ +weights_biases.py ++ โฏ REPLACE-ME+ +prompt_layer.py ++ โฏ REPLACE-ME+ +custom_batch_logger.py ++ โฏ REPLACE-ME+ +literal_ai.py ++ โฏ REPLACE-ME+ +prometheus.py ++ โฏ REPLACE-ME+ +email_alerting.py ++ โฏ REPLACE-ME+ +custom_guardrail.py ++ โฏ REPLACE-ME+ +argilla.py ++ โฏ REPLACE-ME+ +athina.py ++ โฏ REPLACE-ME+ +test_httpx.py ++ โฏ REPLACE-ME+ +greenscale.py ++ โฏ REPLACE-ME+ +s3.py ++ โฏ REPLACE-ME+ +lunary.py ++ โฏ REPLACE-ME+ +openmeter.py ++ โฏ REPLACE-ME++langfuse
++++
++ +langfuse_handler.py ++ โฏ REPLACE-ME+ +langfuse.py ++ โฏ REPLACE-ME++_types
++++
++ +open_inference.py ++ โฏ REPLACE-ME++email_templates
++++
++ +templates.py ++ โฏ REPLACE-ME++prometheus_helpers
++++
++ +prometheus_api.py ++ โฏ REPLACE-ME++gcs_bucket
++++
++ +gcs_bucket.py ++ โฏ REPLACE-ME+ +gcs_bucket_base.py ++ โฏ REPLACE-ME++datadog
++++
++ +types.py ++ โฏ REPLACE-ME+ +utils.py ++ โฏ REPLACE-ME+ +datadog.py ++ โฏ REPLACE-ME++ +SlackAlerting
++++
++ +utils.py ++ โฏ REPLACE-ME+ +slack_alerting.py ++ โฏ REPLACE-ME+ +batching_handler.py ++ โฏ REPLACE-ME++adapters
++++
++ +anthropic_adapter.py ++ โฏ REPLACE-ME++deprecated_litellm_server
++++
++ +requirements.txt ++ โฏ REPLACE-ME+ +Dockerfile ++ โฏ REPLACE-ME+ +.env.template ++ โฏ REPLACE-ME+ +server_utils.py ++ โฏ REPLACE-ME+ +main.py ++ โฏ REPLACE-ME++files
++++
++ +main.py ++ โฏ REPLACE-ME++litellm_core_utils
++++
++ +redact_messages.py ++ โฏ REPLACE-ME+ +token_counter.py ++ โฏ REPLACE-ME+ +streaming_utils.py ++ โฏ REPLACE-ME+ +asyncify.py ++ โฏ REPLACE-ME+ +litellm_logging.py ++ โฏ REPLACE-ME+ +json_validation_rule.py ++ โฏ REPLACE-ME+ +core_helpers.py ++ โฏ REPLACE-ME+ +mock_functions.py ++ โฏ REPLACE-ME+ +get_llm_provider_logic.py ++ โฏ REPLACE-ME+ +realtime_streaming.py ++ โฏ REPLACE-ME+ +response_header_helpers.py ++ โฏ REPLACE-ME+ +streaming_chunk_builder_utils.py ++ โฏ REPLACE-ME+ +llm_request_utils.py ++ โฏ REPLACE-ME+ +logging_utils.py ++ โฏ REPLACE-ME+ +exception_mapping_utils.py ++ โฏ REPLACE-ME++llm_response_utils
++++
++ +convert_dict_to_response.py ++ โฏ REPLACE-ME+ +get_headers.py ++ โฏ REPLACE-ME++ +audio_utils
++++
++ +utils.py ++ โฏ REPLACE-ME++batch_completion
++++
++ +main.py ++ โฏ REPLACE-ME++router_utils
++++
++ +client_initalization_utils.py ++ โฏ REPLACE-ME+ +fallback_event_handlers.py ++ โฏ REPLACE-ME+ +handle_error.py ++ โฏ REPLACE-ME+ +batch_utils.py ++ โฏ REPLACE-ME+ +cooldown_cache.py ++ โฏ REPLACE-ME+ +cooldown_callbacks.py ++ โฏ REPLACE-ME+ +cooldown_handlers.py ++ โฏ REPLACE-ME+ +pattern_match_deployments.py ++ โฏ REPLACE-ME++router_callbacks
++++
++ +track_deployment_metrics.py ++ โฏ REPLACE-ME++llms
++++
++ +azure_text.py ++ โฏ REPLACE-ME+ +maritalk.py ++ โฏ REPLACE-ME+ +palm.py ++ โฏ REPLACE-ME+ +triton.py ++ โฏ REPLACE-ME+ +vllm.py ++ โฏ REPLACE-ME+ +volcengine.py ++ โฏ REPLACE-ME+ +openrouter.py ++ โฏ REPLACE-ME+ +replicate.py ++ โฏ REPLACE-ME+ +petals.py ++ โฏ REPLACE-ME+ +cloudflare.py ++ โฏ REPLACE-ME+ +gemini.py ++ โฏ REPLACE-ME+ +aleph_alpha.py ++ โฏ REPLACE-ME+ +ollama_chat.py ++ โฏ REPLACE-ME+ +oobabooga.py ++ โฏ REPLACE-ME+ +text_completion_codestral.py ++ โฏ REPLACE-ME+ +base_aws_llm.py ++ โฏ REPLACE-ME+ +baseten.py ++ โฏ REPLACE-ME+ +custom_llm.py ++ โฏ REPLACE-ME+ +watsonx.py ++ โฏ REPLACE-ME+ +clarifai.py ++ โฏ REPLACE-ME+ +huggingface_restapi.py ++ โฏ REPLACE-ME+ +ollama.py ++ โฏ REPLACE-ME+ +base.py ++ โฏ REPLACE-ME+ +predibase.py ++ โฏ REPLACE-ME+ +nlp_cloud.py ++ โฏ REPLACE-ME++cohere
++++
++ +rerank.py ++ โฏ REPLACE-ME+ +embed.py ++ โฏ REPLACE-ME+ +completion.py ++ โฏ REPLACE-ME+ +cost_calculator.py ++ โฏ REPLACE-ME+ +chat.py ++ โฏ REPLACE-ME++tokenizers
++++
++ +anthropic_tokenizer.json ++ โฏ REPLACE-ME+ +9b5ad71b2ce5302211f9c61530b329a4922fc6a4 ++ โฏ REPLACE-ME+ +ec7223a39ce59f226a68acc30dc1af2788490e15 ++ โฏ REPLACE-ME+ +fb374d419588a4632f3f557e76b4b70aebbca790 ++ โฏ REPLACE-ME++sambanova
++++
++ +chat.py ++ โฏ REPLACE-ME++fine_tuning_apis
++++
++ +azure.py ++ โฏ REPLACE-ME+ +openai.py ++ โฏ REPLACE-ME+ +vertex_ai.py ++ โฏ REPLACE-ME++huggingface_llms_metadata
++++
++ +hf_text_generation_models.txt ++ โฏ REPLACE-ME+ +hf_conversational_models.txt ++ โฏ REPLACE-ME++AzureOpenAI
++++
++ +assistants.py ++ โฏ REPLACE-ME+ +azure.py ++ โฏ REPLACE-ME+ +cost_calculation.py ++ โฏ REPLACE-ME+ +audio_transcriptions.py ++ โฏ REPLACE-ME+ +common_utils.py ++ โฏ REPLACE-ME++chat
++++
++ +o1_handler.py ++ โฏ REPLACE-ME+ +o1_transformation.py ++ โฏ REPLACE-ME+ +gpt_transformation.py ++ โฏ REPLACE-ME++realtime
++++
++ +handler.py ++ โฏ REPLACE-ME++files_apis
++++
++ +azure.py ++ โฏ REPLACE-ME++azure_ai
++++
++ +cost_calculator.py ++ โฏ REPLACE-ME++embed
++++
++ +cohere_transformation.py ++ โฏ REPLACE-ME+ +handler.py ++ โฏ REPLACE-ME++chat
++++
++ +transformation.py ++ โฏ REPLACE-ME+ +handler.py ++ โฏ REPLACE-ME++rerank
++++
++ +transformation.py ++ โฏ REPLACE-ME+ +handler.py ++ โฏ REPLACE-ME++databricks
++++
++ +cost_calculator.py ++ โฏ REPLACE-ME+ +streaming_utils.py ++ โฏ REPLACE-ME+ +chat.py ++ โฏ REPLACE-ME+ +exceptions.py ++ โฏ REPLACE-ME++groq
+++++chat
++++
++ +transformation.py ++ โฏ REPLACE-ME+ +handler.py ++ โฏ REPLACE-ME++stt
++++
++ +transformation.py ++ โฏ REPLACE-ME++jina_ai
+++++embedding
++++
++ +transformation.py ++ โฏ REPLACE-ME++bedrock
++++
++ +image_generation.py ++ โฏ REPLACE-ME+ +common_utils.py ++ โฏ REPLACE-ME++embed
++++
++ +cohere_transformation.py ++ โฏ REPLACE-ME+ +embedding.py ++ โฏ REPLACE-ME+ +amazon_titan_multimodal_transformation.py ++ โฏ REPLACE-ME+ +amazon_titan_g1_transformation.py ++ โฏ REPLACE-ME+ +amazon_titan_v2_transformation.py ++ โฏ REPLACE-ME++chat
++++
++ +invoke_handler.py ++ โฏ REPLACE-ME+ +converse_handler.py ++ โฏ REPLACE-ME+ +converse_transformation.py ++ โฏ REPLACE-ME++hosted_vllm
+++++chat
++++
++ +transformation.py ++ โฏ REPLACE-ME++perplexity
+++++chat
++++
++ +transformation.py ++ โฏ REPLACE-ME++ +fireworks_ai
++++
++ +cost_calculator.py ++ โฏ REPLACE-ME++embed
++++
++ +fireworks_ai_transformation.py ++ โฏ REPLACE-ME++chat
++++
++ +fireworks_ai_transformation.py ++ โฏ REPLACE-ME++anthropic
++++
++ +completion.py ++ โฏ REPLACE-ME+ +cost_calculation.py ++ โฏ REPLACE-ME+ +common_utils.py ++ โฏ REPLACE-ME++experimental_pass_through
++++
++ +transformation.py ++ โฏ REPLACE-ME++chat
++++
++ +transformation.py ++ โฏ REPLACE-ME+ +handler.py ++ โฏ REPLACE-ME++together_ai
++++
++ +rerank.py ++ โฏ REPLACE-ME+ +embed.py ++ โฏ REPLACE-ME+ +cost_calculator.py ++ โฏ REPLACE-ME+ +chat.py ++ โฏ REPLACE-ME++completion
++++
++ +transformation.py ++ โฏ REPLACE-ME+ +handler.py ++ โฏ REPLACE-ME++vertex_ai_and_google_ai_studio
++++
++ +vertex_llm_base.py ++ โฏ REPLACE-ME+ +vertex_ai_non_gemini.py ++ โฏ REPLACE-ME+ +common_utils.py ++ โฏ REPLACE-ME++multimodal_embeddings
++++
++ +embedding_handler.py ++ โฏ REPLACE-ME++context_caching
++++
++ +transformation.py ++ โฏ REPLACE-ME+ +vertex_ai_context_caching.py ++ โฏ REPLACE-ME++vertex_embeddings
++++
++ +transformation.py ++ โฏ REPLACE-ME+ +embedding_handler.py ++ โฏ REPLACE-ME+ +types.py ++ โฏ REPLACE-ME++gemini
++++
++ +transformation.py ++ โฏ REPLACE-ME+ +vertex_and_google_ai_studio_gemini.py ++ โฏ REPLACE-ME++image_generation
++++
++ +image_generation_handler.py ++ โฏ REPLACE-ME++gemini_embeddings
++++
++ +batch_embed_content_handler.py ++ โฏ REPLACE-ME+ +batch_embed_content_transformation.py ++ โฏ REPLACE-ME++text_to_speech
++++
++ +text_to_speech_handler.py ++ โฏ REPLACE-ME++vertex_ai_partner_models
++++
++ +main.py ++ โฏ REPLACE-ME++llama3
++++
++ +transformation.py ++ โฏ REPLACE-ME++anthropic
++++
++ +transformation.py ++ โฏ REPLACE-ME++ai21
++++
++ +transformation.py ++ โฏ REPLACE-ME++cerebras
++++
++ +chat.py ++ โฏ REPLACE-ME++openai_like
++++
++ +common_utils.py ++ โฏ REPLACE-ME++embedding
++++
++ +handler.py ++ โฏ REPLACE-ME++AI21
++++
++ +completion.py ++ โฏ REPLACE-ME+ +chat.py ++ โฏ REPLACE-ME++mistral
++++
++ +mistral_embedding_transformation.py ++ โฏ REPLACE-ME+ +embedding.py ++ โฏ REPLACE-ME+ +chat.py ++ โฏ REPLACE-ME+ +mistral_chat_transformation.py ++ โฏ REPLACE-ME++OpenAI
++++
++ +cost_calculation.py ++ โฏ REPLACE-ME+ +audio_transcriptions.py ++ โฏ REPLACE-ME+ +openai.py ++ โฏ REPLACE-ME+ +common_utils.py ++ โฏ REPLACE-ME++chat
++++
++ +o1_handler.py ++ โฏ REPLACE-ME+ +gpt_audio_transformation.py ++ โฏ REPLACE-ME+ +o1_transformation.py ++ โฏ REPLACE-ME+ +gpt_transformation.py ++ โฏ REPLACE-ME++completion
++++
++ +utils.py ++ โฏ REPLACE-ME++realtime
++++
++ +handler.py ++ โฏ REPLACE-ME++sagemaker
++++
++ +sagemaker.py ++ โฏ REPLACE-ME++prompt_templates
++++
++ +image_handling.py ++ โฏ REPLACE-ME+ +factory.py ++ โฏ REPLACE-ME+ +common_utils.py ++ โฏ REPLACE-ME++custom_httpx
++++
++ +httpx_handler.py ++ โฏ REPLACE-ME+ +types.py ++ โฏ REPLACE-ME+ +http_handler.py ++ โฏ REPLACE-ME++batches
++++
++ +main.py ++ โฏ REPLACE-ME++caching
++++
++ +disk_cache.py ++ โฏ REPLACE-ME+ +qdrant_semantic_cache.py ++ โฏ REPLACE-ME+ +s3_cache.py ++ โฏ REPLACE-ME+ +dual_cache.py ++ โฏ REPLACE-ME+ +caching.py ++ โฏ REPLACE-ME+ +base_cache.py ++ โฏ REPLACE-ME+ +in_memory_cache.py ++ โฏ REPLACE-ME+ +redis_cache.py ++ โฏ REPLACE-ME+ +redis_semantic_cache.py ++ โฏ REPLACE-ME+ +caching_handler.py ++ โฏ REPLACE-ME++router_strategy
++++
++ +lowest_cost.py ++ โฏ REPLACE-ME+ +tag_based_routing.py ++ โฏ REPLACE-ME+ +simple_shuffle.py ++ โฏ REPLACE-ME+ +lowest_latency.py ++ โฏ REPLACE-ME+ +lowest_tpm_rpm.py ++ โฏ REPLACE-ME+ +least_busy.py ++ โฏ REPLACE-ME+ +lowest_tpm_rpm_v2.py ++ โฏ REPLACE-ME
](https://pypi.org/project/pip/)
+
+```sh
+โฏ pip install -r requirements.txt, ui/requirements.txt, cookbook/litellm-ollama-docker-image/requirements.txt, litellm/requirements.txt, litellm/deprecated_litellm_server/requirements.txt
+```
+
+**Using `poetry`** [](https://python-poetry.org/)
+
+```sh
+โฏ poetry install
+```
+
+
+**Using `docker`** [](https://www.docker.com/)
+
+```sh
+โฏ docker build -t BerriAI/litellm .
+```
+
+
+
+
+### ๐ค Usage
+Run litellm using the following command:
+**Using `pip`** [](https://pypi.org/project/pip/)
+
+```sh
+โฏ python {entrypoint}
+```
+
+**Using `poetry`** [](https://python-poetry.org/)
+
+```sh
+โฏ poetry run python {entrypoint}
+```
+
+
+**Using `docker`** [](https://www.docker.com/)
+
+```sh
+โฏ docker run -it {image_name}
+```
+
+
+### ๐งช Testing
+Run the test suite using the following command:
+**Using `pip`** [](https://pypi.org/project/pip/)
+
+```sh
+โฏ pytest
+```
+
+**Using `poetry`** [](https://python-poetry.org/)
+
+```sh
+โฏ poetry run pytest
+```
+
+---
+## ๐ Project Roadmap
+
+- [X] **`Task 1`**:
-
-
- Unlock README Potential with AI -
-
-
-
- Developed with the software and tools below. -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
sourcesource]()
-
-# `PYFLINK-POC`
-
-#### Streamlining data flow, empowering seamless integration.
-
-
-
- Built with the tools and technologies: -
-
-
-
-
-
-
-
-
-
-
-
-
- Minimal-Todo: Simplify your tasks, maximize productivity! -
-
-
-
- Developed with the software and tools below. -
-
-
-
-
-
-
-
-
-
-
-
- Unleash seamless Android file magic! -
-
-
++ Empowering Android, Elevating Experiences.
-- Built with the tools and technologies: +
+
+
Built with the tools and technologies:
+
@@ -24,31 +19,26 @@
-
| build.gradle | -Configure project dependencies and repositories for Android app build using Gradle. | +- Configures project dependencies and repositories for the entire codebase, ensuring seamless integration of essential tools and libraries - The `build.gradle` file sets up key components like the Android Gradle plugin, Fabric, Google services, and Kotlin plugin, enabling efficient build management across all project modules. |
| settings.gradle | -- Defines project modules for build configuration and dependency management within the codebase architecture - The "settings.gradle" file specifies the inclusion of the ":app" module, organizing the project structure and facilitating seamless integration of different components. |
+ Defines the project structure and modules to include in the build process. |
| readme.txt | -- Facilitates project setup and configuration by providing a visual guide and essential instructions in the README file - Helps users navigate the project structure and understand how to interact with the codebase effectively. |
+ Enhances project onboarding by providing visual aids and documentation in readme.txt and screenshots. |
| proguard-rules.pro | -- Specifies project-specific ProGuard rules to optimize and secure the Android app during the build process - Controls configuration file entities and preserves line number information for debugging stack traces - Includes rules for Crashlytics integration and hides original source file names. |
+ - Define ProGuard rules for Android project to optimize and secure code - Control configuration via build.gradle, preserve line numbers for debugging - Exclude specific packages, keep annotation attributes, and handle Crashlytics classes - Enhance app performance and security. |
| build.gradle | -- Configures Android project settings, dependencies, and plugins for the application - Sets up build types, defines dependencies for various libraries, including Room, Firebase, and Gson - Implements plugins for Crashlytics, Kotlin, and navigation components - Handles permissions using Permission Dispatcher and includes testing dependencies. |
+ - Configures Android project settings, dependencies, and plugins - Manages versions for libraries like Room, Kotlin, and Firebase - Integrates Crashlytics for crash reporting and Navigation components for UI navigation - Implements permissions handling with Permission Dispatcher - Sets up testing dependencies and logging with Timber - Configures Google services plugin for Firebase integration. |
| app-release.apk | -- The provided code file serves as a crucial component within the project architecture, facilitating seamless integration and interaction between various modules - It plays a key role in enhancing the overall functionality and performance of the codebase, contributing significantly to the project's success. |
+ - The provided code file is a crucial component in the project's architecture, serving the purpose of managing user authentication and authorization - It ensures secure access control and user identity verification within the codebase, enhancing the overall security and integrity of the project. |
| app-debug.apk | -- The code file provided serves as a crucial component within the project structure, contributing to the overall architecture by enabling seamless communication between different modules - It plays a key role in enhancing the project's functionality and ensuring efficient data flow throughout the system. |
+ - Summary:
+The provided code file plays a crucial role in the project architecture by implementing a key feature that enhances the overall functionality of the codebase - It contributes to the project's success by fulfilling a specific purpose and improving the user experience. |
| ExampleInstrumentedTest.kt | -- Verifies app context on an Android device using Instrumented Test - Executes on AndroidJUnit4 with a SmallTest filter - Utilizes ActivityTestRule for MainActivity - Validates app package name against expected value - Ideal for ensuring correct context setup in Android testing environments. |
+ - Verifies Android app functionality using instrumentation tests on a physical device - The test ensures the app context matches the expected package name, validating proper app setup and configuration. |
| FileEntityDaoTest.java | -- Tests the functionality of the RoomDatabase by checking the count of rows, inserting and retrieving items, and saving multiple items - Verifies proper object creation and database operations, ensuring data integrity and consistency in the UploadHistoryRoomDatabase. |
+ - Tests the RoomDatabase functionality by checking row count, inserting and retrieving items - Validates data integrity and consistency in the database for FileEntity objects. |
| UploadHistoryInstrumentedTest.java | -- Implements instrumented tests for uploading history activity, utilizing Room database for data storage - Populates the database with sample items for testing purposes - Includes a method to match file entities by name. |
+ - Verifies long-press item deletion functionality in Upload History Activity through instrumentation testing - Initializes Room Database, populates with test data, and tests the deletion process - This test ensures items can be deleted successfully via long-press action in the app's upload history feature. |
| ExampleUnitTest.java | -Tests addition functionality to ensure correctness on the development machine. | +- Verifies correct addition operation in local unit tests for the Android app - The code ensures the accuracy of the addition functionality by asserting the result against the expected value - This unit test is vital for maintaining the integrity of the app's core arithmetic operations. |
| UploadRepositoryTest.java | -Test the expiration URL generation functionality ensuring correctness and consistency with defined constants in the codebase. | +Verify URL expiration logic correctness and const URL generation in the Upload Repository through unit tests. |
| UrlTest.java | -- Tests URL parsing functionality to ensure proper extraction of the base URL from an encrypted URL - This validation guarantees accurate handling of file download links within the project architecture. |
+ Validates URL parsing functionality for encrypt URLs in the project, ensuring correct extraction of the base URL. |
| FileEntityTest.java | -Validates FileEntity attributes setting functionality through unit tests. | +- Tests the FileEntity class by setting and checking values for name and URL properties - This file ensures that the FileEntity object correctly stores and retrieves the provided data, validating the core functionality of the FileEntity class within the project architecture. |
| UploadHistoryViewModel.kt | -- Manages live data of file upload history through a ViewModel linked to a Room Database - Initializes LiveData with a list of file entities from the database, facilitating seamless data interaction in the app. |
+ - Manages live data for upload history in the application by connecting to the local database - The UploadHistoryViewModel class in the provided file serves as a bridge between the database and UI, ensuring real-time updates on uploaded files. |
| FileioApplication.kt | -- Initializes application-wide configurations for logging and error handling in the Android app - Sets up Timber for logging and configures a custom activity to handle crashes - This class acts as the base for the application, providing essential setup during the app's lifecycle. |
+ - Initiates application setup and configuration - Handles logging with Timber and sets up custom error handling using Custom Activity on Crash. |
| UploadHistoryListAdapter.kt | -- Enables displaying and managing upload history in a RecyclerView by populating different types of views based on the data content - Supports viewing file details and copying URLs to the clipboard - Facilitates swapping and removing items in the list. |
+ - Enables rendering of upload history items in a RecyclerView with date separators and file details - Supports interaction for copying file URLs and removing items - Facilitates dynamic updates to the displayed list of files. |
| SwipeToDeleteCallBack.kt | -- Implements swipe-to-delete functionality for RecyclerView items in the app UI, allowing users to remove items with a left swipe gesture - The code defines visual elements like delete icons and backgrounds, enhancing the user experience by providing a visual cue for item deletion. |
+ - Implements swipe-to-delete functionality for RecyclerView items - Handles drawing delete background and icon - Disables swiping for specific item types - Utilizes a color drawable and custom paint to manage visual effects - Designed to enhance user interaction and provide a seamless UI experience within the app. |
| NotificationHelper.kt | -- Generates notifications to inform users about successful file uploads - Handles notification creation and channel setup for devices running Android Oreo and above - Utilizes pending intents to enable interaction with the notification - Enhances user experience by providing timely feedback on completed file uploads. |
+ - Generates notifications upon successful file uploads, utilizing a notification channel for Android O and above - Includes a notification click action to open the upload history activity with file details. |
| NoNetworkDialogFragment.kt | -- Implement a dialog fragment handling network connectivity issues, allowing users to interact with an error message - The fragment facilitates user actions through an 'OK' button, triggering responses via a dialog click listener. |
+ - Creates a dialog fragment to handle network errors - It provides an option for users to acknowledge the error and triggers a callback to the parent activity. |
| HomeFragment.kt | -- Implements a fragment for choosing and uploading files, handling user interactions, and communication with the parent activity - The HomeFragment class encapsulates file selection logic and UI elements for a seamless user experience within the app's architecture. |
+ - Enables interaction with local files through a user-friendly interface - Facilitates file selection and storage in the local cache - Implements callbacks for user actions and ensures seamless communication with the parent activity. |
| ResultFragment.kt | -- Enables displaying and interacting with result data, such as URLs and expiration days, in the app - Allows users to copy links to the clipboard and trigger actions upon completion. |
+ - ResultFragment in the codebase displays and manages the result details for a specific file operation - It handles the UI elements and user interactions related to displaying a URL and its expiration duration - The fragment allows users to copy the URL to the clipboard and provides a button to indicate completion of the task. |
| MainActivity.kt | -- The MainActivity file orchestrates file uploads, navigation, and permission handling within the app - It integrates with WorkManager for background tasks, displays results, and manages fragments for user interaction - This central activity drives the core functionality and user experience of the application. |
+ - Manages the main activity of the app, facilitating file uploads, handling permissions, and displaying results - It initializes fragments, handles user interactions, and enqueues upload work using WorkManager - The activity also responds to permission requests and provides options to navigate to upload history and about sections. |
| ErrorActivity.kt | -- Handles runtime crashes by displaying an error screen - The ErrorActivity class in the provided file extends AppCompatActivity and overrides onBackPressed() to finish the activity - It sets the content view to activity_error layout in onCreate(). |
+ Handles runtime crashes by displaying the ErrorActivity, ensuring a smooth user experience. |
| UploadHistoryActivity.kt | -- Manages the upload history display, allowing users to clear history and delete individual items - Provides visual feedback on item removal and dynamically updates the list view based on chronological order - Utilizes WorkManager for background tasks and RecyclerView for swipe-to-delete functionality. |
+ - Manages the upload history display, enabling users to clear history, remove individual items, and swipe to delete - Displays a list of uploaded files grouped by date, with the ability to toggle between views based on content availability. |
| AboutActivity.kt | -Manages the About section UI and navigation in the app, allowing users to view open-source licenses. | +- Enables navigation to the open-source license activity from the About section - The code defines the behavior for creating the options menu, setting the theme, and handling user interaction to launch the LicenseActivity - This functionality enhances the user experience by providing access to project licensing information. |
| LicenseActivity.kt | -- Generates a Material About list displaying open-source licenses for various libraries used in the project - The LicenseActivity file constructs license cards with details like library name, author, and license type - This activity helps users view and understand the open-source licenses associated with the project's dependencies. |
+ - Generates a list of open-source licenses for various libraries used in the project, providing details such as the library name, release year, creator, and license type - This activity serves to display licensing information in a Material About Activity to inform users about the open-source components utilized in the application. |
| UploadHistoryWorkers.kt | -- These worker classes in the provided file handle clearing and deleting upload history items in the database - They are responsible for executing background tasks asynchronously to manage the upload history data effectively within the application architecture. |
+ Implements workers to handle clearing and deleting items in the Upload History database. |
| UploadWorker.kt | -- Handles uploading files to a remote server, saving upload history to a local database, and notifying users upon completion - Utilizes WorkManager for asynchronous tasks and Fuel library for HTTP requests - The code ensures synchronous requests within a Worker Thread for accurate progress tracking. |
+ - Handles uploading files to a remote server, saving upload history to a local database, and sending notifications upon completion - Manages file upload process asynchronously using WorkManager, ensuring data consistency and user feedback. |
| Extensions.kt | -Enables adding toast messages and toggling clickable behavior to strings and views in the Android app. | +- Enables displaying toast messages and toggling clickability in Android app views - Enhances user interaction by providing convenient feedback and dynamic interaction controls - Integrates seamlessly within the project's utility functions, contributing to a user-friendly experience. |
| WorkManagerHelper.kt | -Generates OneTimeWorkRequest for uploading files with specified constraints and data, tagged as 'UploadWork'. | +Generates OneTimeWorkRequest for uploading a file with specified URI by creating constraints and work data, then assigning them to the request. |
| Utils.kt | -- Facilitates Android file handling, network connectivity checks, and dialog management - Includes methods for retrieving file details, opening files, and creating intents - Offers functionalities for network status checks, dialog display, clipboard operations, and app settings navigation - Additionally, provides URL parsing and JSON parsing utilities. |
+ - Provides utility methods for handling file operations, network connectivity, intents, dialogs, and JSON parsing in the Android app - Centralizes common functionalities to simplify code maintenance and enhance readability - Facilitates file details retrieval, file opening, network connectivity checks, dialog management, URL parsing, JSON parsing, and date formatting. |
| Helpers.kt | -- The code file in `Helpers.kt` provides functions to extract metadata and create file entities based on user-selected files - It handles retrieving file names, sizes, and composing file entities with additional data for the project's file management system. |
+ - The code file in `Helpers.kt` extracts metadata and retrieves files from URIs in the app using Android content resolver - It aids in fetching file details like name and size, converting them into a structured `FileEntity`, and logging with Timber - This facilitates seamless file operations within the app's architecture. |
| FragmentHelperExtensions.kt | -- Enhances FragmentManager functionality by simplifying fragment transactions - The code provides extension functions to easily add or replace fragments in a container, managing transitions and back stack behavior - This improves code readability and maintainability in the app's architecture, promoting efficient navigation and user experience. |
+ - Enhances FragmentManager functionality by adding and replacing fragments in a container with specified transitions and backstack management - Supports smoother fragment transactions within the app's architecture. |
| MaterialIn.kt | -- Enables smooth material animation effects on specified views by applying fade and slide transitions based on gravity directions - The code orchestrates animations with precise timing and movement offsets, enhancing the user interface with visually appealing interactions. |
+ Enables smooth material animations on Android views based on gravity directions, facilitating a polished user interface experience within the project architecture. |
| Constants.kt | -- Defines global constants for the project, including BASE_URL, EXPIRE_PARAM, DEFAULT_EXPIRE_WEEKS, GITHUB_URL, TWITTER_URL, EMAIL, POSTFIX, and TIME_STAMP_FORMAT - These constants play a crucial role in maintaining consistency and reusability across the codebase architecture. |
+ - Defines global constants for the project, including BASE_URL for API requests, default expiration time, social media links, and email address - Additionally, it sets up the format for timestamps used throughout the codebase - The file centralizes key values to ensure consistency and easy maintenance across the project. |
| DialogClickListener.kt | -Enables handling positive dialog button clicks within the project's file I/O module. | +Enables communication between dialogs and fragments for seamless user interactions within the project architecture. |
| OnFragmentInteractionListener.kt | -Defines an interface for handling fragment interactions in the project. | +- The code file `OnFragmentInteractionListener.kt` defines an interface for handling specific events within the project architecture - It facilitates communication between different components by defining methods for actions like file uploads and completion notifications - This abstraction helps in decoupling and structuring the codebase effectively. |
- 
-
-
- Empower READMEs with AI magic, effortlessly. -
-
- 
- Built with the tools and technologies: -
-
- 
- 
- 
- 
-
]()
-
-## README-AI-STREAMLIT
-
- *Code clarity, README magic, effortlessly unleashed.*
-
-
- 
- 
-
-
- Craft READMEs with AI magic! -
-
- 
- Built with the tools and technologies: -
-
- 
- 
- 
- 
- 
- 
- 
-
README-AI-STREAMLIT/---
-- -Makefile -Facilitates project management and development tasks including cleaning artifacts, displaying git logs, removing cached files, managing dependencies, formatting codebase, running tests, and providing a help menu. -- -pyproject.toml -Generates automated README files for a Python project using the provided project structure and dependencies. -
---
-- -clean.sh -- The clean.sh script file provides functions to remove various artifacts such as build, test, and Python files from the project directory -
- It helps maintain a clean project structure by deleting unnecessary files and directories, enhancing the overall codebase hygiene.
---
-- -cli.py -- Configure CLI settings for the README-AI Streamlit web app, allowing users to customize various aspects such as repository link, API key, badge style, and project logo -
- The settings enable users to generate README files with specific language models, header styles, and table of contents formatting, enhancing the overall presentation of their projects.- -app.py -- The code in src/app.py serves as the main function for a Streamlit web app that generates README files using AI -
- It initializes session state variables, configures the app layout, and handles the generation and display of README content
- Users can preview, download, and copy the generated README file.- -commands.py -- Generates CLI commands for the README-AI Streamlit web app, facilitating the execution of commands and handling output -
- The code file in src/commands.py constructs commands for processing repositories, incorporating various parameters like API key, emojis, badge styling, and model options
- It executes the commands, displaying logs and handling errors effectively.
](https://python-poetry.org/)
-
-```sh
-โฏ poetry install
-```
-
-
-
-
-### ๐ค Usage
-
-Run readme-ai-streamlit using the following command:
-
-**Using `poetry`** [](https://python-poetry.org/)
-
-```sh
-โฏ poetry run python {entrypoint}
-```
-
-
-
-### ๐งช Testing
-
-Run the test suite using the following command:
-
-**Using `poetry`** [](https://python-poetry.org/)
-
-```sh
-โฏ poetry run pytest
-```
-
-
-
-## ๐ Roadmap
-
-- [X] **`Task 1`**: