Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update system requirements for Sopel 7 #22

Closed
wants to merge 1 commit into from
Closed

Update system requirements for Sopel 7 #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions _usage/system-requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,16 @@ Sopel is designed to run on Linux with Python 2.7 or 3.3+. It should probably wo
Sopel itself has few external dependencies, besides Python. There are a couple, though:

* [dnspython](https://github.com/rthalley/dnspython) - used internally to enhance connection reliability
* [requests](https://github.com/requests/requests) - used to maintain compatibility with old modules that still try to use Sopel's `web` utility functions
* sqlite - included with all supported Python releases
* [requests](https://github.com/requests/requests) - used to maintain compatibility with old plugins that use deprecated features of Sopel's `web` utility API
* [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy) - used for database cross-compatibility (SQLite, MySQL, PostgreSQL, etc.)

Most of Sopel's dependencies are only needed for specific modules. Below is a listing of some of these. If you don't want to use a specific module, you do not need its dependencies.
Most of Sopel's dependencies are only needed for specific plugins. Below is a listing of some of these. If you don't want to use a specific plugin, you do not need its dependencies.

* [geoip2](https://github.com/maxmind/GeoIP2-python) - ip. You will also need the appropriate database files, which Sopel will download automatically if they are not found.
* [ipython](https://github.com/ipython/ipython) - ipython
* [ipaddress](https://github.com/phihag/ipaddress) - url (only needed on Python 2)
* [praw](https://github.com/praw-dev/praw) - reddit
* [pyenchant](https://github.com/rfk/pyenchant) - spellcheck. You may also need to install the system-level `enchant` library.
* [pytz](https://launchpad.net/pytz) - remind, clock, seen, tell
* [requests](https://github.com/requests/requests) - [many]. Used by nearly every module that needs to talk to a web service.
* [requests](https://github.com/requests/requests) - used by nearly every plugin that needs to talk to a web service. This includes both built-in and third-party plugins; you probably should just install this one.
* [xmltodict](https://github.com/martinblech/xmltodict) - bugzilla, search

Most of these packages can be installed through the `pip` command, or via your Linux distribution's software repository. If you install Sopel through `pip` or your distribution's package manager (on Fedora or Arch), all of these dependencies will be installed for you.