Code Monkey home page Code Monkey logo

botijo's Introduction

Botijo

IRC bot written in Python with modules support

Installation

Botijo uses Poetry for Python dependency management (https://python-poetry.org/) so first of all you will need to run the install command from the src dir like this:

$ cd src
$ poetry install

Then you can build and install it by calling the Makefile from the top dir.

$ make
$ sudo make install

The command above will place the binary in /usr/bin.
Alternatively you can also install it as a user in another path (i.e: /opt/bin)

$ sudo make install PREFIX=/opt

The example above will generate this tree:

  /opt/
   ├── bin
   │   └── botijo
   └── lib
       └── botijo
           ├── botijo.pyc
           ├── log.pyc
           ├── notes.pyc
           └── sysinfo.pyc

Usage

To configure your bot, you should edit the config file botijo.conf which contains default values. This can be override with command line options.

Command line options and usage:

Usage: botijo <options>
Where options are:
 -h, --help           Show this help information
 -V, --version        Show version information
 -v, --verbose        Print verbose messages
 --conf=CONFIG        Use alternate config file (default: ~/.botijo.conf)
 --host=SERVER        IRC server to connect
 --port=PORT          Port number of the server to connect
 --channels=CHANNELS  List of channels to join (separated by spaces)
 --nick=NICK          Nick name you want to use
Example:
  botijo --host=localhost --channels='#test1 #test2' --nick=foo

Additionally you can run botijo like a system daemon, for this purpose botijo.rc is provided as an example start script (use it at your own risk).

botijo's People

Contributors

sepen avatar

Watchers

James Cloos avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.