pip is a software package management system written in the Python computer programming language. It can install and manage software packages, with a simple command “pip”, you can get access to more then one hundred thousand of cool libraries, here I am going to show you how to upload your own code to PyPi and able to download with pip.

There are few step for you to develop your own package.

1. Prepare your code.
2. Create a PyPi account.
3. Prepare the files PyPi needs.
4. upload it to PyPi
5. pip install your package.
6. Upload it to github

Code

In here, I want to upload the class I wrote for research in the institute, If you are interested, It is a code for calculate the limit of TASEH(Taiwan Axion Search Experiment Haloscope).

https://github.com/OuYangMinOa/ou_Axion_limit

This code have two class in two different File

• class Glimit in GLimit.py
• class analyse in Analy.py

PyPi account

Create a PyPi account for us to upload our package,

https://pypi.org/account/register/

Prepare the files PyPi needs.

Now, I wish my classes are all in a same package call ou_Axion_limit

# my expectation
from ou_Axion_limit import Glimit
from ou_Axion_limit import analyse 

so first create a folder (Glimit), this folder will content every thing PyPi needs, and next create a floder name with your package name (ou_Axion_limit ), inside the folder you just created, and throw you python code inside.

__init__.py

Creata a file __init__.py inside the ou_Axion_limit

This file allows you to determine the classes that users can directly call and use, so in my cases, I can just import my class with following way.

# my expectation
from ou_Axion_limit import Glimit
from ou_Axion_limit import analyse

setup.py

The setup.py file contains the information that PyPi needed , such as its name, description, current version, etc. Copy and paste the following code and replace the string with the matching content:

CHANGELOG.txt

The changelog of you package

LICENSE.txt

Use this file to define all license details, you can use your own license, however, I will use MIT license

MANIFEST.in

Just a file use to include everything

README.md

A markdown file can make people understand your package better.

Upload it to PyPi

Everything is prepared, we can now upload it to PyPi.

First, goto you folder open cmd and tpye:

python setup.py sdist

If you see UserWarning: Unknown distribution option: ‘install_requires’, just ignore it.

It should create a file in dist folder

Next, we need twine for upload the package

pip install twine

Then, run the following command:

twine upload dist/{Generated_file}

You will be asked to provide your username and password. Provide your credentials you used to register with PyPi.

Congratulations, you successfully upload your packge to the PyPi, goto the website it gives you to see your package online.

Install your package

pip install YOURPACKAGENAME

Upload to github

For the fist time using git, we need to create a ssh-key to connect to github

ssh-keygen

It did exist.

Show the content

type filename

Copy everything and add in to your account.

https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account

Create your repository

Then upload your project.

git init
git add .
git commit -n "first upload"
git remote add origin git@github:{name/project}
git push -u origin master

If you want to upload new code later, you only need to type the following commands.

git add .
git commit -m "v1.0.0"
git push

https://www.theverge.com/2021/8/24/22640024/youtube-discord-groovy-music-bot-closure

https://www.theverge.com/2021/9/12/22669502/youtube-discord-rythm-music-bot-closure

Recently, youtube kill’s some of the most used music robots on discord, and other public ones may also be asked to be shut down, so today let us make our discord bot!!!

Step 1 : Create your bot

Goto this website https://discord.com/developers/applications, I have already created one, click the “New Application” button.

And name your bot.

If you create the bot successfully, you should see it appear on your main page, just click it.

Go and copy your APPLICATION ID, and fill in this link:

https://discordapp.com/oauth2/authorize?&client_id=xxxxxxxxxxxxx&scope=bot&permissions=8 # replace xxxxx with you Id

with this link, you can invite it to your channel.

Step 2 : authorization token

Go to the “bot” and click “copy”, this will give you your Token

Step 3 : Start coding

Here, I’m will build the bot with python in windows, so you will need python on your computer

open cmd and download discord’s API

pip install discord.py

Open sublime and paste the following code to start a simple bot

save and open with cmd.

we know this is not enough…, we need a music bot, not a ping-pong idiot…, next, I will speed up and point out the difficulties and solutions I encountered.

Step 4 : A music bot

A normal music bot should be able to play youtube music and have the following functions.

• play : Add a song or a playlist to the Queqe and invite the bot to the voice channel
• pause : pause
• skip : skip current song
• list : show the playlist
• clear : clear the playlist
• loop : loop the playlist
• leave : leave the voice channel

we define severals function that we want our music bot have.

Step 5 : Play a music

Let’s see how others play music

with this code we can understand how everything works, first, we need FFmpeg.

https://www.ffmpeg.org/download.html

when a user types a play command, the code will get its message channel (ctx), and get the Author’s voice channel (channel), then with “channel.connect()” to connect the bot to the voice channel.

channel = ctx.message.author.voice.channel #this line will get the user's voice channel
voice =  await channel.connect()   # connect to the user's voice channel

voice.play(discord.FFmpegPCMAudio(song_path), after = lambda e: somefuciton())
# play the music ,  'after' will run when the song is finish.

Step 6 : Create a class

you may ask: why do we need a class?

If our robot is to serve different servers, it means that there will be different ctx, channel, and voice, we also need to queue the songs of each channel, so the best choice is to create a class, each class serves a server.

class MusicBot:
    def __init__(self,channel, voice , ctx):
        self.music_msg = None       # The message for current music
        self.loop      = False      # Enable loop or not
        self.live      = True       # Kill this Musicbot if self.live = False
        self.channel   = channel    # Voice channel
        self.channelid = channel.id # This Music serves channel Id
        self.floder    = "music"    # Folder to store music
        self.ctx       = ctx        # ctx
        self.voice     = voice      # voice client
        self.queqed    = []         # music queqed for play
        self.passed    = []         # Played music
        self.state     = 0          # 0:not playing , 1:playing , 2:pause
        self.rejoin_c  = 0          # rejoin every 20 songs
        self.dont_stop = 0          # will play untill dont_stop = 3 to check again

so I define a class that needs channel, voice, and ctx as input.

Step 7 : Download youtube music

we know we can use youtube_dl to download the music.

pip install youtube-dl

self.ytl  = {
                'format': '249/250/251',
                "outtmpl" : f"{self.floder}/{this_song_name}",
                'noplaylist': False
} 
with youtube_dl.YoutubeDL(self.ytl) as ydl:
    ydl.download([this_song_url])

But I think it is difficult to manage which songs the user has queued and youtube_dl will download the entire playlist before I play the music, of course, I can use a thread, But it is too complex.

So, I will use a youtube data API to grab the playlist’s songs and download one at a time and play it. the following is the youtube API code, however, I will not explain this code since our main character is a discord music bot.

with this API, I can write a function to add music to the queue

def add_thread(self,url):
        print("[*] Adding rest in this thread ... ")
        output = grab_playlist(url,50)
        for each in output[10:50]:
            self.queqed.append(each)
        print("[*] Adding Thread done.")
        print(f"[*] Qeuqed {len(self.queqed)} songs ->",self.channelid)

async def add(self,url):
        print("[*]", url)
        if ("list" in url):
            print("[*] Adding a play list in", self.channelid)
            output = grab_playlist(url,10)
            for each in output[0:10]:
                self.queqed.append(each)
            threading.Thread(target = self.add_thread, args=(url,)).start()

        else:
            print("[*] Adding a single video in", self.channelid)
            self.queqed.append((get_title(url),url))

        print("\n[*]",self.channelid,"-> Enqueued :",len(self.queqed), "the remaining songs will continue add in the background")

        if (self.state ==0):
            self._next()  #  the play music function

add function can handle a video or a playlist, if it is a video, just add it directly, but if it is a playlist, I will first grab the first 10 videos, the rest will throw in a thread to continue, this is to speed up the time to start the song, otherwise, the user will feel impatient.

Play command

Users_class  = {}

@client.command(brief="Play music (My wonderful singing )")
async def play(ctx, url : str):
    if not ctx.message.author.voice:
        await ctx.send('you are not connected to a voice channel')
        return
    else:
        channel = ctx.message.author.voice.channel

    if (channel.id in Users_class):
        if ctx.guild.voice_client not in client.voice_clients:
            await Users_class[channel.id].kill() # kill the music player
            del Users_class[channel.id]
            print("[*] rejoin the voice channel")
            voice =  await channel.connect()
            MB = MusicBot(channel, voice , ctx)
            Users_class[channel.id] = MB
        await Users_class[channel.id].add(url)
    else:
        voice =  await channel.connect()
        MB = MusicBot(channel, voice , ctx)
        print(f"[*] creating Class id : {id(MB)} for serving channel",channel.id)
        Users_class[channel.id] = MB
        await MB.add(url)

In play command, I will create the music bot class and save the class to a dictionary by using channel id as the key.

# play next music
async def _next(self):

    if (len(self.queqed) == 0):

        if (self.loop): # refill the music queqed for play with Played music
            self.queqed = self.passed
            self.passed = []
        else:
            self.state = 0
            return    

    self.state = 1    # State = 1 -> start playing                 
    self.this_song  = self.queqed.pop(0) # get the song 
    self.passed.append(self.this_song)   # Store in history music

    print("[*] playing  :", self.this_song[0],"in", self.channelid)
    this_song_url   = self.this_song[1]
    this_song_name  = self.this_song[0]


    #  This for is beacuse the youtube_dl will change the filename
    #  when handling special char
    for each_char in ['"', "'", ":", "|"]:
        if (each_char in this_song_name):
            this_song_name = this_song_name.replace(each_char,"#")

    # youtube_dl will create a floder for \ and /
    for each_char in ["\\", "/"]:
        if (each_char in this_song_name):
            this_song_name = this_song_name.replace(each_char,"")

    song_path  = os.path.join(self.floder , this_song_name)

    # download youtube music
    if ( not os.path.isfile(song_path)):
        self.ytl  = {
            'format': '249/250/251',
            "outtmpl" : f"{self.floder}/{this_song_name}",
            'noplaylist': False,
        } 
        self.dowloading = await self.ctx.send(f'... Downloading {this_song_name}')
        print("[*] downloading ->", this_song_name,"\n")
        with youtube_dl.YoutubeDL(self.ytl) as ydl:
            ydl.download([this_song_url])
        print("\n[*] ------------ download successful ------------")

    # Check if bot is in the voice channel
    if self.ctx.guild.voice_client not in client.voice_clients:
        print("[*] get kicked from",self.channelid)
        return

    # send currently playing music
    self.music_msg = await self.ctx.send(f':musical_note:  Now playing ({len(self.passed)}/{len(self.queqed)+len(self.passed)}) : {this_song_name} :musical_note:')

    

    ######################   I will explian this later
    FFMPEG_OPTS = {
        'before_options': '-reconnect 1 -reconnect_streamed 1 -reconnect_delay_max 5', 
        'options': '-vn'
        }
           self.rejoin_c += 1
   if (self.rejoin_c == 10):
         self.voice.play(
                discord.FFmpegPCMAudio(song_path, **FFMPEG_OPTS), 
                after=lambda e: print("[*] reconnecting the ffmpeg , error : ",e)
                )
        self.rejoin_c = 0

        await asyncio.sleep(5)
   ######################

    # play the music, call _endsong when the song finish
    self.voice.play(
            discord.FFmpegPCMAudio(song_path), 
            after = lambda e: asyncio.run_coroutine_threadsafe(self._endsong(e), client.loop)
            )

    
    # check every three song 
    self.dont_stop +=1
    if (self.dont_stop > 3):
        client.loop.create_task(self.check())

This is a quite long function, but most of them are actually pretty easy to understand, except the FFMPEG_OPTS part, this part is to solve a known problem.

https://support.discord.com/hc/fr/articles/360035010351–Known-Issue-Music-Bots-Not-Playing-Music-From-Certain-Sources

The robot will suddenly have no sound while playing a song, I often encounter this problem when I am testing,

To solve this problem, you have to use that FFMPEG_OPTS variable. It will reconnect the bot to the source.

But there is a bug, I’m not sure if it is my problem or how, my FFmpeg will show “reconnect” Option not found, I still trying to fix it.

Step 8 : Complete every thing

This is my MusicBot with all the functions we want.

Then try to run the bot and see if everything works well.

Step 9 : Develop on server

Now try to put this robot on a server, you can use Heroku or something else, for me , I will put it on the Raspberry Pi

So, first I will use python to open a simple webserver on windows to send my bot’s code to Raspberry Pi .

python -m http.server

Cause I’m connect to the same route, so I can use the local internet to send my bot, use Ip config to get you computer’s local IP

ipconfig

Just wget the ip: port/file and you can grab the file

Set up your environment and run the server

pip install google-api-python-client
pip install discord.py
pip install youtube_dl
sudo apt install ffmpeg

Congratulations, you successfully made your own robot !!!

This is because pip has not been added to the path

So first, follow my step to find python’s floder.

so this is my python floders

C:\Users\wesle\AppData\Local\Programs\Python\Python37     # This is python
C:\Users\wesle\AppData\Local\Programs\Python\Python37\Scripts   # This is pip

Then open the setting of environment variables, for English users, try ‘env’.

Add the floder path we Just get

Open cmd and type pip, your path is set up right now.

why python? Python is a programming language that lets you work more quickly and integrate your systems more effectively. <– (Introduction on the official website), and also my favorite language.

Here, I will show how to download python and run with Jupiter and Sublime

Goto https://www.python.org/, click download, windows

Choose you version, for me, I will download python 3.7 (64bit)

open the installer, remember to Check Add Python3.* to PATH, and Just click Install Now.

Download Sublime, https://www.sublimetext.com/

Click next and install it.

Fisrt program

CTRL + SHIFT + P type python, and save the file and with .py

CTRL + B to run the code

Install Jupyter

Windows + R and type CMD

If the python’s installation is correct, pip should show something, if you did not see it, try to fix it with following url.

http://ouyangminwei.com/index.php/2021/09/16/how-to-solve-pip-not-found/

Pip is a python package manager, you can type ‘pip install notebook’ to install Jupyter.

pip install notebook

And type ‘jupyter notebook’ to start the jupyter notebook

jupyter notebook

It will open a web page, press new and select python3 to start a new script

And you start your coding

Commonly used Jupyter shortcut keys