artipy

---

Easily generate Genshin Impact artifacts.

📚 Table of Contents

• About
• Getting Started
• Deployment
• Documentation
• Usage
• License
• Changelog
• Acknowledgements

📝 About

This is a Python package that can generate Genshin Impact artifacts as close to how they are in the game as possible. It is intended to be used for statistical analysis

📦 Getting Started

To install and use the package right away, you can use pip:

python -m pip install -U git+https://github.com/trumully/artipy.git
# or if you don't have 'git' installed:
python3 -m pip install -U https://github.com/trumully/artipy/zipball/main

For development, follow the steps below:

Prerequisites

• Python >=3.13.0
• uv

Installing

Clone the repository:

git clone https://github.com/trumully/artipy.git

Install dependencies:

uv sync

🧪 Running tests

Run tests using pytest:

uv run pytest

🔧 Usage

Check out the documentation for usage examples.

🚀 Deployment

Build the package using uv:

uv build

This will create a tar.gz and whl in the dist/ directory:

dist/
├── artipy-(version)-py3-none-any.whl
└── artipy-(version).tar.gz

You can install the built package using pip:

python -m pip install -U dist/artipy-(version)-py3-none-any.whl
# or
python -m pip install -U dist/artipy-(version).tar.gz

🎉 Acknowledgements

✨ Original header image belongs to HoYoverse

✨ The Genshin Optimizer project for hugely inspiring this project.