Skip to content

Installation

This guide will help you install faker-news and get it running on your system.

Requirements

  • Python 3.9 or higher
  • pip or uv package manager
  • An API key for an OpenAI-compatible LLM service

Installation Methods

Using pip (Standard)

Install the package directly from source:

pip install -e .

For development with testing tools:

pip install -e ".[dev]"

For documentation building:

pip install -e ".[docs]"

If you're using uv for faster package management:

uv pip install -e .

Verifying Installation

After installation, verify that the CLI is available:

faker-news --help

You should see the help menu with all available commands.

Next Steps

Once installed, you'll need to configure your LLM API key. Continue to:

  1. Setup & Configuration - Configure your API keys
  2. Quick Start - Start generating content right away

Uninstallation

To remove faker-news:

pip uninstall faker-news

Cache Files

Uninstalling won't remove the SQLite cache file. To completely remove all data:

# On Linux
rm ~/.cache/faker-news/cache.sqlite3

# On macOS
rm ~/Library/Caches/faker-news/cache.sqlite3

# On Windows
del %LOCALAPPDATA%\faker-news\cache\cache.sqlite3

Troubleshooting

Command not found

If faker-news command is not found after installation, ensure your Python scripts directory is in your PATH:

# Add to ~/.bashrc or ~/.zshrc
export PATH="$HOME/.local/bin:$PATH"

Import errors

If you get import errors when using the library, ensure you installed the package:

pip install -e .

Permission errors

On some systems, you may need to install with --user:

pip install --user -e .