telethon-cli 0.1.0__tar.gz

telethon_cli-0.1.0/PKG-INFO

@@ -0,0 +1,199 @@
+Metadata-Version: 2.4
+Name: telethon-cli
+Version: 0.1.0
+Summary: Command-line interface for Telethon and Telethon internals
+Author: Axisrow
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/axisrow/telethon-cli
+Project-URL: Repository, https://github.com/axisrow/telethon-cli
+Project-URL: Issues, https://github.com/axisrow/telethon-cli/issues
+Keywords: telegram,telethon,cli,api,automation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Communications :: Chat
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: Telethon>=1
+
+# telethon-cli
+
+`telethon-cli` is a separate installable package that exposes:
+
+- a stable command tree for the public `TelegramClient` API;
+- a generic dispatcher for internal `telethon` and `telethon_generator` callables;
+- env-first client configuration through `TELETHON_API_ID` and `TELETHON_API_HASH`,
+  with optional session overrides.
+
+## Installation
+
+Install from PyPI:
+
+```bash
+python -m pip install telethon-cli
+```
+
+For local development, install the package in editable mode:
+
+```bash
+python -m pip install -e .
+```
+
+Set the required Telethon credentials before running commands. You can export
+them directly in the shell:
+
+```bash
+export TELETHON_API_ID=...
+export TELETHON_API_HASH=...
+```
+
+You can also keep them in a `.env` file in the current working directory or at
+the project root:
+
+```dotenv
+TELETHON_API_ID=...
+TELETHON_API_HASH=...
+```
+
+On first login, `telethon-cli` can create and store a Telethon session in the
+project automatically. You can create it explicitly:
+
+```bash
+telethon-cli login
+```
+
+Typical first-run flow:
+
+```bash
+python -m pip install -e .
+telethon-cli login
+telethon-cli users get-me --output json
+```
+
+To remove the saved session and force a fresh login next time:
+
+```bash
+telethon-cli logout
+```
+
+Or just run the first command in an interactive terminal and let the CLI ask for
+your phone number, login code, and Telegram 2FA password when needed:
+
+```bash
+telethon-cli users get-me --output json
+```
+
+By default the session is stored in `.telethon-cli/session` under the project
+root. You can override it explicitly:
+
+```bash
+telethon-cli users get-me --session /path/to/session --output json
+telethon-cli users get-me --env-file /path/to/telethon.env --output json
+```
+
+`telethon-cli` reads the current process environment and also loads `.env`
+automatically when present. If the same Telethon setting is defined both in the
+environment and in `.env`, and the values differ, the command exits with an
+error instead of silently choosing one. CLI flags such as `--api-id`,
+`--api-hash`, `--session`, and `--2fa-password` still override both.
+
+In non-interactive environments, automatic login is not possible. In that case,
+create the session in advance with `telethon-cli login` and reuse it later.
+
+Smoke-test the installation:
+
+```bash
+telethon-cli --help
+python -m telethon_cli registry public --output json
+telethon-cli users get-me --output json
+```
+
+Dangerous features are gated behind project-wide developer mode. Enable it once
+from settings and explicitly confirm the warning before using `call`,
+`registry project`, `$ref`, or `$call` payload helpers:
+
+```bash
+telethon-cli settings developer-mode --enable --accept-dangerous-features
+```
+
+Examples:
+
+```bash
+telethon-cli users get-me --output json
+telethon-cli messages send-message --entity me --message "hello"
+telethon-cli call telethon.utils.parse_phone --args-json '["+1 234 567"]'
+telethon-cli call telethon.tl.functions.help.GetConfigRequest --client-invoke --output json
+telethon-cli settings show --output json
+```
+
+## Release Process
+
+Build and validate release artifacts locally before uploading:
+
+```bash
+rm -rf dist build src/*.egg-info
+python -m pip install --upgrade build twine
+python -m build
+python -m twine check dist/*
+```
+
+Optional local smoke-test from the built wheel:
+
+```bash
+python -m pip install --force-reinstall dist/*.whl
+telethon-cli --help
+python -m telethon_cli registry public --output json
+```
+
+Upload to TestPyPI first:
+
+```bash
+python -m twine upload --repository testpypi dist/*
+```
+
+Verify installation from TestPyPI:
+
+```bash
+python -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple telethon-cli
+telethon-cli --help
+python -m telethon_cli registry public --output json
+```
+
+Then upload the same artifacts to PyPI:
+
+```bash
+python -m twine upload dist/*
+```
+
+When `twine` prompts for credentials, use username `__token__` and your
+`pypi-...` API token as the password. Keep PyPI tokens out of the repository
+and provide them through the environment or `twine` prompt.
+
+For every subsequent release, bump `version` in `pyproject.toml` before
+building. PyPI rejects uploads for versions that already exist.
+
+You can also keep PyPI credentials in the project-local `.env` file, because
+`.env` is gitignored in this repository. The release helper script reads `.env`
+automatically and publishes with `twine`:
+
+```dotenv
+TWINE_USERNAME=__token__
+TEST_PYPI_TOKEN=pypi-...
+PYPI_TOKEN=pypi-...
+```
+
+```bash
+chmod +x scripts/release_pypi.sh
+./scripts/release_pypi.sh testpypi
+./scripts/release_pypi.sh pypi
+./scripts/release_pypi.sh all
+```

telethon_cli-0.1.0/README.md

@@ -0,0 +1,172 @@
+# telethon-cli
+
+`telethon-cli` is a separate installable package that exposes:
+
+- a stable command tree for the public `TelegramClient` API;
+- a generic dispatcher for internal `telethon` and `telethon_generator` callables;
+- env-first client configuration through `TELETHON_API_ID` and `TELETHON_API_HASH`,
+  with optional session overrides.
+
+## Installation
+
+Install from PyPI:
+
+```bash
+python -m pip install telethon-cli
+```
+
+For local development, install the package in editable mode:
+
+```bash
+python -m pip install -e .
+```
+
+Set the required Telethon credentials before running commands. You can export
+them directly in the shell:
+
+```bash
+export TELETHON_API_ID=...
+export TELETHON_API_HASH=...
+```
+
+You can also keep them in a `.env` file in the current working directory or at
+the project root:
+
+```dotenv
+TELETHON_API_ID=...
+TELETHON_API_HASH=...
+```
+
+On first login, `telethon-cli` can create and store a Telethon session in the
+project automatically. You can create it explicitly:
+
+```bash
+telethon-cli login
+```
+
+Typical first-run flow:
+
+```bash
+python -m pip install -e .
+telethon-cli login
+telethon-cli users get-me --output json
+```
+
+To remove the saved session and force a fresh login next time:
+
+```bash
+telethon-cli logout
+```
+
+Or just run the first command in an interactive terminal and let the CLI ask for
+your phone number, login code, and Telegram 2FA password when needed:
+
+```bash
+telethon-cli users get-me --output json
+```
+
+By default the session is stored in `.telethon-cli/session` under the project
+root. You can override it explicitly:
+
+```bash
+telethon-cli users get-me --session /path/to/session --output json
+telethon-cli users get-me --env-file /path/to/telethon.env --output json
+```
+
+`telethon-cli` reads the current process environment and also loads `.env`
+automatically when present. If the same Telethon setting is defined both in the
+environment and in `.env`, and the values differ, the command exits with an
+error instead of silently choosing one. CLI flags such as `--api-id`,
+`--api-hash`, `--session`, and `--2fa-password` still override both.
+
+In non-interactive environments, automatic login is not possible. In that case,
+create the session in advance with `telethon-cli login` and reuse it later.
+
+Smoke-test the installation:
+
+```bash
+telethon-cli --help
+python -m telethon_cli registry public --output json
+telethon-cli users get-me --output json
+```
+
+Dangerous features are gated behind project-wide developer mode. Enable it once
+from settings and explicitly confirm the warning before using `call`,
+`registry project`, `$ref`, or `$call` payload helpers:
+
+```bash
+telethon-cli settings developer-mode --enable --accept-dangerous-features
+```
+
+Examples:
+
+```bash
+telethon-cli users get-me --output json
+telethon-cli messages send-message --entity me --message "hello"
+telethon-cli call telethon.utils.parse_phone --args-json '["+1 234 567"]'
+telethon-cli call telethon.tl.functions.help.GetConfigRequest --client-invoke --output json
+telethon-cli settings show --output json
+```
+
+## Release Process
+
+Build and validate release artifacts locally before uploading:
+
+```bash
+rm -rf dist build src/*.egg-info
+python -m pip install --upgrade build twine
+python -m build
+python -m twine check dist/*
+```
+
+Optional local smoke-test from the built wheel:
+
+```bash
+python -m pip install --force-reinstall dist/*.whl
+telethon-cli --help
+python -m telethon_cli registry public --output json
+```
+
+Upload to TestPyPI first:
+
+```bash
+python -m twine upload --repository testpypi dist/*
+```
+
+Verify installation from TestPyPI:
+
+```bash
+python -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple telethon-cli
+telethon-cli --help
+python -m telethon_cli registry public --output json
+```
+
+Then upload the same artifacts to PyPI:
+
+```bash
+python -m twine upload dist/*
+```
+
+When `twine` prompts for credentials, use username `__token__` and your
+`pypi-...` API token as the password. Keep PyPI tokens out of the repository
+and provide them through the environment or `twine` prompt.
+
+For every subsequent release, bump `version` in `pyproject.toml` before
+building. PyPI rejects uploads for versions that already exist.
+
+You can also keep PyPI credentials in the project-local `.env` file, because
+`.env` is gitignored in this repository. The release helper script reads `.env`
+automatically and publishes with `twine`:
+
+```dotenv
+TWINE_USERNAME=__token__
+TEST_PYPI_TOKEN=pypi-...
+PYPI_TOKEN=pypi-...
+```
+
+```bash
+chmod +x scripts/release_pypi.sh
+./scripts/release_pypi.sh testpypi
+./scripts/release_pypi.sh pypi
+./scripts/release_pypi.sh all
+```

telethon_cli-0.1.0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "telethon-cli"
+version = "0.1.0"
+description = "Command-line interface for Telethon and Telethon internals"
+readme = "README.md"
+requires-python = ">=3.8"
+license = "MIT"
+authors = [
+    {name = "Axisrow"}
+]
+keywords = ["telegram", "telethon", "cli", "api", "automation"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Communications :: Chat",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "Telethon>=1"
+]
+
+[project.urls]
+Homepage = "https://github.com/axisrow/telethon-cli"
+Repository = "https://github.com/axisrow/telethon-cli"
+Issues = "https://github.com/axisrow/telethon-cli/issues"
+
+[project.scripts]
+telethon-cli = "telethon_cli.app:main"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]

telethon_cli-0.1.0/setup.cfg

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

telethon_cli-0.1.0/src/telethon_cli/__init__.py

@@ -0,0 +1,3 @@
+from .app import main
+
+__all__ = ["main"]

telethon_cli-0.1.0/src/telethon_cli/__main__.py

@@ -0,0 +1,5 @@
+from .app import main
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())