instagram-message-api-local 0.0.3b4578__tar.gz

instagram_message_api_local-0.0.3b4578/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: instagram-message-api-local
+Version: 0.0.3b4578
+Summary: PyPI instagram-message-api-local Python Package owned by Circlez.ai
+Home-page: https://github.com/circles-zone/instagram-message-api-local-python-package
+Author: Circles
+Author-email: info@circlez.ai
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+Requires-Dist: python-sdk-remote
+Requires-Dist: requests
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+PyPI instagram-message-api-local Python Package owned by Circlez.ai
+JIRA Work Item: https://circles-zone.atlassian.net/browse/BU-2614
+GHA: https://github.com/circles-zone/instagram-message-api-local-python-package/actions

instagram_message_api_local-0.0.3b4578/README.md

@@ -0,0 +1,43 @@
+# General
+
+Unlike the README.md in the root directory, this is a README.md of this specific repo/package<br>
+
+TODO Please update this README.md of this specific repo/package and not the README.md in the root directory based on the python-package-template repo<br>
+
+## TODOs
+
+TODO example of a TODO, please it with a real TODO<br>
+
+## Direct messages
+
+Python callers can use `InstagramMessageApiClient`:
+
+```python
+from instagram_message_api_local.src.instagram_message_api_client import InstagramMessageApiClient
+
+message_id = InstagramMessageApiClient().send_direct_message(
+    recipient_id="17841400000000000", text="Hello from Python")
+```
+
+The equivalent CLI is:
+
+```text
+instagram-message 17841400000000000 "Hello from the CLI"
+```
+
+Live requests require `INSTAGRAM_GRAPH_API_ACCESS_TOKEN` and
+`IS_REALLY_SEND_INSTAGRAM_MESSAGE=true`; otherwise the client performs a dry run.
+
+## Versions
+
+[pub] 0.0.1 Initial version (change the directories, files, setup.py, .github/workflows/*.yml)<br>
+
+## Installing instructions
+
+It's advised to use venv<br>
+If you have Windows, it's also advised to use Windows Subsystem for Linux<br>
+
+## Install dependencies
+
+Run ./download-beta-sdk.sh from the bash terminal<br>
+Run pip install -r requirements.txt from the bash terminal<br>

instagram_message_api_local-0.0.3b4578/instagram_message_api_local/src/__init__.py

@@ -0,0 +1,3 @@
+from .instagram_message_api_client import InstagramMessageApiClient
+
+__all__ = ["InstagramMessageApiClient"]

instagram_message_api_local-0.0.3b4578/instagram_message_api_local/src/constants_src_the_example_local.py

@@ -0,0 +1,13 @@
+"""Compatibility constants for the original example module."""
+
+
+class ConstantsSrcTheExampleLocal:
+    COMPONENT_NAME = "Instagram Message API Local"
+    UNKNOWN_ID = 0
+
+
+def get_logger_object(category="Code"):
+    return {
+        "component_name": ConstantsSrcTheExampleLocal.COMPONENT_NAME,
+        "component_category": category,
+    }

instagram_message_api_local-0.0.3b4578/instagram_message_api_local/src/instagram_message_api_cli.py

@@ -0,0 +1,20 @@
+"""CLI for Instagram direct messages."""
+
+import argparse
+
+from .instagram_message_api_client import InstagramMessageApiClient
+
+
+def main(argv=None) -> int:
+    parser = argparse.ArgumentParser(prog="instagram-message", description="Send an Instagram direct message")
+    parser.add_argument("recipient_id", help="Instagram-scoped user id")
+    parser.add_argument("text")
+    args = parser.parse_args(argv)
+    message_id = InstagramMessageApiClient().send_direct_message(
+        recipient_id=args.recipient_id, text=args.text)
+    print(message_id or "Dry run: set IS_REALLY_SEND_INSTAGRAM_MESSAGE=true for a live request")
+    return 0
+
+
+if __name__ == "__main__":  # pragma: no cover
+    raise SystemExit(main())

instagram_message_api_local-0.0.3b4578/instagram_message_api_local/src/instagram_message_api_client.py

@@ -0,0 +1,39 @@
+from __future__ import annotations
+
+"""Small Python client for Instagram's Graph API messaging endpoint."""
+
+import os
+from http import HTTPStatus
+
+import requests
+
+
+class InstagramMessageApiClient:
+    """Send Instagram text DMs using an Instagram Graph API access token."""
+
+    def __init__(self, access_token: str | None = None, *, live: bool | None = None):
+        self.access_token = access_token or os.getenv("INSTAGRAM_GRAPH_API_ACCESS_TOKEN")
+        self.live = (
+            live if live is not None else
+            os.getenv("IS_REALLY_SEND_INSTAGRAM_MESSAGE", "false").lower() in {"1", "true", "yes"}
+        )
+
+    def send_direct_message(self, *, recipient_id: str, text: str) -> str | None:
+        if not recipient_id:
+            raise ValueError("recipient_id is required")
+        if not text:
+            raise ValueError("text is required")
+        if not self.live:
+            return None
+        if not self.access_token:
+            raise ValueError("INSTAGRAM_GRAPH_API_ACCESS_TOKEN is required for live requests")
+
+        response = requests.post(
+            "https://graph.instagram.com/v19.0/me/messages",
+            headers={"Authorization": f"Bearer {self.access_token}"},
+            json={"recipient": {"id": recipient_id}, "message": {"text": text}},
+            timeout=30,
+        )
+        if response.status_code != HTTPStatus.OK:
+            response.raise_for_status()
+        return response.json().get("message_id")

instagram_message_api_local-0.0.3b4578/instagram_message_api_local/src/instagram_message_api_enum.py

@@ -0,0 +1,6 @@
+import enum
+
+
+class TheExample(enum.Enum):
+    VALUE1_ID = 20
+    VALUE2_ID = 18

instagram_message_api_local-0.0.3b4578/instagram_message_api_local/src/instagram_message_api_local.py

@@ -0,0 +1,27 @@
+from python_sdk_remote.our_object import OurObject
+
+from .instagram_message_api_client import InstagramMessageApiClient
+
+ENTITY_NAME = "InstagramMessageApi"
+
+
+class InstagramMessageLocal(OurObject):
+
+    # TODO Add all fields
+    fields = {
+        "<example>_id",
+        "display_as",
+    }
+
+    def __init__(self, entity_name=ENTITY_NAME, **kwargs):
+        super().__init__(entity_name, **kwargs)
+
+    # Mandatory pure virtual method from OurObject
+    def get_name(self):
+        print(f"{ENTITY_NAME} get_name() self.fields.display_as={self.fields.display_as}")
+        return self.fields.display_as
+
+    def send(self, *, recipient_id: str, text: str) -> str | None:
+        """Send a text direct message through the Instagram Graph API."""
+        return InstagramMessageApiClient().send_direct_message(
+            recipient_id=recipient_id, text=text)

instagram_message_api_local-0.0.3b4578/instagram_message_api_local/src/version.py

@@ -0,0 +1 @@
+PACKAGE_VERSION = "0.0.0"

instagram_message_api_local-0.0.3b4578/instagram_message_api_local/tests/conftest.py

@@ -0,0 +1,5 @@
+"""Shared test configuration.
+
+The API client tests are intentionally offline and need no database.
+Database integration tests should opt in to their own fixture explicitly.
+"""

instagram_message_api_local-0.0.3b4578/instagram_message_api_local/tests/unit/instagram_message_api_client_unit_test.py

@@ -0,0 +1,53 @@
+from http import HTTPStatus
+from unittest.mock import MagicMock, patch
+
+import requests
+
+import pytest
+
+from instagram_message_api_local.src.instagram_message_api_client import InstagramMessageApiClient
+
+
+def test_dry_run_does_not_call_graph_api():
+    with patch("instagram_message_api_local.src.instagram_message_api_client.requests.post") as post:
+        assert InstagramMessageApiClient(live=False).send_direct_message(
+            recipient_id="user-1", text="hello") is None
+        post.assert_not_called()
+
+
+@pytest.mark.parametrize("recipient_id,text", [("", "hello"), ("user-1", "")])
+def test_send_validates_required_fields(recipient_id, text):
+    with pytest.raises(ValueError):
+        InstagramMessageApiClient(live=False).send_direct_message(
+            recipient_id=recipient_id, text=text)
+
+
+def test_live_send_requires_token():
+    with pytest.raises(ValueError, match="ACCESS_TOKEN"):
+        InstagramMessageApiClient(live=True).send_direct_message(
+            recipient_id="user-1", text="hello")
+
+
+def test_live_send_returns_meta_message_id():
+    response = MagicMock(status_code=HTTPStatus.OK, json=lambda: {"message_id": "mid-1"})
+    with patch("instagram_message_api_local.src.instagram_message_api_client.requests.post",
+               return_value=response) as post:
+        result = InstagramMessageApiClient(access_token="token", live=True).send_direct_message(
+            recipient_id="user-1", text="hello")
+    assert result == "mid-1"
+    post.assert_called_once_with(
+        "https://graph.instagram.com/v19.0/me/messages",
+        headers={"Authorization": "Bearer token"},
+        json={"recipient": {"id": "user-1"}, "message": {"text": "hello"}},
+        timeout=30,
+    )
+
+
+def test_live_send_raises_for_graph_error():
+    response = MagicMock(status_code=HTTPStatus.BAD_REQUEST)
+    response.raise_for_status.side_effect = requests.HTTPError("bad request")
+    with patch("instagram_message_api_local.src.instagram_message_api_client.requests.post",
+               return_value=response):
+        with pytest.raises(Exception):
+            InstagramMessageApiClient(access_token="token", live=True).send_direct_message(
+                recipient_id="user-1", text="hello")

instagram_message_api_local-0.0.3b4578/instagram_message_api_local.egg-info/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: instagram-message-api-local
+Version: 0.0.3b4578
+Summary: PyPI instagram-message-api-local Python Package owned by Circlez.ai
+Home-page: https://github.com/circles-zone/instagram-message-api-local-python-package
+Author: Circles
+Author-email: info@circlez.ai
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+Requires-Dist: python-sdk-remote
+Requires-Dist: requests
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+PyPI instagram-message-api-local Python Package owned by Circlez.ai
+JIRA Work Item: https://circles-zone.atlassian.net/browse/BU-2614
+GHA: https://github.com/circles-zone/instagram-message-api-local-python-package/actions

instagram_message_api_local-0.0.3b4578/instagram_message_api_local.egg-info/SOURCES.txt

@@ -0,0 +1,21 @@
+README.md
+pyproject.toml
+setup.py
+instagram_message_api_local/__init__.py
+instagram_message_api_local.egg-info/PKG-INFO
+instagram_message_api_local.egg-info/SOURCES.txt
+instagram_message_api_local.egg-info/dependency_links.txt
+instagram_message_api_local.egg-info/entry_points.txt
+instagram_message_api_local.egg-info/requires.txt
+instagram_message_api_local.egg-info/top_level.txt
+instagram_message_api_local/src/__init__.py
+instagram_message_api_local/src/constants_src_the_example_local.py
+instagram_message_api_local/src/instagram_message_api_cli.py
+instagram_message_api_local/src/instagram_message_api_client.py
+instagram_message_api_local/src/instagram_message_api_enum.py
+instagram_message_api_local/src/instagram_message_api_local.py
+instagram_message_api_local/src/version.py
+instagram_message_api_local/tests/__init__.py
+instagram_message_api_local/tests/conftest.py
+instagram_message_api_local/tests/unit/__init__.py
+instagram_message_api_local/tests/unit/instagram_message_api_client_unit_test.py

instagram_message_api_local-0.0.3b4578/instagram_message_api_local.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

instagram_message_api_local-0.0.3b4578/instagram_message_api_local.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+instagram-message = instagram_message_api_local.src.instagram_message_api_cli:main

instagram_message_api_local-0.0.3b4578/instagram_message_api_local.egg-info/requires.txt

@@ -0,0 +1,2 @@
+python-sdk-remote
+requests

instagram_message_api_local-0.0.3b4578/instagram_message_api_local.egg-info/top_level.txt

@@ -0,0 +1 @@
+instagram_message_api_local

instagram_message_api_local-0.0.3b4578/pyproject.toml

@@ -0,0 +1,30 @@
+# This file should be in the future instead of setup.py
+# https://python-poetry.org/docs/pyproject
+# https://stackoverflow.com/questions/78048223/adding-folder-with-data-with-pyproject-toml
+# https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#license
+
+# This file is mandatory for the `poetry version patch`
+
+# It seems we need to copy this file also to serverless-com repo, as required by dialog-workflow-python-package
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.pytest.ini_options]
+pythonpath = ["."]
+
+[tool.poetry]
+# TODO: Please update the name, similar to storage-local (suffix -local)
+name = "<project-name>"
+# I believe we are still using the version from setup.py and not from here until Potery will work
+version = "0.0.3b4578" # https://pypi.org/project/<project-name> i.e. https://pypi.org/project/storage-local/
+description = "<project-name> Python Package"
+readme = "README.md"
+authors = [
+    "Circlez.ai <info@circlez.ai>",
+]
+
+[tool.poetry.dev-dependencies]
+pytest = "^8.0"
+pytest-cov = "^5.0"

instagram_message_api_local-0.0.3b4578/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

instagram_message_api_local-0.0.3b4578/setup.py

@@ -0,0 +1,80 @@
+# serverless.com repo "python -m build" works without setup.py
+# Should update package_dir if not using our recommended directory structure
+
+import setuptools
+
+# TODO: Change the PACKAGE_NAME to the package's name - Either xxx-local or
+#  xxx-remote (without the -python-package suffix). Only lowercase, no
+#  underlines.
+# Used by pypa/gh-action-pypi-publish
+# Package Name should be identical to the inner directory name
+# Changing the package name here, will cause a change in the package directory
+#  name as well
+# PACKAGE_NAME should be singular if handling only one instance
+# PACKAGE_NAME should not include the word "main"
+
+# e.g.: queue-local, without python-package suffix
+PACKAGE_NAME = "instagram-message-api-local"
+
+package_dir = PACKAGE_NAME.replace("-", "_")
+# If we need backward-compatible:
+# old_package_dir = "old_package_name"
+
+PACKAGE_DESCRIPTION = f"PyPI {PACKAGE_NAME} Python Package owned by Circlez.ai"
+
+setuptools.setup(
+    license='MIT',
+    name=PACKAGE_NAME,
+    # Increase this number every time you make a change you
+    #  want to publish. After 0.0.9 switch to 0.0.10 and not 0.1.0
+    # version can't be 0.0.
+    # If you find yourself increasing the version in more than one patch number (it might indicate there are multiple branches which you should submit their PRs before your PR)  # noqa: E501
+    # TODO add the Jira Work Item (Jira Issue) number after the version i.e., 0.0.1b2432
+    version="0.0.3b4578",  # https://pypi.org/project/instagram-message-api-local/
+    author="Circles",
+    author_email="info@circlez.ai",
+    description=f"{PACKAGE_DESCRIPTION}",
+    # long_description=f"{description}",
+    long_description=f"{PACKAGE_DESCRIPTION}\n"
+            "JIRA Work Item: https://circles-zone.atlassian.net/browse/BU-2614\n"
+            "GHA: https://github.com/circles-zone/instagram-message-api-local-python-package/actions",
+
+    long_description_content_type='text/markdown',
+    url=f"https://github.com/circles-zone/{PACKAGE_NAME}-python-package",
+    # packages=[package_dir],
+    # packages=[package_dir, old_package_dir],
+    packages=setuptools.find_packages(),
+    entry_points={
+        "console_scripts": [
+            "instagram-message=instagram_message_api_local.src.instagram_message_api_cli:main",
+        ],
+    },
+
+    # I'm not sure we need package_dir
+    # package_dir={package_dir: f'{package_dir}/src'},
+    # TODO Unfortunately in event-main-local-restapi there are no
+    #  repo-directory and no package directory (flat directory structure)
+    # package_dir={package_dir: f'src'},
+
+    # package_dir={package_dir: f'{package_dir}/src',
+    #  old_package_dir: f'{package_dir}/src'},
+    package_data={package_dir: ['*.py']},
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        # https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#license
+        # TODO Fix all repos, especially the Python templates
+        #
+        "Operating System :: OS Independent",
+    ],
+    # Do not add packages needed only for tests i.e. packages for get_test_xxx(
+    # TODO: Update which packages to include with this package in production
+    #  (dependencies) - Not for development/testing
+    install_requires=[
+        'python-sdk-remote',
+        # TODO: In -local package please uncomment the bellow line. In -remote packages please delete this line.  # noqa E501
+        # 'smart-datastore-local',
+        # 'logzio-python-handler>=4.1.2',  # https://pypi.org/project/logzio-python-handler/
+        'requests',
+    ]
+)
+