ramalama 0.5.2__tar.gz

ramalama-0.5.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Eric Curtin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ramalama-0.5.2/PKG-INFO

@@ -0,0 +1,293 @@
+Metadata-Version: 2.2
+Name: ramalama
+Version: 0.5.2
+Summary: RamaLama is a command line tool for working with AI LLM models.
+Maintainer-email: Dan Walsh <dwalsh@redhat.com>, Eric Curtin <ecurtin@redhat.com>
+License: MIT License
+        
+        Copyright (c) 2024 Eric Curtin
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/containers/ramalama
+Project-URL: Documentation, https://github.com/containers/ramalama/tree/main/docs
+Project-URL: Repository, https://github.com/containers/ramalama
+Project-URL: Issues, https://github.com/containers/ramalama/issues
+Keywords: ramalama,llama,AI
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: argcomplete
+
+![RAMALAMA logo](logos/PNG/ramalama-logo-full-vertical-added-bg.png)
+
+# RamaLama
+
+The RamaLama project's goal is to make working with AI boring
+through the use of OCI containers.
+
+RamaLama tool facilitates local management and serving of AI Models.
+
+On first run RamaLama inspects your system for GPU support, falling back to CPU support if no GPUs are present.
+
+RamaLama uses container engines like Podman or Docker to pull the appropriate OCI image with all of the software necessary to run an AI Model for your systems setup.
+
+Running in containers eliminates the need for users to configure the host system for AI. After the initialization, RamaLama runs the AI Models within a container based on the OCI image.
+
+RamaLama then pulls AI Models from model registries. Starting a chatbot or a rest API service from a simple single command. Models are treated similarly to how Podman and Docker treat container images.
+
+When both Podman and Docker are installed, RamaLama defaults to Podman, The `RAMALAMA_CONTAINER_ENGINE=docker` environment variable can override this behaviour. When neither are installed RamaLama will attempt to run the model with software on the local system.
+
+RamaLama supports multiple AI model registries types called transports.
+Supported transports:
+
+
+## TRANSPORTS
+
+| Transports    | Web Site                                            |
+| ------------- | --------------------------------------------------- |
+| HuggingFace   | [`huggingface.co`](https://www.huggingface.co)      |
+| Ollama        | [`ollama.com`](https://www.ollama.com)              |
+| OCI Container Registries | [`opencontainers.org`](https://opencontainers.org)|
+||Examples: [`quay.io`](https://quay.io),  [`Docker Hub`](https://docker.io), and [`Artifactory`](https://artifactory.com)|
+
+RamaLama uses the Ollama registry transport by default. Use the RAMALAMA_TRANSPORTS environment variable to modify the default. `export RAMALAMA_TRANSPORT=huggingface` Changes RamaLama to use huggingface transport.
+
+Individual model transports can be modifies when specifying a model via the `huggingface://`, `oci://`, or `ollama://` prefix.
+
+`ramalama pull huggingface://afrideva/Tiny-Vicuna-1B-GGUF/tiny-vicuna-1b.q2_k.gguf`
+
+To make it easier for users, RamaLama uses shortname files, which container
+alias names for fully specified AI Models allowing users to specify the shorter
+names when referring to models. RamaLama reads shortnames.conf files if they
+exist . These files contain a list of name value pairs for specification of
+the model. The following table specifies the order which RamaLama reads the files
+. Any duplicate names that exist override previously defined shortnames.
+
+| Shortnames type | Path                                            |
+| --------------- | ---------------------------------------- |
+| Distribution    | /usr/share/ramalama/shortnames.conf      |
+| Administrators  | /etc/ramamala/shortnames.conf            |
+| Users           | $HOME/.config/ramalama/shortnames.conf   |
+
+```code
+$ cat /usr/share/ramalama/shortnames.conf
+[shortnames]
+  "tiny" = "ollama://tinyllama"
+  "granite" = "huggingface://instructlab/granite-7b-lab-GGUF/granite-7b-lab-Q4_K_M.gguf"
+  "granite:7b" = "huggingface://instructlab/granite-7b-lab-GGUF/granite-7b-lab-Q4_K_M.gguf"
+  "ibm/granite" = "huggingface://instructlab/granite-7b-lab-GGUF/granite-7b-lab-Q4_K_M.gguf"
+  "merlinite" = "huggingface://instructlab/merlinite-7b-lab-GGUF/merlinite-7b-lab-Q4_K_M.gguf"
+  "merlinite:7b" = "huggingface://instructlab/merlinite-7b-lab-GGUF/merlinite-7b-lab-Q4_K_M.gguf"
+...
+```
+
+## Install
+
+## Install via PyPi
+
+RamaLama is available via PyPi [https://pypi.org/project/ramalama](https://pypi.org/project/ramalama)
+
+```
+pip install ramalama
+```
+
+## Install by script
+
+Install RamaLama by running this one-liner:
+
+```
+curl -fsSL https://raw.githubusercontent.com/containers/ramalama/s/install.sh | bash
+```
+
+## Hardware Support
+
+| Hardware                           | Enabled |
+| ---------------------------------- | ------- |
+| CPU                                | :white_check_mark: |
+| Apple Silicon GPU (Linux / Asahi)  | :white_check_mark: |
+| Apple Silicon GPU (macOS)          | :white_check_mark: |
+| Apple Silicon GPU (podman-machine) | :white_check_mark: |
+| Nvidia GPU (cuda)                  | :white_check_mark: |
+| AMD GPU (rocm)                     | :white_check_mark: |
+
+## COMMANDS
+
+| Command                                                | Description                                                |
+| ------------------------------------------------------ | ---------------------------------------------------------- |
+| [ramalama(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama.1.md)                      | primary RamaLama man page                                  |
+| [ramalama-containers(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-containers.1.md)| list all RamaLama containers                               |
+| [ramalama-info(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-info.1.md)                 | display RamaLama configuration information                 |
+| [ramalama-list(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-list.1.md)            | list all downloaded AI Models                              |
+| [ramalama-login(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-login.1.md)          | login to remote registry                                   |
+| [ramalama-logout(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-logout.1.md)        | logout from remote registry                                |
+| [ramalama-pull(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-pull.1.md)            | pull AI Model from Model registry to local storage         |
+| [ramalama-push(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-push.1.md)            | push AI Model from local storage to remote registry        |
+| [ramalama-rm(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-rm.1.md)                | remove AI Model from local storage                         |
+| [ramalama-run(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-run.1.md)              | run specified AI Model as a chatbot                        |
+| [ramalama-serve(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-serve.1.md)          | serve REST API on specified AI Model                       |
+| [ramalama-stop(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-stop.1.md)            | stop named container that is running AI Model              |
+| [ramalama-version(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-version.1.md)      | display version of AI Model                                |
+
+## Usage
+
+### Running Models
+
+You can `run` a chatbot on a model using the `run` command. By default, it pulls from the Ollama registry.
+
+Note: RamaLama will inspect your machine for native GPU support and then will
+use a container engine like Podman to pull an OCI container image with the
+appropriate code and libraries to run the AI Model. This can take a long time to setup, but only on the first run.
+```
+$ ramalama run instructlab/merlinite-7b-lab
+Copying blob 5448ec8c0696 [--------------------------------------] 0.0b / 63.6MiB (skipped: 0.0b = 0.00%)
+Copying blob cbd7e392a514 [--------------------------------------] 0.0b / 65.3MiB (skipped: 0.0b = 0.00%)
+Copying blob 5d6c72bcd967 done  208.5MiB / 208.5MiB (skipped: 0.0b = 0.00%)
+Copying blob 9ccfa45da380 [--------------------------------------] 0.0b / 7.6MiB (skipped: 0.0b = 0.00%)
+Copying blob 4472627772b1 [--------------------------------------] 0.0b / 120.0b (skipped: 0.0b = 0.00%)
+>
+```
+
+After the initial container image has been downloaded, you can interact with
+different models, using the container image.
+```
+$ ramalama run granite-code
+> Write a hello world application in python
+
+print("Hello World")
+```
+
+In a different terminal window see the running podman container.
+```
+$ podman ps
+CONTAINER ID  IMAGE                             COMMAND               CREATED        STATUS        PORTS       NAMES
+91df4a39a360  quay.io/ramalama/ramalama:latest  /home/dwalsh/rama...  4 minutes ago  Up 4 minutes              gifted_volhard
+```
+
+### Listing Models
+
+You can `list` all models pulled into local storage.
+
+```
+$ ramalama list
+NAME                                                                MODIFIED     SIZE
+ollama://smollm:135m                                            16 hours ago 5.5M
+huggingface://afrideva/Tiny-Vicuna-1B-GGUF/tiny-vicuna-1b.q2_k.gguf 14 hours ago 460M
+ollama://granite-code:3b                                            5 days ago   1.9G
+ollama://granite-code:latest                                        1 day ago    1.9G
+ollama://moondream:latest                                           6 days ago   791M
+```
+### Pulling Models
+
+You can `pull` a model using the `pull` command. By default, it pulls from the Ollama registry.
+
+```
+$ ramalama pull granite-code
+###################################################                       32.5%
+```
+
+### Serving Models
+
+You can `serve` multiple models using the `serve` command. By default, it pulls from the Ollama registry.
+
+```
+$ ramalama serve --name mylama llama3
+```
+
+### Stopping servers
+
+You can stop a running model if it is running in a container.
+
+```
+$ ramalama stop mylama
+```
+
+### UI support
+
+To use a UI, run a `ramalama serve` command, then connect via your browser at:
+
+127.0.0.1:8080
+
+## Diagram
+
+```
++---------------------------+
+|                           |
+| ramalama run granite-code |
+|                           |
++-------+-------------------+
+	|
+	|
+	|                                          +------------------+
+	|                                          | Pull model layer |
+	+----------------------------------------->| granite-code     |
+						   +------------------+
+						   | Repo options:    |
+						   +-+-------+------+-+
+						     |       |      |
+						     v       v      v
+					     +---------+ +------+ +----------+
+					     | Hugging | | quay | | Ollama   |
+					     | Face    | |      | | Registry |
+					     +-------+-+ +---+--+ +-+--------+
+						     |       |      |
+						     v       v      v
+						   +------------------+
+						   | Start with       |
+						   | llama.cpp and    |
+						   | granite-code     |
+						   | model            |
+						   +------------------+
+```
+
+## In development
+
+Regard this alpha, everything is under development, so expect breaking changes, luckily it's easy to reset everything and re-install:
+
+```
+rm -rf /var/lib/ramalama # only required if running as root user
+rm -rf $HOME/.local/share/ramalama
+```
+
+and install again.
+
+## Credit where credit is due
+
+This project wouldn't be possible without the help of other projects like:
+
+llama.cpp
+whisper.cpp
+vllm
+podman
+omlmd
+huggingface
+
+so if you like this tool, give some of these repos a :star:, and hey, give us a :star: too while you are at it.
+
+## Community
+
+[`Matrix`](https://matrix.to/#/#ramalama:fedoraproject.org)
+
+## Contributors
+
+Open to contributors
+
+<a href="https://github.com/containers/ramalama/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=containers/ramalama" />
+</a>

ramalama-0.5.2/README.md

@@ -0,0 +1,256 @@
+![RAMALAMA logo](logos/PNG/ramalama-logo-full-vertical-added-bg.png)
+
+# RamaLama
+
+The RamaLama project's goal is to make working with AI boring
+through the use of OCI containers.
+
+RamaLama tool facilitates local management and serving of AI Models.
+
+On first run RamaLama inspects your system for GPU support, falling back to CPU support if no GPUs are present.
+
+RamaLama uses container engines like Podman or Docker to pull the appropriate OCI image with all of the software necessary to run an AI Model for your systems setup.
+
+Running in containers eliminates the need for users to configure the host system for AI. After the initialization, RamaLama runs the AI Models within a container based on the OCI image.
+
+RamaLama then pulls AI Models from model registries. Starting a chatbot or a rest API service from a simple single command. Models are treated similarly to how Podman and Docker treat container images.
+
+When both Podman and Docker are installed, RamaLama defaults to Podman, The `RAMALAMA_CONTAINER_ENGINE=docker` environment variable can override this behaviour. When neither are installed RamaLama will attempt to run the model with software on the local system.
+
+RamaLama supports multiple AI model registries types called transports.
+Supported transports:
+
+
+## TRANSPORTS
+
+| Transports    | Web Site                                            |
+| ------------- | --------------------------------------------------- |
+| HuggingFace   | [`huggingface.co`](https://www.huggingface.co)      |
+| Ollama        | [`ollama.com`](https://www.ollama.com)              |
+| OCI Container Registries | [`opencontainers.org`](https://opencontainers.org)|
+||Examples: [`quay.io`](https://quay.io),  [`Docker Hub`](https://docker.io), and [`Artifactory`](https://artifactory.com)|
+
+RamaLama uses the Ollama registry transport by default. Use the RAMALAMA_TRANSPORTS environment variable to modify the default. `export RAMALAMA_TRANSPORT=huggingface` Changes RamaLama to use huggingface transport.
+
+Individual model transports can be modifies when specifying a model via the `huggingface://`, `oci://`, or `ollama://` prefix.
+
+`ramalama pull huggingface://afrideva/Tiny-Vicuna-1B-GGUF/tiny-vicuna-1b.q2_k.gguf`
+
+To make it easier for users, RamaLama uses shortname files, which container
+alias names for fully specified AI Models allowing users to specify the shorter
+names when referring to models. RamaLama reads shortnames.conf files if they
+exist . These files contain a list of name value pairs for specification of
+the model. The following table specifies the order which RamaLama reads the files
+. Any duplicate names that exist override previously defined shortnames.
+
+| Shortnames type | Path                                            |
+| --------------- | ---------------------------------------- |
+| Distribution    | /usr/share/ramalama/shortnames.conf      |
+| Administrators  | /etc/ramamala/shortnames.conf            |
+| Users           | $HOME/.config/ramalama/shortnames.conf   |
+
+```code
+$ cat /usr/share/ramalama/shortnames.conf
+[shortnames]
+  "tiny" = "ollama://tinyllama"
+  "granite" = "huggingface://instructlab/granite-7b-lab-GGUF/granite-7b-lab-Q4_K_M.gguf"
+  "granite:7b" = "huggingface://instructlab/granite-7b-lab-GGUF/granite-7b-lab-Q4_K_M.gguf"
+  "ibm/granite" = "huggingface://instructlab/granite-7b-lab-GGUF/granite-7b-lab-Q4_K_M.gguf"
+  "merlinite" = "huggingface://instructlab/merlinite-7b-lab-GGUF/merlinite-7b-lab-Q4_K_M.gguf"
+  "merlinite:7b" = "huggingface://instructlab/merlinite-7b-lab-GGUF/merlinite-7b-lab-Q4_K_M.gguf"
+...
+```
+
+## Install
+
+## Install via PyPi
+
+RamaLama is available via PyPi [https://pypi.org/project/ramalama](https://pypi.org/project/ramalama)
+
+```
+pip install ramalama
+```
+
+## Install by script
+
+Install RamaLama by running this one-liner:
+
+```
+curl -fsSL https://raw.githubusercontent.com/containers/ramalama/s/install.sh | bash
+```
+
+## Hardware Support
+
+| Hardware                           | Enabled |
+| ---------------------------------- | ------- |
+| CPU                                | :white_check_mark: |
+| Apple Silicon GPU (Linux / Asahi)  | :white_check_mark: |
+| Apple Silicon GPU (macOS)          | :white_check_mark: |
+| Apple Silicon GPU (podman-machine) | :white_check_mark: |
+| Nvidia GPU (cuda)                  | :white_check_mark: |
+| AMD GPU (rocm)                     | :white_check_mark: |
+
+## COMMANDS
+
+| Command                                                | Description                                                |
+| ------------------------------------------------------ | ---------------------------------------------------------- |
+| [ramalama(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama.1.md)                      | primary RamaLama man page                                  |
+| [ramalama-containers(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-containers.1.md)| list all RamaLama containers                               |
+| [ramalama-info(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-info.1.md)                 | display RamaLama configuration information                 |
+| [ramalama-list(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-list.1.md)            | list all downloaded AI Models                              |
+| [ramalama-login(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-login.1.md)          | login to remote registry                                   |
+| [ramalama-logout(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-logout.1.md)        | logout from remote registry                                |
+| [ramalama-pull(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-pull.1.md)            | pull AI Model from Model registry to local storage         |
+| [ramalama-push(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-push.1.md)            | push AI Model from local storage to remote registry        |
+| [ramalama-rm(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-rm.1.md)                | remove AI Model from local storage                         |
+| [ramalama-run(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-run.1.md)              | run specified AI Model as a chatbot                        |
+| [ramalama-serve(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-serve.1.md)          | serve REST API on specified AI Model                       |
+| [ramalama-stop(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-stop.1.md)            | stop named container that is running AI Model              |
+| [ramalama-version(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-version.1.md)      | display version of AI Model                                |
+
+## Usage
+
+### Running Models
+
+You can `run` a chatbot on a model using the `run` command. By default, it pulls from the Ollama registry.
+
+Note: RamaLama will inspect your machine for native GPU support and then will
+use a container engine like Podman to pull an OCI container image with the
+appropriate code and libraries to run the AI Model. This can take a long time to setup, but only on the first run.
+```
+$ ramalama run instructlab/merlinite-7b-lab
+Copying blob 5448ec8c0696 [--------------------------------------] 0.0b / 63.6MiB (skipped: 0.0b = 0.00%)
+Copying blob cbd7e392a514 [--------------------------------------] 0.0b / 65.3MiB (skipped: 0.0b = 0.00%)
+Copying blob 5d6c72bcd967 done  208.5MiB / 208.5MiB (skipped: 0.0b = 0.00%)
+Copying blob 9ccfa45da380 [--------------------------------------] 0.0b / 7.6MiB (skipped: 0.0b = 0.00%)
+Copying blob 4472627772b1 [--------------------------------------] 0.0b / 120.0b (skipped: 0.0b = 0.00%)
+>
+```
+
+After the initial container image has been downloaded, you can interact with
+different models, using the container image.
+```
+$ ramalama run granite-code
+> Write a hello world application in python
+
+print("Hello World")
+```
+
+In a different terminal window see the running podman container.
+```
+$ podman ps
+CONTAINER ID  IMAGE                             COMMAND               CREATED        STATUS        PORTS       NAMES
+91df4a39a360  quay.io/ramalama/ramalama:latest  /home/dwalsh/rama...  4 minutes ago  Up 4 minutes              gifted_volhard
+```
+
+### Listing Models
+
+You can `list` all models pulled into local storage.
+
+```
+$ ramalama list
+NAME                                                                MODIFIED     SIZE
+ollama://smollm:135m                                            16 hours ago 5.5M
+huggingface://afrideva/Tiny-Vicuna-1B-GGUF/tiny-vicuna-1b.q2_k.gguf 14 hours ago 460M
+ollama://granite-code:3b                                            5 days ago   1.9G
+ollama://granite-code:latest                                        1 day ago    1.9G
+ollama://moondream:latest                                           6 days ago   791M
+```
+### Pulling Models
+
+You can `pull` a model using the `pull` command. By default, it pulls from the Ollama registry.
+
+```
+$ ramalama pull granite-code
+###################################################                       32.5%
+```
+
+### Serving Models
+
+You can `serve` multiple models using the `serve` command. By default, it pulls from the Ollama registry.
+
+```
+$ ramalama serve --name mylama llama3
+```
+
+### Stopping servers
+
+You can stop a running model if it is running in a container.
+
+```
+$ ramalama stop mylama
+```
+
+### UI support
+
+To use a UI, run a `ramalama serve` command, then connect via your browser at:
+
+127.0.0.1:8080
+
+## Diagram
+
+```
++---------------------------+
+|                           |
+| ramalama run granite-code |
+|                           |
++-------+-------------------+
+	|
+	|
+	|                                          +------------------+
+	|                                          | Pull model layer |
+	+----------------------------------------->| granite-code     |
+						   +------------------+
+						   | Repo options:    |
+						   +-+-------+------+-+
+						     |       |      |
+						     v       v      v
+					     +---------+ +------+ +----------+
+					     | Hugging | | quay | | Ollama   |
+					     | Face    | |      | | Registry |
+					     +-------+-+ +---+--+ +-+--------+
+						     |       |      |
+						     v       v      v
+						   +------------------+
+						   | Start with       |
+						   | llama.cpp and    |
+						   | granite-code     |
+						   | model            |
+						   +------------------+
+```
+
+## In development
+
+Regard this alpha, everything is under development, so expect breaking changes, luckily it's easy to reset everything and re-install:
+
+```
+rm -rf /var/lib/ramalama # only required if running as root user
+rm -rf $HOME/.local/share/ramalama
+```
+
+and install again.
+
+## Credit where credit is due
+
+This project wouldn't be possible without the help of other projects like:
+
+llama.cpp
+whisper.cpp
+vllm
+podman
+omlmd
+huggingface
+
+so if you like this tool, give some of these repos a :star:, and hey, give us a :star: too while you are at it.
+
+## Community
+
+[`Matrix`](https://matrix.to/#/#ramalama:fedoraproject.org)
+
+## Contributors
+
+Open to contributors
+
+<a href="https://github.com/containers/ramalama/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=containers/ramalama" />
+</a>

ramalama-0.5.2/bin/ramalama

@@ -0,0 +1,95 @@
+#!/usr/bin/env python3
+
+import glob
+import os
+import errno
+import subprocess
+import sys
+
+def add_pipx_venvs_bin_to_path():
+    """
+    Adds available pipx virtual environments bin directories to PATH.
+    This function looks for venv in ~/.local/pipx/venvs/ramalama/bin and
+    if it exists appends it to the environment variable PATH.
+    """
+    pipx_bin_path = os.path.expanduser(f'~/.local/pipx/venvs/ramalama/bin')
+    if os.path.exists(pipx_bin_path):
+        os.environ["PATH"] += ":" + pipx_bin_path
+
+def add_site_packages_to_syspath(base_path):
+    """
+    Adds site-packages directories from a given base path to sys.path.
+    """
+    python_version = f'{sys.version_info.major}.{sys.version_info.minor}'
+    search_pattern = os.path.expanduser(f'{base_path}/lib/python{python_version}/site-packages')
+    matched_paths = glob.glob(search_pattern)
+    if matched_paths:
+        for path in matched_paths:
+            sys.path.insert(0, path)
+        return
+
+    # Fallback to a more general pattern if the specific version doesn't match
+    search_pattern = os.path.expanduser(f'{base_path}/lib/python*/site-packages')
+    matched_paths = glob.glob(search_pattern)
+    if matched_paths:
+        for path in matched_paths:
+            sys.path.insert(0, path)
+
+def main(args):
+    sharedirs = ["/opt/homebrew/share/ramalama", "/usr/local/share/ramalama", "/usr/share/ramalama"]
+    syspath = next((d for d in sharedirs if os.path.exists(d+"/ramalama/cli.py")), None)
+    if syspath:
+        sys.path.insert(0, syspath)
+
+    add_site_packages_to_syspath('~/.local/pipx/venvs/*')
+    add_site_packages_to_syspath('/usr/local')
+    add_pipx_venvs_bin_to_path()
+    sys.path.insert(0, './')
+    try:
+        import ramalama
+    except:
+        print(f"ramalama module not found in sys.path: {sys.path}", file=sys.stderr)
+        raise
+
+    parser, args = ramalama.init_cli()
+
+    # if autocomplete doesn't exist, just do nothing, don't break
+    try:
+        import argcomplete
+        argcomplete.autocomplete(parser)
+    except Exception:
+        None
+
+    if args.version:
+        return ramalama.print_version(args)
+
+    def eprint(e, exit_code):
+        ramalama.perror("Error: " + str(e).strip("'\""))
+        sys.exit(exit_code)
+
+    # Process CLI
+    try:
+        args.func(args)
+    except ramalama.HelpException:
+        parser.print_help()
+    except AttributeError as e:
+        parser.print_usage()
+        print("ramalama: requires a subcommand")
+        if args.debug:
+            raise e
+    except IndexError as e:
+        eprint(e, errno.EINVAL)
+    except KeyError as e:
+        eprint(e, 1)
+    except NotImplementedError as e:
+        eprint(e, errno.ENOTSUP)
+    except subprocess.CalledProcessError as e:
+        eprint(e, e.returncode)
+    except KeyboardInterrupt:
+        sys.exit(0)
+    except ValueError as e:
+        eprint(e, errno.EINVAL)
+
+
+if __name__ == "__main__":
+    main(sys.argv[1:])