# takt
<img align="right" src="./assets/icon_cosette.png" height="220px">
***Power your discord calls with music 🎐***
<br>
<br>
[](https://pypi.org/project/takt/)
[](https://pepy.tech/project/takt)
[](https://pypistats.org/packages/takt)
[](https://pypi.org/project/takt/)
[](https://pypi.org/project/takt/)
[](https://github.com/Animenosekai/takt/blob/master/LICENSE)
[](https://github.com/Animenosekai/takt)
[](https://github.com/Animenosekai/takt/actions/workflows/codeql-analysis.yml)
## Index
- [Index](#index)
- [Purpose](#purpose)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installing](#installing)
- [Option 1: From PyPI](#option-1-from-pypi)
- [Option 2: From Git](#option-2-from-git)
- [FFmpeg](#ffmpeg)
- [Usage](#usage)
- [CLI](#cli)
- [Running](#running)
- [Prefix](#prefix)
- [More](#more)
- [Invite](#invite)
- [Discord](#discord)
- [Deployment](#deployment)
- [Contributing](#contributing)
- [Built With](#built-with)
- [Authors](#authors)
- [Licensing](#licensing)
## Purpose
`takt` is a simple, lightweight and privacy-focused music bot for your [Discord](http://discord.com) servers.
You are just a few seconds away from having your own private music discord bot !
## Getting Started
These instructions will get you a copy of the project up and running on your local machine.
### Prerequisites
You will need Python 3 to use this module
```bash
Minimum required versions: 3.8
```
Although the code itself is made compatible with Python >=3.6, the dependencies require at least Python 3.8.
Always check if your Python version works with `takt` before using it in production.
## Installing
### Option 1: From PyPI
```bash
pip install --upgrade takt
```
> This will install the latest version from PyPI
### Option 2: From Git
```bash
pip install --upgrade git+https://github.com/Animenosekai/takt.git
```
> This will install the latest development version from the git repository
You can check if you successfully installed it by printing out its version:
```bash
$ takt --version
1.0
```
### FFmpeg
You also need [`ffmpeg`](http://ffmpeg.org) installed on your computer to be able to run `takt` properly.
## Usage
### CLI
#### Running
Running takt is dead simple:
```bash
takt --token=<YOUR DISCORD TOKEN>
```
And this is even easier if you set the `TAKT_DISCORD_BOT_TOKEN` environment variable:
```bash
takt
```
> **Note**
> You could also try hosting your bot on Heroku directly by using this repository since it already has a [`Procfile`](https://github.com/Animenosekai/takt/blob/main/Procfile)
#### Prefix
You can set the bot's command prefix using the `--prefix` argument:
```bash
takt --prefix=">"
```
#### More
For more information, head over to your terminal and enter:
```bash
takt --help
```
### Invite
Here is the current invite URL for the public version:
> <https://discord.com/api/oauth2/authorize?client_id=923625007333113856&permissions=274881055744&scope=bot%20applications.commands>
You can create your own URL by replacing your Client ID:
```http
https://discord.com/api/oauth2/authorize?client_id=<YOUR_CLIENT_ID>&permissions=274881055744&scope=bot%20applications.commands
```
This Client ID can be found on your Discord Developer Portal, after selecting your bot, under the *OAuth2* section.
> **Warning**
> The live public version of the bot is almost always down and shouldn't be used for anything other than development
### Discord
Here is a list of commands you can use:
- `+play <search term>`: Searches on YouTube and plays the first result
- `+play <link>`: Play the given link
- `+playing`: Show the current song playing
- `+pause`: Pause the current song
- `+resume`: Resume the current song
- `+skip`: Skip the current song
- `+queue`: Show the current queue
- `+clear`: Clear the queue
- `+stop`: Stop the music and clear the queue
- `+loop`: Toggle looping
- `+loop <true/false>`: Enable or disable looping
- `+looping`: Show the current loop status
- `+latency`: Show the current latency
- `+connected`: Show if the bot is connected to a voice channel
- `+help`: Show this message
- `+help <command>`: Show specific command's help
> **Note**
> The `+` prefix is the default one and can be changed as explained in [*Prefix*](#prefix)
Head to your discord server and check `+help` or `+help <command>` for further details on the different commands (aliases, examples, etc.)
## Deployment
This module is currently in development and might contain bugs.
Feel free to report any issue you might encounter on takt's GitHub page.
## Contributing
Pull requests are welcome. For major changes, please open a discussion first to discuss what you would like to change.
## Built With
- [nasse](https://github.com/Animenosekai/nasse) - the logging system
- [discord.py](https://github.com/Rapptz/discord.py) - to use the discord API
- [discord-py-slash-command](https://github.com/interactions-py/interactions.py) - to create slash commands on discord
- [youtube-dl](https://github.com/ytdl-org/youtube-dl) - to retrieve sources to play in voice channels
- [youtube-dlp](https://github.com/yt-dlp/yt-dlp) - to retrieve sources to play in voice channels
- [ffmpeg](http://ffmpeg.org) - to process audio
## Authors
- **Animenosekai** - *Initial work* - [Animenosekai](https://github.com/Animenosekai)
## Licensing
This software is licensed under the MIT License. See the [*LICENSE*](./LICENSE) file for more information.
Raw data
{
"_id": null,
"home_page": "https://github.com/Animenosekai/takt",
"name": "takt",
"maintainer": "Animenosekai",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "animenosekai.mail@gmail.com",
"keywords": "animenosekai,takt,discord,bot,music,youtube",
"author": "Animenosekai",
"author_email": "animenosekai.mail@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c5/9a/459821fcb4bbbdfb83c06b5d2c66fbcf40d4a72803505281d5c3dbbf1281/takt-1.0.tar.gz",
"platform": null,
"description": "# takt\n\n<img align=\"right\" src=\"./assets/icon_cosette.png\" height=\"220px\">\n\n***Power your discord calls with music \ud83c\udf90***\n\n<br>\n<br>\n\n[](https://pypi.org/project/takt/)\n[](https://pepy.tech/project/takt)\n[](https://pypistats.org/packages/takt)\n[](https://pypi.org/project/takt/)\n[](https://pypi.org/project/takt/)\n[](https://github.com/Animenosekai/takt/blob/master/LICENSE)\n[](https://github.com/Animenosekai/takt)\n[](https://github.com/Animenosekai/takt/actions/workflows/codeql-analysis.yml)\n\n\n\n\n## Index\n\n- [Index](#index)\n- [Purpose](#purpose)\n- [Getting Started](#getting-started)\n - [Prerequisites](#prerequisites)\n- [Installing](#installing)\n - [Option 1: From PyPI](#option-1-from-pypi)\n - [Option 2: From Git](#option-2-from-git)\n - [FFmpeg](#ffmpeg)\n- [Usage](#usage)\n - [CLI](#cli)\n - [Running](#running)\n - [Prefix](#prefix)\n - [More](#more)\n - [Invite](#invite)\n - [Discord](#discord)\n- [Deployment](#deployment)\n- [Contributing](#contributing)\n- [Built With](#built-with)\n- [Authors](#authors)\n- [Licensing](#licensing)\n\n## Purpose\n\n`takt` is a simple, lightweight and privacy-focused music bot for your [Discord](http://discord.com) servers.\n\nYou are just a few seconds away from having your own private music discord bot !\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine.\n\n### Prerequisites\n\nYou will need Python 3 to use this module\n\n```bash\nMinimum required versions: 3.8\n```\n\nAlthough the code itself is made compatible with Python >=3.6, the dependencies require at least Python 3.8.\n\nAlways check if your Python version works with `takt` before using it in production.\n\n## Installing\n\n### Option 1: From PyPI\n\n```bash\npip install --upgrade takt\n```\n\n> This will install the latest version from PyPI\n\n### Option 2: From Git\n\n```bash\npip install --upgrade git+https://github.com/Animenosekai/takt.git\n```\n\n> This will install the latest development version from the git repository\n\nYou can check if you successfully installed it by printing out its version:\n\n```bash\n$ takt --version\n1.0\n```\n\n### FFmpeg\n\nYou also need [`ffmpeg`](http://ffmpeg.org) installed on your computer to be able to run `takt` properly.\n\n## Usage\n\n### CLI\n\n#### Running\n\nRunning takt is dead simple:\n\n```bash\ntakt --token=<YOUR DISCORD TOKEN>\n```\n\nAnd this is even easier if you set the `TAKT_DISCORD_BOT_TOKEN` environment variable:\n\n```bash\ntakt\n```\n\n> **Note** \n> You could also try hosting your bot on Heroku directly by using this repository since it already has a [`Procfile`](https://github.com/Animenosekai/takt/blob/main/Procfile)\n\n#### Prefix\n\nYou can set the bot's command prefix using the `--prefix` argument:\n\n```bash\ntakt --prefix=\">\"\n```\n\n#### More\n\nFor more information, head over to your terminal and enter:\n\n```bash\ntakt --help\n```\n\n### Invite\n\nHere is the current invite URL for the public version:\n\n> <https://discord.com/api/oauth2/authorize?client_id=923625007333113856&permissions=274881055744&scope=bot%20applications.commands>\n\nYou can create your own URL by replacing your Client ID:\n\n```http\nhttps://discord.com/api/oauth2/authorize?client_id=<YOUR_CLIENT_ID>&permissions=274881055744&scope=bot%20applications.commands\n```\n\nThis Client ID can be found on your Discord Developer Portal, after selecting your bot, under the *OAuth2* section.\n\n> **Warning** \n> The live public version of the bot is almost always down and shouldn't be used for anything other than development\n\n### Discord\n\nHere is a list of commands you can use:\n\n- `+play <search term>`: Searches on YouTube and plays the first result\n- `+play <link>`: Play the given link\n- `+playing`: Show the current song playing\n- `+pause`: Pause the current song\n- `+resume`: Resume the current song\n- `+skip`: Skip the current song\n- `+queue`: Show the current queue\n- `+clear`: Clear the queue\n- `+stop`: Stop the music and clear the queue\n- `+loop`: Toggle looping\n- `+loop <true/false>`: Enable or disable looping\n- `+looping`: Show the current loop status\n- `+latency`: Show the current latency\n- `+connected`: Show if the bot is connected to a voice channel\n- `+help`: Show this message\n- `+help <command>`: Show specific command's help\n\n> **Note** \n> The `+` prefix is the default one and can be changed as explained in [*Prefix*](#prefix)\n\nHead to your discord server and check `+help` or `+help <command>` for further details on the different commands (aliases, examples, etc.)\n\n## Deployment\n\nThis module is currently in development and might contain bugs.\n\nFeel free to report any issue you might encounter on takt's GitHub page.\n\n## Contributing\n\nPull requests are welcome. For major changes, please open a discussion first to discuss what you would like to change.\n\n## Built With\n\n- [nasse](https://github.com/Animenosekai/nasse) - the logging system\n- [discord.py](https://github.com/Rapptz/discord.py) - to use the discord API\n- [discord-py-slash-command](https://github.com/interactions-py/interactions.py) - to create slash commands on discord\n- [youtube-dl](https://github.com/ytdl-org/youtube-dl) - to retrieve sources to play in voice channels\n- [youtube-dlp](https://github.com/yt-dlp/yt-dlp) - to retrieve sources to play in voice channels\n- [ffmpeg](http://ffmpeg.org) - to process audio\n\n## Authors\n\n- **Animenosekai** - *Initial work* - [Animenosekai](https://github.com/Animenosekai)\n\n## Licensing\n\nThis software is licensed under the MIT License. See the [*LICENSE*](./LICENSE) file for more information.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Power your discord calls with music \ud83c\udf90",
"version": "1.0",
"project_urls": {
"Documentation": "https://github.com/Animenosekai/takt/blob/main/README.md",
"Homepage": "https://github.com/Animenosekai/takt",
"Issue Tracker": "https://github.com/Animenosekai/takt/issues",
"Repository": "https://github.com/Animenosekai/takt"
},
"split_keywords": [
"animenosekai",
"takt",
"discord",
"bot",
"music",
"youtube"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fbcd84d9a84261bd191c999910bb579765de913e93791954c772a0d4519f4249",
"md5": "6552ab56e11665758baeeec004f3e7ea",
"sha256": "d661f723f752d9174e774f2355713e1449a452017571434ae4f6905e3f9ee91f"
},
"downloads": -1,
"filename": "takt-1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6552ab56e11665758baeeec004f3e7ea",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 15071,
"upload_time": "2023-08-11T17:18:49",
"upload_time_iso_8601": "2023-08-11T17:18:49.082908Z",
"url": "https://files.pythonhosted.org/packages/fb/cd/84d9a84261bd191c999910bb579765de913e93791954c772a0d4519f4249/takt-1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c59a459821fcb4bbbdfb83c06b5d2c66fbcf40d4a72803505281d5c3dbbf1281",
"md5": "15cf875486fe64bba8f3bae2ed446563",
"sha256": "1b1464a333d7ddd7e09d8eeaaa4b18f69e30836c43fa43d51f38da66f27b1e30"
},
"downloads": -1,
"filename": "takt-1.0.tar.gz",
"has_sig": false,
"md5_digest": "15cf875486fe64bba8f3bae2ed446563",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 14660,
"upload_time": "2023-08-11T17:18:50",
"upload_time_iso_8601": "2023-08-11T17:18:50.826807Z",
"url": "https://files.pythonhosted.org/packages/c5/9a/459821fcb4bbbdfb83c06b5d2c66fbcf40d4a72803505281d5c3dbbf1281/takt-1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-11 17:18:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Animenosekai",
"github_project": "takt",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "takt"
}
JSON
