Metadata-Version: 2.4
Name: tsukasa-credit-card-gag-scam
Version: 1.2.0
Summary: A joke program based on a popular credit card scam meme
Project-URL: Original source code, https://github.com/Bleeplo/Tsukasa-credit-card-gag-scam
Project-URL: Original Windows executable, https://drive.google.com/file/d/1gVKI089Y7Ub7MrqNmRwsvOGZYS3msnIu/view?usp=sharing
Project-URL: Updated source code, https://github.com/Diapolo10/Tsukasa-credit-card-gag-scam
Project-URL: Updated executables, https://github.com/Diapolo10/Tsukasa-credit-card-gag-scam/releases
Project-URL: Documentation, https://github.com/Diapolo10/iplib3/tree/main/docs
Author-email: Bleeplo <bleeplo@users.noreply.github.com>
Maintainer-email: Lari Liuhamo <lari.liuhamo+github@gmail.com>
License-Expression: MIT
Requires-Python: >=3.11.0
Requires-Dist: pillow>=11.2.1
Requires-Dist: python-dotenv>=1.1.0
Description-Content-Type: text/markdown

# Tsukasa credit card gag scam

NOTE: This is a joke program, it has zero malicious intent and is simply
designed to have fun with an old Internet joke.

This is a fork of Bleeplo's version with a more standardised project
structure, and built-in releases.

## Example

![A GIF animation of the program running][example-gif]

## Getting Started

### Dependencies

The main project has very few library dependencies. They're all listed in
[`pyproject.toml`][pyproject-toml].

The project assumes Python version 3.11.0 or newer.

The project is tested on the latest versions of Windows,
Mac OS, and Ubuntu, and it has also been tested on both CPython
and PyPy. Using other implementations or operating systems
may work, but is not guaranteed.

### Installation

To install the project with development dependencies,

1. Install `uv`: [`uv` documentation][uv-docs]
2. Within the project directory, run `uv sync`

### Running the program

```sh
uv run tccgs
```

### Running linters

```sh
uv run ruff check .
```

If you wish to auto-fix certain issues,

```sh
uv run ruff check . --fix
```

### Running formatters

```sh
uv run ruff format
```

### Building executables

You can build an executable for non-Windows platforms using

```sh
uv run nuitka --standalone --onefile --assume-yes-for-downloads --output-dir=build --enable-plugin=tk-inter --include-data-dir=src/tccgs/data=data src/tccgs/script.py
```

and for Windows with

```sh
uv run nuitka.cmd --standalone --onefile --assume-yes-for-downloads --output-dir=build --enable-plugin=tk-inter --include-data-dir=src/tccgs/data=data --windows-console-mode=attach src/tccgs/script.py
```

## Version history

The project's changelog can be found [here][changelog].

## Special thanks

* [@Bleeplo][], for creating the original program. You can find their original
  executable release [here][original-exe].

[changelog]: ./CHANGELOG.md
[example-gif]: ./docs/assets/example.gif
[pyproject-toml]: ./pyproject.toml
[uv-docs]: https://docs.astral.sh/uv/
[@Bleeplo]: https://github.com/Bleeplo
[original-exe]: https://drive.google.com/file/d/1gVKI089Y7Ub7MrqNmRwsvOGZYS3msnIu/view?usp=sharing
