irclogs

Simple IRC logger with a Flask application to store and view logs

Technologies

We will be using the following technologies

• Python 3
• Flask, a microframework
• Jinja2, a template engine
• AngularJS, a javascript MVC framework

Getting Started

Here's everything you need to know to get a copy of nycpython.com running locally.

What You Need

• Git
• A GitHub account
• The code

What You Need to Know

Once you are familiar with Flask, it is recommended that you also become familiar with blueprints and application factories. For more information about application factories, please check out this post by Matt Wright.

Setup

For users unable to install VirtualBox or Vagrant you can still get a copy running locally. Fork the code on GitHub and clone it locally by executing the following command, replacing USERNAME with your GitHub username:

$ git clone [email protected]:USERNAME/irclogs.git

After doing that, create a virtual environment irclogs with Python 3 as your default interpreter and execute the following command to install all the necessary dependencies for this project:

$ pip install -r requirements.txt
$ python manage.py db upgrade
$ python manage.py runserver

The site can be accessed in your browser by visiting localhost:5000.

To run the logger bot (from the project root directory):

$ python -m irclogs.irclogger -s "irc.freenode.net" -n "NICKNAME" -c "#nycpython" -P "NICKNAME:PASSWORD"

Contributing

A list of issues can be found on GitHub. Issues are categorized according to specific areas of focus. The can be used to help find issues in which you are particularly interested.

Pick one and start hacking away!

After you're done, be sure to add your name and GitHub profile to AUTHORS.rst.