# discordwebhook
[](https://pypi.org/project/discordwebhook/)
[](https://opensource.org/licenses/MIT)
[](https://codecov.io/gh/10mohi6/discord-webhook-python)
[](https://travis-ci.com/10mohi6/discord-webhook-python)
[](https://pypi.org/project/discordwebhook/)
[](https://pepy.tech/project/discordwebhook)
discordwebhook is a python library for discord webhook with discord rest api on Python 3.6 and above.
## Installation
$ pip install discordwebhook
## Usage
### basic
```python
from discordwebhook import Discord
discord = Discord(url="<your webhook url>")
discord.post(content="Hello, world.")
```
### basic, username and avatar_url
```python
from discordwebhook import Discord
discord = Discord(url="<your webhook url>")
discord.post(
content="Hello, world.",
username="10mohi6",
avatar_url="https://avatars2.githubusercontent.com/u/38859131?s=460&v=4"
)
```
### basic embed
```python
from discordwebhook import Discord
discord = Discord(url="<your webhook url>")
discord.post(
embeds=[{"title": "Embed Title", "description": "Embed description"}],
)
```
### advanced embed
```python
from discordwebhook import Discord
discord = Discord(url="<your webhook url>")
discord.post(
embeds=[
{
"author": {
"name": "Embed Name",
"url": "https://github.com/10mohi6/discord-webhook-python",
"icon_url": "https://picsum.photos/24/24",
},
"title": "Embed Title",
"description": "Embed description",
"fields": [
{"name": "Field Name 1", "value": "Value 1", "inline": True},
{"name": "Field Name 2", "value": "Value 2", "inline": True},
{"name": "Field Name 3", "value": "Field Value 3"},
],
"thumbnail": {"url": "https://picsum.photos/80/60"},
"image": {"url": "https://picsum.photos/400/300"},
"footer": {
"text": "Embed Footer",
"icon_url": "https://picsum.photos/20/20",
},
}
],
)
```
### send file
```python
from discordwebhook import Discord
discord = Discord(url="<your webhook url>")
discord.post(
file={
"file1": open("tests/file1.jpg", "rb"),
"file2": open("tests/file2.jpg", "rb"),
},
)
```
## Getting started
For help getting started with discord webhook, view our online [documentation](https://discordapp.com/developers/docs/resources/webhook).
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
Raw data
{
"_id": null,
"home_page": "https://github.com/klemonade/discord-webhook-python",
"name": "discordwebhook-v2",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6.0",
"maintainer_email": null,
"keywords": "discord webhook api python",
"author": "klemonade",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/76/8b/db2ad10085e2963b1c63a210048366b66ac519575ea769f64cd235cdd550/discordwebhook_v2-1.0.0.tar.gz",
"platform": null,
"description": "# discordwebhook\n\n[](https://pypi.org/project/discordwebhook/)\n[](https://opensource.org/licenses/MIT)\n[](https://codecov.io/gh/10mohi6/discord-webhook-python)\n[](https://travis-ci.com/10mohi6/discord-webhook-python)\n[](https://pypi.org/project/discordwebhook/)\n[](https://pepy.tech/project/discordwebhook)\n\ndiscordwebhook is a python library for discord webhook with discord rest api on Python 3.6 and above.\n\n\n## Installation\n\n $ pip install discordwebhook\n\n## Usage\n\n### basic\n```python\nfrom discordwebhook import Discord\n\ndiscord = Discord(url=\"<your webhook url>\")\ndiscord.post(content=\"Hello, world.\")\n```\n\n\n### basic, username and avatar_url\n```python\nfrom discordwebhook import Discord\n\ndiscord = Discord(url=\"<your webhook url>\")\ndiscord.post(\n content=\"Hello, world.\",\n username=\"10mohi6\",\n avatar_url=\"https://avatars2.githubusercontent.com/u/38859131?s=460&v=4\"\n)\n```\n\n\n### basic embed\n```python\nfrom discordwebhook import Discord\n\ndiscord = Discord(url=\"<your webhook url>\")\ndiscord.post(\n embeds=[{\"title\": \"Embed Title\", \"description\": \"Embed description\"}],\n)\n```\n\n\n### advanced embed\n```python\nfrom discordwebhook import Discord\n\ndiscord = Discord(url=\"<your webhook url>\")\ndiscord.post(\n embeds=[\n {\n \"author\": {\n \"name\": \"Embed Name\",\n \"url\": \"https://github.com/10mohi6/discord-webhook-python\",\n \"icon_url\": \"https://picsum.photos/24/24\",\n },\n \"title\": \"Embed Title\",\n \"description\": \"Embed description\",\n \"fields\": [\n {\"name\": \"Field Name 1\", \"value\": \"Value 1\", \"inline\": True},\n {\"name\": \"Field Name 2\", \"value\": \"Value 2\", \"inline\": True},\n {\"name\": \"Field Name 3\", \"value\": \"Field Value 3\"},\n ],\n \"thumbnail\": {\"url\": \"https://picsum.photos/80/60\"},\n \"image\": {\"url\": \"https://picsum.photos/400/300\"},\n \"footer\": {\n \"text\": \"Embed Footer\",\n \"icon_url\": \"https://picsum.photos/20/20\",\n },\n }\n ],\n)\n```\n\n\n### send file\n```python\nfrom discordwebhook import Discord\n\ndiscord = Discord(url=\"<your webhook url>\")\ndiscord.post(\n file={\n \"file1\": open(\"tests/file1.jpg\", \"rb\"),\n \"file2\": open(\"tests/file2.jpg\", \"rb\"),\n },\n)\n```\n\n\n\n## Getting started\n\nFor help getting started with discord webhook, view our online [documentation](https://discordapp.com/developers/docs/resources/webhook).\n\n\n## Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "discordwebhook is a python library for discord webhook with discord rest api on Python 3.6 and above.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/klemonade/discord-webhook-python"
},
"split_keywords": [
"discord",
"webhook",
"api",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "768bdb2ad10085e2963b1c63a210048366b66ac519575ea769f64cd235cdd550",
"md5": "5e307f6af1630ddd91fa4f66eee3ce48",
"sha256": "bcf9c2e7087c04e826efa252ddc1de79cb3f77c87fee5745f94f61709b93bcbe"
},
"downloads": -1,
"filename": "discordwebhook_v2-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "5e307f6af1630ddd91fa4f66eee3ce48",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6.0",
"size": 4326,
"upload_time": "2024-10-03T17:26:43",
"upload_time_iso_8601": "2024-10-03T17:26:43.169831Z",
"url": "https://files.pythonhosted.org/packages/76/8b/db2ad10085e2963b1c63a210048366b66ac519575ea769f64cd235cdd550/discordwebhook_v2-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-03 17:26:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "klemonade",
"github_project": "discord-webhook-python",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "discordwebhook-v2"
}
JSON
