Skip to content

Commit

Permalink
Merge pull request #294 from appwrite/feat-python-ml-starter
Browse files Browse the repository at this point in the history
feat: python ml starter
  • Loading branch information
christyjacob4 authored Jun 18, 2024
2 parents 5bbd466 + bff781a commit 4f2473d
Show file tree
Hide file tree
Showing 4 changed files with 250 additions and 0 deletions.
160 changes: 160 additions & 0 deletions python-ml/starter/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$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

# 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

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# 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
.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/
49 changes: 49 additions & 0 deletions python-ml/starter/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# ⚡ Python ML Starter Function

A simple starter function. Edit `src/main.py` to get started and create something awesome! 🚀

## 🧰 Usage

### GET /

- Returns a "Hello, World!" message.

**Response**

Sample `200` Response:

```text
Hello, World!
```

### POST, PUT, PATCH, DELETE /

- Returns a "Learn More" JSON response.

**Response**

Sample `200` Response:

```json
{
"motto": "Build like a team of hundreds_",
"learn": "https://appwrite.io/docs",
"connect": "https://appwrite.io/discord",
"getInspired": "https://builtwith.appwrite.io",
"numpy": "1.24.3"
}
```

## ⚙️ Configuration

| Setting | Value |
| ----------------- | --------------------------------- |
| Runtime | Python ML (3.11) |
| Entrypoint | `src/main.py` |
| Build Commands | `pip install -r requirements.txt` |
| Permissions | `any` |
| Timeout (Seconds) | 15 |

## 🔒 Environment Variables

No environment variables required.
2 changes: 2 additions & 0 deletions python-ml/starter/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
appwrite
numpy
39 changes: 39 additions & 0 deletions python-ml/starter/src/main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
from appwrite.client import Client
import os
import numpy


# This is your Appwrite function
# It's executed each time we get a request
def main(context):
# Why not try the Appwrite SDK?
#
# client = (
# Client()
# .set_endpoint("https://cloud.appwrite.io/v1")
# .set_project(os.environ["APPWRITE_FUNCTION_PROJECT_ID"])
# .set_key(os.environ["APPWRITE_API_KEY"])
# )

# You can log messages to the console
context.log("Hello, Logs!")

# If something goes wrong, log an error
context.error("Hello, Errors!")

# The `ctx.req` object contains the request data
if context.req.method == "GET":
# Send a response with the res object helpers
# `ctx.res.send()` dispatches a string back to the client
return context.res.send("Hello, World!")

# `ctx.res.json()` is a handy helper for sending JSON
return context.res.json(
{
"motto": "Build like a team of hundreds_",
"learn": "https://appwrite.io/docs",
"connect": "https://appwrite.io/discord",
"getInspired": "https://builtwith.appwrite.io",
"numpy": numpy.__version__,
}
)

0 comments on commit 4f2473d

Please sign in to comment.