TuxBot, A discord bot made in python https://gnous.eu
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Romain J 616a067bc2 feat(commands:misc|Dev): add random tests things 5 months ago
.envs/.local feat(host): start docker addon 8 months ago
.github update(main): improve launch UI 1 year ago
.idea feat(commands:mute|Mod): add mute/unmute command 5 months ago
compose fix(commands|Custom>alias): close TUXBOT-BOT-1A, close TUXBOT-BOT-1H, close TUXBOT-BOT-1J 8 months ago
tuxbot feat(commands:misc|Dev): add random tests things 5 months ago
.deepsource.toml fix(deepsource): remove black from deepsource conf 1 year ago
.gitignore update(core): change to >=3.8 5 months ago
.mypy.ini fix(commands:iplocalise|Network): remove crashing regex 7 months ago
.pylintrc fix(commands:iplocalise|Network): close TUXBOT-BOT-4N 5 months ago
LICENSE fix(linting): set the not to 10/10 on pylint 1 year ago
Makefile update(core): change to >=3.8 5 months ago
README.rst update(core): change to >=3.8 5 months ago
dev.requirements.txt fix(commands:iplocalise|Network): remove crashing regex 7 months ago
local.yml fix(commands|Custom>alias): close TUXBOT-BOT-1A, close TUXBOT-BOT-1H, close TUXBOT-BOT-1J 8 months ago
production.yml fix(commands|Custom>alias): close TUXBOT-BOT-1A, close TUXBOT-BOT-1H, close TUXBOT-BOT-1J 8 months ago
setup.cfg fix(doc): update version 5 months ago
setup.py update(core): change to >=3.8 5 months ago

README.rst

|image0| |image1| |image2| |image3|

.. role:: bash(code)
:language: bash

Installing Tuxbot
=================

It is preferable to install the bot on a dedicated user. If you don't
know how to do it, please refer to `this guide <https://www.digitalocean.com/community/tutorials/how-to-create-a-sudo-user-on-ubuntu-quickstart>`__

Installing the pre-requirements
-------------------------------

- The pre-requirements are:

- Python 3.8 or greater
- Pip
- Git

Operating systems
~~~~~~~~~~~~~~~~~

Arch Linux
^^^^^^^^^^

.. code-block:: bash

$ sudo pacman -Syu python python-pip python-virtualenv git make gcc postgresql

Continue to `configure postgresql <#configure-postgresql>`__.

--------------

Debian
^^^^^^

.. code-block:: bash

$ sudo apt update
$ sudo apt -y install python3 python3-dev python3-pip python3-venv git make gcc postgresql postgresql-client

Continue to `configure postgresql <#configure-postgresql>`__.

--------------

RHEL and derivatives (CentOS, Fedora...)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: bash

$ sudo dnf update
$ sudo dnf install python3 python3-devel python3-pip python3-virtualenv git make gcc postgresql-server postgresql-contrib

Continue to `configure postgresql <#configure-postgresql>`__.

--------------

Windows
^^^^^^^

*not for now and not for the future*

--------------

Configure PostgreSQL
--------------------

Now, you need to setup PostgreSQL

Operating systems
~~~~~~~~~~~~~~~~~

Arch Linux
^^^^^^^^^^

https://wiki.archlinux.org/index.php/PostgreSQL

Continue to `create the venv <#creating-the-virtual-environment>`__.

--------------

Debian
^^^^^^

https://wiki.debian.org/PostgreSql

Continue to `create the venv <#creating-the-virtual-environment>`__.

--------------

RHEL and derivatives (CentOS, Fedora...)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

https://fedoraproject.org/wiki/PostgreSQL

Continue to `create the venv <#creating-the-virtual-environment>`__.

--------------

Creating the Virtual Environment
--------------------------------

To set up the virtual environment and install the bot, simply run this
two commands:

.. code-block:: bash

$ make
$ make install

Now, switch your environment to the virtual one by run this single
command: :bash:`source ~/venv/bin/activate`

Configuration
-------------

It's time to set up your first instance, to do this, you can simply
execute this command:

:bash:`tuxbot-setup`

After following the instructions, you can run your instance by executing
this command:

:bash:`tuxbot`

Update
------

To update the whole bot after a :bash:`git pull`, just execute

.. code-block:: bash

$ make update

.. |image0| image:: https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10-%23007ec6
.. |image1| image:: https://img.shields.io/github/issues/Rom1-J/tuxbot-bot
.. |image2| image:: https://img.shields.io/badge/code%20style-black-000000.svg
.. |image3| image:: https://wakatime.com/badge/github/Rom1-J/tuxbot-bot.svg
:target: https://wakatime.com/badge/github/Rom1-J/tuxbot-bot