Penny - The Martian

This is under development. Please refrain from using it.

I am Penny. The ultimate aim of my life is to serve the Earthians. You can ask for anything you want and I will try my best to fullfil your wishes.

Currently I have the following

1. Todos
2. Reminders
3. Astro articles
4. Xkcd comics
5. Youtube custom playlists

• To read a random comic from Xkcd simply type "comic"
• To read a random astronomy article type "astro"

Table of contents

• Installation
• How to contribute
• Issues
• Contributors
• Creators
• Copyright and license

Installation

Follow the installation procedure below:

Pre-requisite

Before installing Penny, you should have the following on your machine

1. pip
2. virtualenv
3. mongodb
4. lex and yacc

For download and installation of MongoDB please follow the official documentation

Before installing Penny make sure your MongoDB server is up and running.

The procedure of installing Penny is pretty simple. Just follow the steps below.

$ git clone https://github.com/arpitbbhayani/penny.git
$ cd penny

Now, you need to create the config.py file. In order to create this file simply copy app/config.py.0 to app/config.py.

1. Edit GOOGLE_SERVER_API_KEY and set your own api key here.

$ ./install.sh

Penny will be initialized by executing

$ ./start.sh

Say Hi to Penny from your favourite browser

http://localhot:10101

How to contribute

Anyone with basic knowledge of jQuery and Python can contribute to Penny.

Contributing to Penny is simple. You can

1. Fix an existing bug. Browse through the complete list here.
2. Have a feature idea? share it with us.

There is a crisp documentation written on How to contribute; you can follow that and get started 😄

Issues

Have a bug or a feature request? You can find our existing and closed issues here. If your problem or idea is not addressed yet, please open a new issue.

Contributors

This is our own "Hall Of Fame" and these are some of the most awesome people who made this project possible.

• Arpit Bhayani

Creators

Arpit Bhayani

Copyright and license

Code copyright 2015 Arpit Bhayani. Code released under the MIT license.