Installation

In this document, you will learn how to install the spamfilter library. There are generally three options to get started.

---

👉 How to install

You may install the library using pip, which is the easiest way to do it as spamfilter is in the PyPI index.

To achieve this, run

pip install spamfilter

in your terminal. If that doesn't work, for example due to pip not being added to your PATH, just try

python3 -m pip install spamfilter

instead.

Extra dependencies

The base installation of spamfilter comes with a few built-in filters that do not require any extra dependencies. However, if you want to use additional features, you may install extra dependencies using the following tags.

If you plan to use spamfilter with third-party API calling support, run

pip install spamfilter[api]

If you want to use the OpenAI integration, run

pip install spamfilter[openai]

If you want to take advantage of machine learning text classification using 🤗 Transformers, run

pip install spamfilter[transformers]

If you want to install development dependencies, run

pip install spamfilter[dev]

Other installation methods

You can also install spamfilter without using the Python package index and instead install the source files locally. This can be achieved using this website's download links at the very top or the files available at the GitHub repository.

Place the .zip or .tar.gz-files into your project folder, unpack them and move the src folder into your project root.

🚩 Note that the manual install using download is not recommended because it's way less optimized, bloated with unnecessary files and hard to do.