Metadata-Version: 2.4
Name: emoji-scripts
Version: 0.1.1
Summary: Tools for dealing with emojis
Keywords: emoji,animation
Author: Phil Pennock
Author-email: Phil Pennock <python-pkgs@pennock-tech.com>
License-Expression: ISC
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: Multimedia :: Graphics
Requires-Dist: numpy>=1.20.0
Requires-Dist: pillow>=9.0.0
Requires-Python: >=3.14
Project-URL: repository, https://github.com/philpennock/emoji-scripts
Project-URL: issues, https://github.com/philpennock/emoji-scripts/issues
Description-Content-Type: text/markdown

emoji scripts
=============

Tools for making or working with emojis, where emoji is used in the Slack
sense: short-code named images, up to 128x128px, intended for communication.
Not, directly, Unicode emoji code-points.

Creation of emojis, editing, uploading, syncing, whatever.

## Tools / Scripts

| Name     | Purpose                                            |
| -------- | -------------------------------------------------- |
| waveflag | create animated emoji with a waving-in-wind effect |

## Using

Depends upon the script.  If it's Python, then you should be able to use
without installing.  For instance:

```sh
uv tool run --from emoji-scripts waveflag --help
```

For an actual conversion, given an existing input file `flag-us-pa.png`:

```sh
uv tool run --from emoji-scripts waveflag \
  --fireworks --border-color=none flag-us-pa.png waving-us-pa.gif
```

Other language ecosystems will be addressed as they arise.

For scripts, you should always be able to invoke directly from inside this
repo; each script should include sufficient metadata to let it be run
independently, without installing.

```sh
uv run --script animation/waveflag.py --help
```

Or you can install the script globally, using the package manager of your
choice.


## Developing

### Contributions

Contributions, both human and AI-written, welcome, as long as a human takes
responsibility for any given commit: an AI might write it, but if you submit
it, you're responsible for it.

### Licensing

ISC.


### Coding Practices

I have a strong preference for Python or Go for software which needs to be
maintained, but we'll also take robust shell if it's invoking tools such as
ImageMagick and is sufficiently short (and passes shellcheck(1)).

For Python: please include PEP 723 metadata inline in the script, so that it
can be invoked without requiring that people install everything in this
collection.  But do also ensure that you have a `main()` function which can be
used as an entrypoint for when people _do_ install all these scripts.

(He says, when there's so far 1 script).

There's an `.editorconfig` file to try to get things somewhat consistent.

I tend to use `ruff` and `ty` as LSPs when editing.  So while I might add
AI-generated code which is not 100% diagnostic-free, if I go editing then I'll
fix.  As long as you are using sensible types to have code which can be
reasoned about by those not familiar with it, this is fine for submissions.

I use `uv` and am happy to be fairly aggressive in upgrading minimum Python
versions, rather than get trapped having to support ancient Python.

If we need a task runner, it will likely be Task (<https://taskfile.dev/>).
