Installation#

This guide covers installation for end users. For development setup, see Contributing.

Requirements#

  • Python 3.11, 3.12, or 3.13

Basic Installation#

Install the core package:

python -m pip install icalendar-anonymizer

This installs only the Python library with its core dependency, icalendar.

Tip

Using python -m pip ensures you install to the correct Python interpreter. See Why you should use python -m pip for details.

Optional Features#

This section describes how to install optional features of icalendar-anonymizer, including a command-line interface (CLI) and web service support.

Command-Line Interface#

Install the CLI with the following command.

python -m pip install icalendar-anonymizer[cli]

This installs the icalendar-anonymize and ican commands. See Command-Line Interface for usage details.

Web Service#

Install the web service with the following command.

python -m pip install icalendar-anonymizer[web]

This installs FastAPI, uvicorn, and dependencies for the REST API server. See Web Service for usage details.

All Features#

Install all the foregoing optional features with the following command.

python -m pip install icalendar-anonymizer[all]

Docker#

Pull and run the Docker image:

docker pull sashankbhamidi/icalendar-anonymizer
docker run -p 8000:8000 sashankbhamidi/icalendar-anonymizer

The web service will be available at http://localhost:8000. See Self-Hosting for configuration options.

Verifying Installation#

Check the installation:

import icalendar_anonymizer
print(icalendar_anonymizer.__version__)

Or check the installed version:

python -m pip show icalendar-anonymizer

Upgrading#

Upgrade to the latest version:

python -m pip install --upgrade icalendar-anonymizer

Uninstalling#

Remove the package:

python -m pip uninstall icalendar-anonymizer

Troubleshooting#

This section describes how to troubleshoot issues with installation.

Import Error#

If you get an ImportError when importing icalendar_anonymizer, then try the following steps.

  1. Verify that the package is installed.

    pip list | grep icalendar

  2. Check that you’re using a supported version of Python.

    python --version

  3. Ensure that you’re in the correct virtual environment.

Dependency Conflicts#

icalendar-anonymizer requires a compatible version of icalendar. If you encounter dependency conflicts with icalendar, then perform the following steps.

  1. Check that your installed version of icalendar is supported by icalendar-anonymizer.

    pip show icalendar

  2. Upgrade icalendar, if needed.

    python -m pip install --upgrade icalendar

Getting Help#

If you encounter installation issues:

  • Check the Issue Tracker for existing issues.

  • If there isn’t an existing issue, then open a new one.