Installation¶

pip install chatterbot-weather

Example¶

from chatterbot import ChatBot

chatbot = ChatBot(
    'My Weather Bot',
    logic_adapters=[
        'chatterbot_weather.WeatherLogicAdapter'
    ]
)

Contributors Welcomed!¶

This package was originally created as a contribution to the main ChatterBot package. It was converted to a optional module in order to preserve the code quality of the main project. This weather adapter for ChatterBot works, but could benefit from improvements in several areas.

• Improved documentation with descriptions and information about the functions and structure of the adapter
• Additional support for other weather APIs
• Support for a wider range of questions about the weather (current, future, specific dates, etc.)

Stable release¶

To install chatterbot-weather, run this command in your terminal:

$ pip install chatterbot-weather

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources¶

The sources for chatterbot-weather can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/gunthercox/chatterbot-weather

Or download the tarball:

$ curl  -OL https://github.com/gunthercox/chatterbot-weather/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up chatterbot-weather for local development.

1. Fork the chatterbot-weather repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/chatterbot-weather.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv chatterbot-weather
   $ cd chatterbot-weather/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 chatterbot-weather tests
   $ python setup.py test
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/gunthercox/chatterbot-weather/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_chatterbot-weather

Development Lead¶

• Gunther Cox <gunthercx@gmail.com>

Contributors¶

None yet. Why not be the first?

0.1.0 (2016-05-12)¶

• First release on PyPI.