bisim.py 0.1.0__tar.gz

bisim_py-0.1.0/.gitignore

@@ -0,0 +1,28 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Documentation
+site/
+
+# Environments
+.venv/
+venv/
+.env
+.env.*
+
+# Editors
+.vscode/
+.idea/
+*.swp
+.DS_Store
+Thumbs.db

bisim_py-0.1.0/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+All notable changes to bisim.py are listed here.
+
+## 0.1.0 (unreleased)
+
+The first version: the discord.py 2.x API on Bisim's REST API and gateway.
+
+- `Client` with `run`, `start`, `login`, `connect`, `close`, events, `wait_for`,
+  `change_presence` and the caches (`guilds`, `users`, `get_*`, `fetch_*`).
+- The gateway: passes, heartbeats and `latency`, reconnecting with backoff, and
+  loading the servers over REST before `on_ready` (Bisim has no READY event).
+- Every Bisim event as its discord.py event: messages, edits, deletions,
+  reactions, members, roles, channels, presences, typing, voice states and more.
+- Models with discord.py's names: `Guild`, `Member`, `User`, `Role`, `TextChannel`,
+  `VoiceChannel`, `CategoryChannel`, `DMChannel`, `Message`, `Embed`, `File`,
+  `Emoji`, `Invite`, `Webhook`, `Permissions`, `Colour` and the enums.
+- File uploads through Bisim's presigned upload addresses.
+- The REST client with per-route rate limits, the global limit and retries.
+- Interactions and `app_commands`: slash commands, groups, context menus,
+  autocomplete, choices, transformers, checks, and syncing to Bisim.
+- `ui`: views with buttons and select menus, persistent views, and modals.
+- `bisim.ext.commands` and `bisim.ext.tasks`.
+- `bisim.http_interactions` for bots that receive interactions on an Interactions URL.
+- The documentation site: the guide in English and Persian and the API reference,
+  on GitHub Pages and docs.bisim.gg/py.

bisim_py-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+Copyright (c) 2026-present Bisim
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

bisim_py-0.1.0/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.5
+Name: bisim.py
+Version: 0.1.0
+Summary: The official Python library for building Bisim bots, with the discord.py 2.x API.
+Project-URL: Homepage, https://github.com/bisim-gg/bisim.py
+Project-URL: Documentation, https://bisim-gg.github.io/bisim.py/
+Project-URL: Documentation mirror, https://docs.bisim.gg/py/
+Project-URL: Changelog, https://github.com/bisim-gg/bisim.py/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/bisim-gg/bisim.py/issues
+Author: Bisim, Rapptz (discord.py)
+License: MIT
+License-File: LICENSE
+Keywords: api,bisim,bot,chat,discord.py
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Programming Language :: Python :: 3.13
+Classifier: Topic :: Communications :: Chat
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: aiohttp<4,>=3.8
+Provides-Extra: docs
+Requires-Dist: griffelib<3,>=2.3; extra == 'docs'
+Requires-Dist: mkdocs-material<9.8,>=9.7; extra == 'docs'
+Requires-Dist: mkdocs-static-i18n<2,>=1.3.1; extra == 'docs'
+Requires-Dist: mkdocs<2,>=1.6.1; extra == 'docs'
+Requires-Dist: mkdocstrings-python<3,>=2.0.9; extra == 'docs'
+Requires-Dist: mkdocstrings<2,>=1.0.6; extra == 'docs'
+Requires-Dist: pymdown-extensions<12,>=10.16; extra == 'docs'
+Requires-Dist: ruff>=0.6; extra == 'docs'
+Provides-Extra: http
+Requires-Dist: pynacl>=1.5; extra == 'http'
+Provides-Extra: speed
+Requires-Dist: orjson>=3.5; extra == 'speed'
+Provides-Extra: test
+Requires-Dist: aiohttp<3.14; extra == 'test'
+Requires-Dist: aioresponses>=0.7.6; extra == 'test'
+Requires-Dist: pynacl>=1.5; extra == 'test'
+Requires-Dist: pytest-asyncio<1,>=0.23; extra == 'test'
+Requires-Dist: pytest<9,>=7.4; extra == 'test'
+Description-Content-Type: text/markdown
+
+# bisim.py
+
+[![PyPI](https://img.shields.io/pypi/v/bisim.py.svg)](https://pypi.org/project/bisim.py/)
+[![CI](https://github.com/bisim-gg/bisim.py/actions/workflows/ci.yml/badge.svg)](https://github.com/bisim-gg/bisim.py/actions/workflows/ci.yml)
+
+The official Python library for [Bisim](https://bisim.gg) bots.
+
+It has the discord.py 2.x API: a bot written for discord.py runs on Bisim by
+changing `import discord` to `import bisim` (and `from discord.ext import commands`
+to `from bisim.ext import commands`). Events, models, slash commands, buttons,
+select menus, modals and `ext.commands` work the way you know them.
+
+Python 3.9 or newer, asyncio with aiohttp.
+
+## Install
+
+```sh
+pip install bisim.py
+```
+
+Signed interactions on an Interactions URL need PyNaCl:
+
+```sh
+pip install "bisim.py[http]"
+```
+
+## A bot in 20 lines
+
+```python
+import bisim
+from bisim import app_commands
+
+intents = bisim.Intents.default()  # accepted for compatibility; Bisim has no intents
+client = bisim.Client(intents=intents)
+tree = app_commands.CommandTree(client)
+
+
+@tree.command(description='Check that the bot is alive')
+async def ping(interaction: bisim.Interaction):
+    await interaction.response.send_message(f'Pong! {round(client.latency * 1000)} ms')
+
+
+@client.event
+async def on_ready():
+    await tree.sync()
+    print(f'Logged in as {client.user} ({client.user.id})')
+
+
+@client.event
+async def on_message(message: bisim.Message):
+    if message.content == '!hello' and not message.author.bot:
+        await message.reply(f'Hello, {message.author.display_name}!')
+
+
+client.run('your bot token')
+```
+
+Create an application and copy its token in Bisim: Settings, Applications.
+More examples are in [`examples/`](examples/): slash commands and context menus,
+buttons with a select menu and a modal, and a prefix command bot with a cog and a
+background task.
+
+## Documentation
+
+- **Guide:** [English](https://bisim-gg.github.io/bisim.py/guide/) and
+  [فارسی](https://bisim-gg.github.io/bisim.py/fa/guide/), from your first bot to slash
+  commands, buttons, modals, prefix commands, cogs and background tasks.
+- **API reference:** [every class, function and event](https://bisim-gg.github.io/bisim.py/reference/),
+  generated from the docstrings.
+- **Moving from discord.py:** [what changes and what Bisim does not have](https://bisim-gg.github.io/bisim.py/guide/moving-from-discord-py/).
+- **Bisim developer docs:** [docs.bisim.gg](https://docs.bisim.gg), for webhooks, bots
+  and the HTTP API underneath this library.
+
+The same site is also served at [docs.bisim.gg/py](https://docs.bisim.gg/py/).
+
+## Moving from discord.py
+
+- Change the imports. A word "Discord" in a name becomes "Bisim":
+  `discord.DiscordException` is `bisim.BisimException`, `discord.utils` is `bisim.utils`.
+- Intents are accepted and change nothing: a bot sees what its permissions let it see.
+- What Bisim does not have (voice connections, threads, stage and forum channels,
+  scheduled events, sharding) raises `bisim.NotSupported`, a `ClientException`.
+- A local Bisim server: `bisim.Client(api_url='http://localhost:3000/api',
+  gateway_url='ws://localhost:4000/ws')`, or the `BISIM_API_URL` and
+  `BISIM_GATEWAY_URL` environment variables.
+
+The [full page](https://bisim-gg.github.io/bisim.py/guide/moving-from-discord-py/) covers
+startup, embeds, files, interactions and everything that raises `NotSupported`.
+
+## Contributing
+
+Issues and pull requests are welcome. Read [CONTRIBUTING.md](CONTRIBUTING.md) first,
+and follow the [code of conduct](CODE_OF_CONDUCT.md). Report security problems
+privately as described in [SECURITY.md](SECURITY.md).
+
+```sh
+python -m venv .venv
+.venv/bin/pip install -e ".[test]"     # Windows: .venv\Scripts\pip
+.venv/bin/pytest
+```
+
+The tests never touch a real server: REST calls are answered from recorded
+payloads and the gateway is a small fake served on localhost.
+
+The documentation needs Python 3.10 or newer:
+
+```sh
+.venv/bin/pip install -e ".[docs]"
+.venv/bin/mkdocs build --strict        # the guide and the API reference in site/
+```
+
+## Credits
+
+bisim.py is built on [discord.py](https://github.com/Rapptz/discord.py) by Rapptz
+and its contributors. Much of its code and documentation comes from discord.py,
+adapted to Bisim's API, which is what lets a discord.py bot move over unchanged.
+Thank you to everyone who made discord.py.
+
+## License
+
+MIT, see [LICENSE](LICENSE). It carries discord.py's copyright notice next to
+Bisim's, as discord.py's license asks.

bisim_py-0.1.0/README.md

@@ -0,0 +1,122 @@
+# bisim.py
+
+[![PyPI](https://img.shields.io/pypi/v/bisim.py.svg)](https://pypi.org/project/bisim.py/)
+[![CI](https://github.com/bisim-gg/bisim.py/actions/workflows/ci.yml/badge.svg)](https://github.com/bisim-gg/bisim.py/actions/workflows/ci.yml)
+
+The official Python library for [Bisim](https://bisim.gg) bots.
+
+It has the discord.py 2.x API: a bot written for discord.py runs on Bisim by
+changing `import discord` to `import bisim` (and `from discord.ext import commands`
+to `from bisim.ext import commands`). Events, models, slash commands, buttons,
+select menus, modals and `ext.commands` work the way you know them.
+
+Python 3.9 or newer, asyncio with aiohttp.
+
+## Install
+
+```sh
+pip install bisim.py
+```
+
+Signed interactions on an Interactions URL need PyNaCl:
+
+```sh
+pip install "bisim.py[http]"
+```
+
+## A bot in 20 lines
+
+```python
+import bisim
+from bisim import app_commands
+
+intents = bisim.Intents.default()  # accepted for compatibility; Bisim has no intents
+client = bisim.Client(intents=intents)
+tree = app_commands.CommandTree(client)
+
+
+@tree.command(description='Check that the bot is alive')
+async def ping(interaction: bisim.Interaction):
+    await interaction.response.send_message(f'Pong! {round(client.latency * 1000)} ms')
+
+
+@client.event
+async def on_ready():
+    await tree.sync()
+    print(f'Logged in as {client.user} ({client.user.id})')
+
+
+@client.event
+async def on_message(message: bisim.Message):
+    if message.content == '!hello' and not message.author.bot:
+        await message.reply(f'Hello, {message.author.display_name}!')
+
+
+client.run('your bot token')
+```
+
+Create an application and copy its token in Bisim: Settings, Applications.
+More examples are in [`examples/`](examples/): slash commands and context menus,
+buttons with a select menu and a modal, and a prefix command bot with a cog and a
+background task.
+
+## Documentation
+
+- **Guide:** [English](https://bisim-gg.github.io/bisim.py/guide/) and
+  [فارسی](https://bisim-gg.github.io/bisim.py/fa/guide/), from your first bot to slash
+  commands, buttons, modals, prefix commands, cogs and background tasks.
+- **API reference:** [every class, function and event](https://bisim-gg.github.io/bisim.py/reference/),
+  generated from the docstrings.
+- **Moving from discord.py:** [what changes and what Bisim does not have](https://bisim-gg.github.io/bisim.py/guide/moving-from-discord-py/).
+- **Bisim developer docs:** [docs.bisim.gg](https://docs.bisim.gg), for webhooks, bots
+  and the HTTP API underneath this library.
+
+The same site is also served at [docs.bisim.gg/py](https://docs.bisim.gg/py/).
+
+## Moving from discord.py
+
+- Change the imports. A word "Discord" in a name becomes "Bisim":
+  `discord.DiscordException` is `bisim.BisimException`, `discord.utils` is `bisim.utils`.
+- Intents are accepted and change nothing: a bot sees what its permissions let it see.
+- What Bisim does not have (voice connections, threads, stage and forum channels,
+  scheduled events, sharding) raises `bisim.NotSupported`, a `ClientException`.
+- A local Bisim server: `bisim.Client(api_url='http://localhost:3000/api',
+  gateway_url='ws://localhost:4000/ws')`, or the `BISIM_API_URL` and
+  `BISIM_GATEWAY_URL` environment variables.
+
+The [full page](https://bisim-gg.github.io/bisim.py/guide/moving-from-discord-py/) covers
+startup, embeds, files, interactions and everything that raises `NotSupported`.
+
+## Contributing
+
+Issues and pull requests are welcome. Read [CONTRIBUTING.md](CONTRIBUTING.md) first,
+and follow the [code of conduct](CODE_OF_CONDUCT.md). Report security problems
+privately as described in [SECURITY.md](SECURITY.md).
+
+```sh
+python -m venv .venv
+.venv/bin/pip install -e ".[test]"     # Windows: .venv\Scripts\pip
+.venv/bin/pytest
+```
+
+The tests never touch a real server: REST calls are answered from recorded
+payloads and the gateway is a small fake served on localhost.
+
+The documentation needs Python 3.10 or newer:
+
+```sh
+.venv/bin/pip install -e ".[docs]"
+.venv/bin/mkdocs build --strict        # the guide and the API reference in site/
+```
+
+## Credits
+
+bisim.py is built on [discord.py](https://github.com/Rapptz/discord.py) by Rapptz
+and its contributors. Much of its code and documentation comes from discord.py,
+adapted to Bisim's API, which is what lets a discord.py bot move over unchanged.
+Thank you to everyone who made discord.py.
+
+## License
+
+MIT, see [LICENSE](LICENSE). It carries discord.py's copyright notice next to
+Bisim's, as discord.py's license asks.

bisim_py-0.1.0/bisim/__init__.py

@@ -0,0 +1,72 @@
+"""
+Bisim API Wrapper
+~~~~~~~~~~~~~~~~~
+
+The official library for building Bisim (bisim.gg) bots, with the discord.py
+2.x API: a bot written for discord.py runs by changing ``import discord`` to
+``import bisim``.
+
+:copyright: (c) 2026 Bisim
+:license: MIT, see LICENSE for more details.
+"""
+
+__title__ = 'bisim'
+__author__ = 'Bisim'
+__license__ = 'MIT'
+__copyright__ = 'Copyright 2026 Bisim'
+__version__ = '0.1.0'
+
+__path__ = __import__('pkgutil').extend_path(__path__, __name__)
+
+import logging
+from typing import Literal, NamedTuple
+
+from . import abc as abc
+from . import app_commands as app_commands
+from . import ui as ui
+from . import utils as utils
+from .activity import *
+from .appinfo import *
+from .asset import *
+from .audit_logs import *
+from .channel import *
+from .client import *
+from .colour import *
+from .components import *
+from .embeds import *
+from .emoji import *
+from .enums import *
+from .errors import *
+from .file import *
+from .flags import *
+from .guild import *
+from .interactions import *
+from .invite import *
+from .member import *
+from .mentions import *
+from .message import *
+from .object import *
+from .partial_emoji import *
+from .permissions import *
+from .poll import *
+from .raw_models import *
+from .reaction import *
+from .role import *
+from .sticker import *
+from .user import *
+from .webhook import *
+
+
+class VersionInfo(NamedTuple):
+    major: int
+    minor: int
+    micro: int
+    releaselevel: Literal['alpha', 'beta', 'candidate', 'final']
+    serial: int
+
+
+version_info: VersionInfo = VersionInfo(major=0, minor=1, micro=0, releaselevel='final', serial=0)
+
+logging.getLogger(__name__).addHandler(logging.NullHandler())
+
+del logging, NamedTuple, Literal