From 0f1e426adf7ce3fdaaeda87dd2ce6073f32d153a Mon Sep 17 00:00:00 2001 From: Ahmed_Elsharkawy Date: Mon, 8 Sep 2025 17:33:30 +0000 Subject: [PATCH] upload project Signed-off-by: Ahmed_Elsharkawy --- .env.example | 3 + .gitignore | 208 +++++++++++++++++++++++++++++++++++++++++++++++ README.md | 51 +++++++++++- main.py | 19 +++++ requirements.txt | 2 + 5 files changed, 280 insertions(+), 3 deletions(-) create mode 100644 .env.example create mode 100644 .gitignore create mode 100644 main.py create mode 100644 requirements.txt diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..66c8a6b --- /dev/null +++ b/.env.example @@ -0,0 +1,3 @@ +APP_Name="Simple Example To Using Ghaymah GenAI" +APP_Version="0.1.0" +API_KEY="" # put your API key here (https://deploy.ghaymah.systems/dashboard/genai) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b1fd357 --- /dev/null +++ b/.gitignore @@ -0,0 +1,208 @@ +# Local environment files +GanAi-Env/ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[codz] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py.cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# UV +# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +#uv.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock +#poetry.toml + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python. +# https://pdm-project.org/en/latest/usage/project/#working-with-version-control +#pdm.lock +#pdm.toml +.pdm-python +.pdm-build/ + +# pixi +# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control. +#pixi.lock +# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one +# in the .venv directory. It is recommended not to include this directory in version control. +.pixi + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.envrc +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + +# Abstra +# Abstra is an AI-powered process automation framework. +# Ignore directories containing user credentials, local state, and settings. +# Learn more at https://abstra.io/docs +.abstra/ + +# Visual Studio Code +# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore +# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore +# and can be added to the global gitignore or merged into this file. However, if you prefer, +# you could uncomment the following to ignore the entire vscode folder +# .vscode/ + +# Ruff stuff: +.ruff_cache/ + +# PyPI configuration file +.pypirc + +# Marimo +marimo/_static/ +marimo/_lsp/ +__marimo__/ + +# Streamlit +.streamlit/secrets.toml + +/RAG-Env/* +text.txt diff --git a/README.md b/README.md index 020790d..5ba8cc7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,48 @@ -# Simple-Example-To-Using-Ghaymah-GenAI - -Simple Example of Using Ghaymah GenAI to help anyone professionally use Ghaymah GenAI. \ No newline at end of file +# Simple Example To Using Ghaymah GenAI + +this is the Simple Example to help anyone to use Ghaymah GenAI in a professional way. + +## Requirements + - python 3.12 or later + +## Create a new environment: + +```bash +$ python -m venv Gan-env +``` + +## Activate it: + +## On Windows (cmd): + +```bash +$ Gan-env\Scripts\activate +``` + +## On Mac/Linux: + +```bash +$ source Gan-env/bin/activate +``` + +## Installation + +### Install the required packages + +```bash +$ pip install -r requirements.txt +``` + +### Setup the environment variables + +```bash +$ cp .env.example .env +``` + +Set your environment variables in the `.env` file. Like `API_KEY` value. + +## Run The Example + +```bash +$ python main.py +``` diff --git a/main.py b/main.py new file mode 100644 index 0000000..43dc9ca --- /dev/null +++ b/main.py @@ -0,0 +1,19 @@ +from openai import OpenAI +import os +from dotenv import load_dotenv + +load_dotenv() + +api_key=os.getenv("API_KEY") + +client = OpenAI(api_key=api_key, base_url="https://genai.ghaymah.systems") + +response = client.chat.completions.create( + model="DeepSeek-V3-0324", + messages=[ + {"role": "user", "content": "Explain AI in simple terms"} + ], + max_tokens=100 +) + +print(response.choices[0].message.content) diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..78b69f1 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +openai +dotenv