Installation
Quick Install
Using uv (Recommended)
uv is an extremely fast Python package installer. You can use it to install factorio and try it out:
$ uv pip install factorio
Using pip
$ pip install factorio
Using Poetry
$ poetry add factorio
Project Configuration
Using a PEP 621 compliant build backend
PEP 621 is the standard way to store your dependencies in a pyproject.toml file. You can add factorio to your pyproject.toml file:
[project]
dependencies = [
"factorio~=0.7",
]
Using requirements.txt
factorio~=0.7
Python Version Requirement
⚠️ Important: factorio requires Python 3.10 or higher.
If you're not using uv, please ensure that you have a compatible Python version installed on your system.
Check your Python version:
$ python --version
Python 3.10.0
Dependencies
factorio depends on: - faker >= 30.8 - For realistic data generation - pyutilkit ~= 0.11 - Utility functions - tzdata (Windows only) - Timezone data
These dependencies are automatically installed when you install factorio.
Verification
After installation, verify that factorio is working:
python -c "from factorio.factories import Factory; print('factorio installed successfully!')"
Troubleshooting
Import Errors
If you get import errors, make sure you're using Python 3.10+:
$ python3.10 -m pip install factorio
Version Conflicts
If you encounter version conflicts with faker or other dependencies:
$ uv pip install factorio --upgrade
Or with pip:
$ pip install factorio --upgrade
Virtual Environments
It's recommended to use virtual environments:
# Create virtual environment
$ python -m venv .venv
# Activate it
$ source .venv/bin/activate # Linux/Mac
$ .venv\Scripts\activate # Windows
# Install factorio
$ pip install factorio
Next Steps
- Read the Quick Start Guide to learn how to use factorio
- Check out the Field Reference for all available field types
- Browse the Cookbook for common patterns