Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup and fixes #69

Open
wants to merge 13 commits into
base: next
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 6 additions & 6 deletions .github/workflows/pull_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
# tests can't run in parallel as they write and read data with same keys
max-parallel: 1
matrix:
python-version: ["3.7", "3.8", "3.9"]
python-version: ["3.6", "3.7", "3.8", "3.9"]
steps:
# Get the code into the container
- name: Checkout
Expand All @@ -25,12 +25,12 @@ jobs:
# Test the code
- name: Test code
env:
DETA_SDK_TEST_PROJECT_KEY: ${{secrets.DETA_SDK_TEST_PROJECT_KEY}}
DETA_SDK_TEST_BASE_NAME: ${{secrets.DETA_SDK_TEST_BASE_NAME}}
DETA_SDK_TEST_DRIVE_NAME: ${{secrets.DETA_SDK_TEST_DRIVE_NAME}}
DETA_SDK_TEST_DRIVE_HOST: ${{secrets.DETA_SDK_TEST_DRIVE_HOST}}
DETA_SDK_TEST_PROJECT_KEY: ${{ secrets.DETA_SDK_TEST_PROJECT_KEY }}
DETA_SDK_TEST_BASE_NAME: ${{ secrets.DETA_SDK_TEST_BASE_NAME }}
DETA_SDK_TEST_DRIVE_NAME: ${{ secrets.DETA_SDK_TEST_DRIVE_NAME }}
DETA_SDK_TEST_DRIVE_HOST: ${{ secrets.DETA_SDK_TEST_DRIVE_HOST }}
DETA_SDK_TEST_TTL_ATTRIBUTE: __expires
run: |
python -m pip install --upgrade pip
python -m pip install pytest pytest-asyncio aiohttp
pytest tests
pytest tests
6 changes: 3 additions & 3 deletions .github/workflows/tag_release.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Lint and tag before release

on:
on:
push:
branches:
- release
Expand All @@ -16,10 +16,10 @@ jobs:
- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: ^3.5
python-version: ^3.6
# Install dependencies
- name: Install dependencies
run: "scripts/install"
# Make tag
- name: Make git tag
run: "scripts/tag"
run: "scripts/tag"
5 changes: 2 additions & 3 deletions .github/workflows/test_release.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Test release

on:
on:
workflow_dispatch:

jobs:
Expand All @@ -14,7 +14,7 @@ jobs:
- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: ^3.5
python-version: ^3.6
# Install dependencies
- name: Install dependencies
run: "scripts/install"
Expand All @@ -27,4 +27,3 @@ jobs:
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.PYPI_TEST_TOKEN }}

8 changes: 5 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
.*
!.gitignore
!.github/
__pycache__
__pycache__/
test.py
build/
dist/
*.egg-info
dist
testEnv
.env
venv/
env/
venv/
.venv/
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ source .venv/bin/activate
**Windows**

```powershell
venv/scripts/activate
.venv/scripts/activate
```

### Installing the dependencies
### Install the dependencies

```sh
pip install -r requirements.txt
Expand All @@ -36,21 +36,21 @@ cp env.sample .env

Then provide the values as follows:

- `DETA_SDK_TEST_PROJECT_KEY` Test project key (create a new Deta project for testing and grab the generated key).
- `DETA_SDK_TEST_BASE_NAME` Name of your Base, default is fine.
- `DETA_SDK_TEST_DRIVE_NAME` Name of your Drive, default is fine.
- `DETA_SDK_TEST_DRIVE_HOST` Host URL, default is fine.
- `DETA_SDK_TEST_PROJECT_KEY` - Test project key (create a new Deta project for testing and grab the generated key).
- `DETA_SDK_TEST_BASE_NAME` - Name of your Base, default is fine.
- `DETA_SDK_TEST_DRIVE_NAME` - Name of your Drive, default is fine.
- `DETA_SDK_TEST_DRIVE_HOST` - Host URL, default is fine.

### Run the tests

```sh
python tests.py
pytest tests
```

🎉 Now you are ready to contribute!

### How to contribute
1. Git clone and make a feature branch
2. Make a draft PR
1. Clone this repo and make a feature branch
2. Make a draft pull request
3. Make your changes to the feature branch
4. Mark draft as ready for review
4. Mark your draft as ready for review
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Deta Python Library (SDK)

Supports Python 3.5+ only. [Read the docs.](https://docs.deta.sh/docs/base/sdk)
Supports Python 3.6+ only. [Read the docs.](https://docs.deta.sh/docs/base/sdk)

Install from PyPi
Install from PyPI

```sh
pip install deta
Expand All @@ -13,4 +13,4 @@ If you are interested in contributing, please look at [**CONTRIBUTING.md**](CONT
## How to release (for maintainers)
1. Add changes to `CHANGELOG.md`
2. Merge the `master` branch with the `release` branch.
3. After scripts finish, update release and tag with relevant info
3. After scripts finish, update release and tag with relevant info
89 changes: 49 additions & 40 deletions deta/__init__.py
Original file line number Diff line number Diff line change
@@ -1,78 +1,87 @@
import os
import json
import urllib.error
import urllib.request
import json
from typing import Optional, Sequence, Union

from .base import _Base
from ._async.client import _AsyncBase
from .drive import _Drive
from .utils import _get_project_key_id


try:
from detalib.app import App
from detalib.app import App # type: ignore

app = App()
except Exception:
pass

try:
from ._async.client import AsyncBase
except ImportError:
pass

__version__ = "1.1.0"



def Base(name: str):
def Base(name: str, host: Optional[str] = None):
project_key, project_id = _get_project_key_id()
return _Base(name, project_key, project_id)
return _Base(name, project_key, project_id, host=host)


def Drive(name: str):
# TODO: type hint for session
def AsyncBase(name: str, host: Optional[str] = None, session=None):
project_key, project_id = _get_project_key_id()
return _Drive(name, project_key, project_id)

return _AsyncBase(name, project_key, project_id, host=host, session=session)

class Deta:
def __init__(self, project_key: str = None, *, project_id: str = None):
project_key, project_id = _get_project_key_id(project_key, project_id)
self.project_key = project_key
self.project_id = project_id

def Base(self, name: str, host: str = None):
return _Base(name, self.project_key, self.project_id, host)

def AsyncBase(self, name: str, host: str = None):
from ._async.client import _AsyncBase
return _AsyncBase(name, self.project_key, self.project_id, host)

def Drive(self, name: str, host: str = None):
return _Drive(
name=name,
project_key=self.project_key,
project_id=self.project_id,
host=host,
)

def send_email(self, to, subject, message, charset="UTF-8"):
return send_email(to, subject, message, charset)
def Drive(name: str, host: Optional[str] = None):
project_key, project_id = _get_project_key_id()
return _Drive(name, project_key, project_id, host=host)


def send_email(to, subject, message, charset="UTF-8"):
class Deta:
def __init__(self, project_key: Optional[str] = None, *, project_id: Optional[str] = None):
self.project_key, self.project_id = _get_project_key_id(project_key, project_id)

def Base(self, name: str, host: Optional[str] = None):
return _Base(name, self.project_key, self.project_id, host=host)

# TODO: type hint for session
def AsyncBase(self, name: str, host: Optional[str] = None, session=None):
return _AsyncBase(name, self.project_key, self.project_id, host=host, session=session)

def Drive(self, name: str, host: Optional[str] = None):
return _Drive(name, self.project_key, self.project_id, host=host)

def send_email(
self,
to: Union[str, Sequence[str]],
subject: str,
message: str,
charset: str = "utf-8",
):
send_email(to, subject, message, charset)


def send_email(
to: Union[str, Sequence[str]],
subject: str,
message: str,
charset: str = "utf-8",
):
# FIXME: should function continue if these are not present?
pid = os.getenv("AWS_LAMBDA_FUNCTION_NAME")
url = os.getenv("DETA_MAILER_URL")
api_key = os.getenv("DETA_PROJECT_KEY")
endpoint = f"{url}/mail/{pid}"

to = to if type(to) == list else [to]
if isinstance(to, str):
to = [to]
else:
to = list(to)

data = {
"to": to,
"subject": subject,
"message": message,
"charset": charset,
}

headers = {"X-API-Key": api_key}

req = urllib.request.Request(endpoint, json.dumps(data).encode("utf-8"), headers)
Expand All @@ -82,4 +91,4 @@ def send_email(to, subject, message, charset="UTF-8"):
if resp.getcode() != 200:
raise Exception(resp.read().decode("utf-8"))
except urllib.error.URLError as e:
raise Exception(e.reason)
raise Exception(e.reason) from e