hyperpocket 0.0.3__tar.gz → 0.1.9__tar.gz

hyperpocket-0.1.9/.gitignore

@@ -0,0 +1,157 @@
+.vs/
+.vscode/
+.idea/
+# 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/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Google GitHub Actions credentials files created by:
+# https://github.com/google-github-actions/auth
+#
+# That action recommends adding this gitignore to prevent accidentally committing keys.
+gha-creds-*.json
+
+# 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
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+
+# Jupyter Notebook
+.ipynb_checkpoints
+notebooks/
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv*
+venv*
+env/
+ENV/
+env.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.mypy_cache_test/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# macOS display setting files
+.DS_Store
+
+# Wandb directory
+wandb/
+
+# asdf tool versions
+.tool-versions
+/.ruff_cache/
+
+*.pkl
+*.bin
+
+# integration test artifacts
+data_map*
+\[('_type', 'fake'), ('stop', None)]
+
+# Replit files
+*replit*
+
+
+prof
+virtualenv/
+
+# Ignore dynaconf secret files
+**/.secrets.toml
+*.xml
+*.iml
+pocket.lock
+.log/
+.pocket/
+_build/

{hyperpocket-0.0.3 → hyperpocket-0.1.9}/PKG-INFO

@@ -1,47 +1,41 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: hyperpocket
-Version: 0.0.3
+Version: 0.1.9
 Summary: Building AI agent with hyperpocket tool in a flash
-Home-page: https://vessl-ai.github.io/hyperpocket
-Author: VESSL AI Devs
-Author-email: dev@vessl.ai
-Requires-Python: >=3.11,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: click (>=8.1.7,<9.0.0)
-Requires-Dist: dynaconf (>=3.2.6,<4.0.0)
-Requires-Dist: fastapi (>=0.115.5,<0.116.0)
-Requires-Dist: gitpython (>=3.1.43,<4.0.0)
-Requires-Dist: httpx (==0.27)
-Requires-Dist: jinja2 (>=3.1.4,<4.0.0)
-Requires-Dist: multiprocess (>=0.70.17,<0.71.0)
-Requires-Dist: playwright (>=1.49.0,<2.0.0)
-Requires-Dist: pydantic (>=2.10.2,<3.0.0)
-Requires-Dist: pygithub (>=2.5.0,<3.0.0)
-Requires-Dist: python-multipart (>=0.0.19,<0.0.20)
-Requires-Dist: redis (>=5.2.1,<6.0.0)
-Requires-Dist: requests (>=2.32.3,<3.0.0)
-Requires-Dist: toml (>=0.10.2,<0.11.0)
-Requires-Dist: uvicorn (>=0.32.1,<0.33.0)
+Project-URL: Homepage, https://vessl-ai.github.io/hyperpocket
 Project-URL: Repository, https://github.com/vessl-ai/hyperpocket
+Author-email: Hyperpocket Team <hyperpocket@vessl.ai>
+Requires-Python: >=3.10
+Requires-Dist: click>=8.1.7
+Requires-Dist: dynaconf>=3.2.6
+Requires-Dist: fastapi>=0.115.5
+Requires-Dist: gitpython>=3.1.43
+Requires-Dist: httpx==0.27
+Requires-Dist: jinja2>=3.1.4
+Requires-Dist: multiprocess>=0.70.17
+Requires-Dist: playwright>=1.49.0
+Requires-Dist: pydantic>=2.10.2
+Requires-Dist: pygithub>=2.5.0
+Requires-Dist: python-multipart>=0.0.19
+Requires-Dist: redis>=5.2.1
+Requires-Dist: requests>=2.32.3
+Requires-Dist: toml>=0.10.2
+Requires-Dist: uvicorn>=0.32.1
 Description-Content-Type: text/markdown
 
-# Pocket 👛
+# Hyperpocket 👛
 
-Pocket is where tools belong. Power your agent up with a pocket of tools. 👛
+Hyperpocket is where tools belong. Power your agent up with a pocket of tools. 👛
 
 <figure>
-<img src="image.png" alt="4d-pocket" width="200"/>
-<figcaption>© Doraemon</figcaption>
+<img src="../../logo.png" alt="hyperpocket" width="200"/>
 </figure>
 
 ## Introduction
 
-Pocket is a tool that allows you to easily use tool and auth for agents on your machine.
+Hyperpocket is a tool that allows you to easily use tool and auth for agents on your machine.
 
-**_Start fast._** Just install Pocket and use it. We know you don't have time to authenticate to our server.
+**_Start fast._** Just install Hyperpocket and use it. We know you don't have time to authenticate to our server.
 
 **_Go securely._** Not like others, you are the only one who knows your secret tokens. We do NOT. All of your secret
 tokens belong to your infrastructure, not ours.
@@ -52,17 +46,12 @@ with the dependency spaghetti.
 
 **_Battery Included_** You can use popular tools and authentication providers out-of-the-box.
 
-<figure>
-<img src="pocket1.png" alt="pocket-flow" width="400"/>
-<figcaption></figcaption>
-</figure>
-
 ## Installation
 
-1. install pocket
+1. install hyperpocket
 
 ```bash
-pip install pocket
+pip install hyperpocket
 ```
 
 2. install playwright
@@ -87,17 +76,15 @@ Or just use LLM API Clients out of the box.
 ### Using out-of-the-box tools
 
 ```python
+from hyperpocket.tool import from_git
 from langchain_openai import ChatOpenAI
 
-import hyperpocket as pk
-import hyperpocket.curated_tools
-from pocket_langchain import PocketLangchain
+from hyperpocket_langchain import PocketLangchain
 
 pklc = PocketLangchain(
     tools=[
-        *pk.curated_tools.SLACK,  # SLACK = [slack_get_message, slack_post_message, ..]
-        *pk.curated_tools.LINEAR,
-        "https://github.com/my-org/some-awesome-tool",
+        from_git("https://github.com/vessl-ai/hyperawesometools", "main", "managed-tools/slack/get-message"),
+        from_git("https://github.com/vessl-ai/hyperawesometools", "main", "managed-tools/slack/post-message"),
     ]
 )
 tools = pklc.get_tools()
@@ -111,45 +98,43 @@ llm_tool_binding.invoke(...)
 
 There are two kinds of auth process, one is using system auth(developer api key) and the other is using end user auth.
 
-Pocket provides way to use end user auth easily.
+Hyperpocket provides way to use end user auth easily.
 (Of course, you can also just set your STRIPE_API_KEY when using Stripe API related tools)
 
 - Supported methods
 
-    - [x] OAuth
-    - [x] Token
-    - [ ] Basic Auth (Username, Password)
+  - [x] OAuth
+  - [x] Token
+  - [ ] Basic Auth (Username, Password)
 
 - Supported OAuth Providers
-    - [x] Google
-    - [x] GitHub
-    - [x] Slack
-    - [x] Linear
-    - [ ] Facebook
-    - [ ] X (Previously Twitter)
-    - [ ] LinkedIn
-    - [ ] Discord
-    - [ ] Zoom
-    - [ ] Microsoft
-    - [ ] Spotify
-    - [ ] Twitch
+  - [x] Google
+  - [x] GitHub
+  - [x] Slack
+  - [x] Linear
+  - [ ] Facebook
+  - [ ] X (Previously Twitter)
+  - [ ] LinkedIn
+  - [ ] Discord
+  - [ ] Zoom
+  - [ ] Microsoft
+  - [ ] Spotify
+  - [ ] Twitch
 
 You can manage your auths in request-wise level. (e.g. you can use different auths for different requests)
 
 ```python
+from hyperpocket.tool import from_git
 from langchain_openai import ChatOpenAI
 from langgraph.graph import StateGraph, START, MessagesState
 from langgraph.prebuilt import tools_condition
 
-import hyperpocket as pk
-import hyperpocket.curated_tools
-from pocket_langgraph import PocketLanggraph
+from hyperpocket_langgraph import PocketLanggraph
 
 pklg = PocketLanggraph(
     tools=[
-        *pk.curated_tools.SLACK,  # SLACK = [slack_get_message, slack_post_message, ..]
-        *pk.curated_tools.LINEAR,
-        "https://github.com/my-org/some-awesome-tool",
+        from_git("https://github.com/vessl-ai/hyperawesometools", "main", "managed-tools/slack/get-message"),
+        from_git("https://github.com/vessl-ai/hyperawesometools", "main", "managed-tools/slack/post-message"),
     ],
 )
 llm = ChatOpenAI()
@@ -175,12 +160,12 @@ graph_builder.compile()
 ```
 
 ```python
+from hyperpocket.config import secret
+from hyperpocket.tool import from_git
 from llama_index.core.agent import FunctionCallingAgent
 from llama_index.llms.openai import OpenAI
-from pocket_llamaindex import PocketLlamaindex
 
-from hyperpocket.config import secret
-from hyperpocket.tool import from_git
+from hyperpocket_llamaindex import PocketLlamaindex
 
 llm = OpenAI(api_key=secret["OPENAI_API_KEY"])
 pocket = PocketLlamaindex(
@@ -227,12 +212,8 @@ Assistance: Here are the recent 10 messages.
 
 ### Config
 
-Running `pocket config init` will create your config file in `$HOME/.pocket/settings.toml`
-
 The `settings.toml` looks as follows.
 
-TODO: Add `secrets.toml`.
-
 ```toml
 log_level = "debug"
 internal_server_port = "8000" # optional, default is 8000
@@ -273,11 +254,11 @@ client_secret = ""  # your github client secret
 
 - While creating your github OAuth app, configuring your app's `Authorization callback URL` is different for your
   development environment and production environment.
-    - For development environment, you can use `http://localhost:8000/auth/github/callback`
-        - **Note**: Default port for pocket dev server is `8000`. If you are using a different port, make sure to
-          replace `8000` with your actual port number.
-    - For production environment, you can use `https://yourdomain.com/auth/github/callback`
-        - **Note**: Make sure to replace `yourdomain.com` with your actual domain name that this app will be hosted on.
+  - For development environment, you can use `http://localhost:8000/auth/github/callback`
+    - **Note**: Default port for hyperpocket dev server is `8000`. If you are using a different port, make sure to
+      replace `8000` with your actual port number.
+  - For production environment, you can use `https://yourdomain.com/auth/github/callback`
+    - **Note**: Make sure to replace `yourdomain.com` with your actual domain name that this app will be hosted on.
 
 #### How to integrate SLACK OAuth app
 
@@ -288,15 +269,53 @@ client_secret = ""  # your github client secret
 - Redirect URLs :
   `{public_server_protocol}://{public_hostname}:[{public_server_port}]/{callback_url_rewrite_prefix}/auth/slack/oauth2/callback`
 - Scopes : What you want to request to user.
-    - Recommended scopes :
-        - channels:history,
-        - channels:read,
-        - chat:write,
-        - groups:history,
-        - groups:read,
-        - im:history,
-        - mpim:history,
-        - reactions:read,
-        - reactions:write,
+  - Recommended scopes :
+    - channels:history,
+    - channels:read,
+    - chat:write,
+    - groups:history,
+    - groups:read,
+    - im:history,
+    - mpim:history,
+    - reactions:read,
+    - reactions:write,
 
 3. Set your Slack APP Client ID / Client Secret in `$HOME/.pocket/settings.toml`
+
+#### How to start adding a new token auth
+
+1. Generate boilerplate codes for token-based auth services ?
+
+```
+# service_name should be lowercase including underscore
+poetry run hyperpocket devtool create-token-auth-template {service_name}
+```
+
+It will generate boilerplate code lines for a new token-based auth service
+
+2. Extend AuthProvider enum to add your new auth provider.
+
+```python
+class AuthProvider(Enum):
+SERVICE = 'service'
+```
+
+3. Specify auth provider for tools
+
+1) github repo or local
+
+```toml
+[auth]
+auth_provider = "{service_name}"
+auth_handler = "{service_name}-token"
+scopes = []
+```
+
+2. function_tool
+
+```python
+@function_tool(
+    auth_provider=AuthProvider.SERVICE
+)
+def my_function(**kwargs):
+```

{hyperpocket-0.0.3 → hyperpocket-0.1.9}/README.md

@@ -1,17 +1,16 @@
-# Pocket 👛
+# Hyperpocket 👛
 
-Pocket is where tools belong. Power your agent up with a pocket of tools. 👛
+Hyperpocket is where tools belong. Power your agent up with a pocket of tools. 👛
 
 <figure>
-<img src="image.png" alt="4d-pocket" width="200"/>
-<figcaption>© Doraemon</figcaption>
+<img src="../../logo.png" alt="hyperpocket" width="200"/>
 </figure>
 
 ## Introduction
 
-Pocket is a tool that allows you to easily use tool and auth for agents on your machine.
+Hyperpocket is a tool that allows you to easily use tool and auth for agents on your machine.
 
-**_Start fast._** Just install Pocket and use it. We know you don't have time to authenticate to our server.
+**_Start fast._** Just install Hyperpocket and use it. We know you don't have time to authenticate to our server.
 
 **_Go securely._** Not like others, you are the only one who knows your secret tokens. We do NOT. All of your secret
 tokens belong to your infrastructure, not ours.
@@ -22,17 +21,12 @@ with the dependency spaghetti.
 
 **_Battery Included_** You can use popular tools and authentication providers out-of-the-box.
 
-<figure>
-<img src="pocket1.png" alt="pocket-flow" width="400"/>
-<figcaption></figcaption>
-</figure>
-
 ## Installation
 
-1. install pocket
+1. install hyperpocket
 
 ```bash
-pip install pocket
+pip install hyperpocket
 ```
 
 2. install playwright
@@ -57,17 +51,15 @@ Or just use LLM API Clients out of the box.
 ### Using out-of-the-box tools
 
 ```python
+from hyperpocket.tool import from_git
 from langchain_openai import ChatOpenAI
 
-import hyperpocket as pk
-import hyperpocket.curated_tools
-from pocket_langchain import PocketLangchain
+from hyperpocket_langchain import PocketLangchain
 
 pklc = PocketLangchain(
     tools=[
-        *pk.curated_tools.SLACK,  # SLACK = [slack_get_message, slack_post_message, ..]
-        *pk.curated_tools.LINEAR,
-        "https://github.com/my-org/some-awesome-tool",
+        from_git("https://github.com/vessl-ai/hyperawesometools", "main", "managed-tools/slack/get-message"),
+        from_git("https://github.com/vessl-ai/hyperawesometools", "main", "managed-tools/slack/post-message"),
     ]
 )
 tools = pklc.get_tools()
@@ -81,45 +73,43 @@ llm_tool_binding.invoke(...)
 
 There are two kinds of auth process, one is using system auth(developer api key) and the other is using end user auth.
 
-Pocket provides way to use end user auth easily.
+Hyperpocket provides way to use end user auth easily.
 (Of course, you can also just set your STRIPE_API_KEY when using Stripe API related tools)
 
 - Supported methods
 
-    - [x] OAuth
-    - [x] Token
-    - [ ] Basic Auth (Username, Password)
+  - [x] OAuth
+  - [x] Token
+  - [ ] Basic Auth (Username, Password)
 
 - Supported OAuth Providers
-    - [x] Google
-    - [x] GitHub
-    - [x] Slack
-    - [x] Linear
-    - [ ] Facebook
-    - [ ] X (Previously Twitter)
-    - [ ] LinkedIn
-    - [ ] Discord
-    - [ ] Zoom
-    - [ ] Microsoft
-    - [ ] Spotify
-    - [ ] Twitch
+  - [x] Google
+  - [x] GitHub
+  - [x] Slack
+  - [x] Linear
+  - [ ] Facebook
+  - [ ] X (Previously Twitter)
+  - [ ] LinkedIn
+  - [ ] Discord
+  - [ ] Zoom
+  - [ ] Microsoft
+  - [ ] Spotify
+  - [ ] Twitch
 
 You can manage your auths in request-wise level. (e.g. you can use different auths for different requests)
 
 ```python
+from hyperpocket.tool import from_git
 from langchain_openai import ChatOpenAI
 from langgraph.graph import StateGraph, START, MessagesState
 from langgraph.prebuilt import tools_condition
 
-import hyperpocket as pk
-import hyperpocket.curated_tools
-from pocket_langgraph import PocketLanggraph
+from hyperpocket_langgraph import PocketLanggraph
 
 pklg = PocketLanggraph(
     tools=[
-        *pk.curated_tools.SLACK,  # SLACK = [slack_get_message, slack_post_message, ..]
-        *pk.curated_tools.LINEAR,
-        "https://github.com/my-org/some-awesome-tool",
+        from_git("https://github.com/vessl-ai/hyperawesometools", "main", "managed-tools/slack/get-message"),
+        from_git("https://github.com/vessl-ai/hyperawesometools", "main", "managed-tools/slack/post-message"),
     ],
 )
 llm = ChatOpenAI()
@@ -145,12 +135,12 @@ graph_builder.compile()
 ```
 
 ```python
+from hyperpocket.config import secret
+from hyperpocket.tool import from_git
 from llama_index.core.agent import FunctionCallingAgent
 from llama_index.llms.openai import OpenAI
-from pocket_llamaindex import PocketLlamaindex
 
-from hyperpocket.config import secret
-from hyperpocket.tool import from_git
+from hyperpocket_llamaindex import PocketLlamaindex
 
 llm = OpenAI(api_key=secret["OPENAI_API_KEY"])
 pocket = PocketLlamaindex(
@@ -197,12 +187,8 @@ Assistance: Here are the recent 10 messages.
 
 ### Config
 
-Running `pocket config init` will create your config file in `$HOME/.pocket/settings.toml`
-
 The `settings.toml` looks as follows.
 
-TODO: Add `secrets.toml`.
-
 ```toml
 log_level = "debug"
 internal_server_port = "8000" # optional, default is 8000
@@ -243,11 +229,11 @@ client_secret = ""  # your github client secret
 
 - While creating your github OAuth app, configuring your app's `Authorization callback URL` is different for your
   development environment and production environment.
-    - For development environment, you can use `http://localhost:8000/auth/github/callback`
-        - **Note**: Default port for pocket dev server is `8000`. If you are using a different port, make sure to
-          replace `8000` with your actual port number.
-    - For production environment, you can use `https://yourdomain.com/auth/github/callback`
-        - **Note**: Make sure to replace `yourdomain.com` with your actual domain name that this app will be hosted on.
+  - For development environment, you can use `http://localhost:8000/auth/github/callback`
+    - **Note**: Default port for hyperpocket dev server is `8000`. If you are using a different port, make sure to
+      replace `8000` with your actual port number.
+  - For production environment, you can use `https://yourdomain.com/auth/github/callback`
+    - **Note**: Make sure to replace `yourdomain.com` with your actual domain name that this app will be hosted on.
 
 #### How to integrate SLACK OAuth app
 
@@ -258,15 +244,53 @@ client_secret = ""  # your github client secret
 - Redirect URLs :
   `{public_server_protocol}://{public_hostname}:[{public_server_port}]/{callback_url_rewrite_prefix}/auth/slack/oauth2/callback`
 - Scopes : What you want to request to user.
-    - Recommended scopes :
-        - channels:history,
-        - channels:read,
-        - chat:write,
-        - groups:history,
-        - groups:read,
-        - im:history,
-        - mpim:history,
-        - reactions:read,
-        - reactions:write,
-
-3. Set your Slack APP Client ID / Client Secret in `$HOME/.pocket/settings.toml`
+  - Recommended scopes :
+    - channels:history,
+    - channels:read,
+    - chat:write,
+    - groups:history,
+    - groups:read,
+    - im:history,
+    - mpim:history,
+    - reactions:read,
+    - reactions:write,
+
+3. Set your Slack APP Client ID / Client Secret in `$HOME/.pocket/settings.toml`
+
+#### How to start adding a new token auth
+
+1. Generate boilerplate codes for token-based auth services ?
+
+```
+# service_name should be lowercase including underscore
+poetry run hyperpocket devtool create-token-auth-template {service_name}
+```
+
+It will generate boilerplate code lines for a new token-based auth service
+
+2. Extend AuthProvider enum to add your new auth provider.
+
+```python
+class AuthProvider(Enum):
+SERVICE = 'service'
+```
+
+3. Specify auth provider for tools
+
+1) github repo or local
+
+```toml
+[auth]
+auth_provider = "{service_name}"
+auth_handler = "{service_name}-token"
+scopes = []
+```
+
+2. function_tool
+
+```python
+@function_tool(
+    auth_provider=AuthProvider.SERVICE
+)
+def my_function(**kwargs):
+```