File: README.md

package info (click to toggle)
eartag 1.0.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,984 kB
  • sloc: python: 9,058; sh: 56; makefile: 2
file content (84 lines) | stat: -rw-r--r-- 3,951 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# Ear Tag

Small and simple audio file tag editor

![Screenshot](data/screenshot-scaled.png)

## About

Ear Tag is a simple audio file tag editor. It is primarily geared towards making quick edits or bulk-editing tracks in albums/EPs. Unlike other tagging programs, Ear Tag does not require the user to set up a music library folder.

Ear Tag supports both desktop and mobile form factors.

## Installing

Ear Tag is available on [Flathub](https://flathub.org/apps/details/app.drey.EarTag), as well as the following software repositories:

[![Packaging status](https://repology.org/badge/vertical-allrepos/eartag.svg)](https://repology.org/project/eartag/versions)

## Dependencies

Ear Tag is written in Python, and uses GTK4 and libadwaita for the UI. The following dependencies are required:

- Python >= 3.11
- GTK4 >= 4.16.0
- libadwaita >= 1.6.0
- pygobject >= 3.49.0 (3.51.0 or higher is highly recommended)
- [pillow](https://pypi.org/project/pillow) (used for some picture operations)
- [mutagen](https://pypi.org/project/mutagen) (used for file tagging)
- [filetype](https://pypi.org/project/filetype) (used for MIME type detection)
- [pyacoustid](https://pypi.org/project/pyacoustid) (used for Identify Selected Files option)
  - [audioread](https://pypi.org/project/audioread/) or fpcalc as the sound data reading backend
- [aiohttp](https://pypi.org/project/aiohttp) (used for the downloader used by the Identify Selected Files option)
- [aiohttp-retry](https://pypi.org/project/aiohttp-retry) (see above)
- [aiofiles](https://pypi.org/project/aiofiles/) (used during file loading)
- [xxhash](https://pypi.org/project/xxhash/) (used during album cover caching and comparisons)

The following packages are required to run tests:

- appstreamcli
- desktop-file-utils
- glib-compile-schemas
- [pytest](https://pypi.org/project/pytest/)
- [pytest-asyncio](https://pypi.org/project/pytest-asyncio/)

[ruff](https://docs.astral.sh/ruff/) is used for linting/formatting the code.

## Building

We use the meson build system. The build process is as follows:

```
meson output
meson compile -C output
meson install -C output
```

For development purposes, this is automated in the provided `run` script.

## Contributing

Project development happens on [GNOME's GitLab instance](https://gitlab.gnome.org/World/eartag). For starters, check out the [open issues](https://gitlab.gnome.org/World/eartag/-/issues).

Translations can be submitted through [Damned Lies (l10n.gnome.org)](https://l10n.gnome.org/module/eartag/).

If you make modifications to the code, run `ruff check` and `ruff format` to ensure that everything is formatted correctly. For convenience, you can also use `pre-commit install` to install a pre-commit hook that runs these commands automatically.

You are expected to follow the [GNOME Code of Conduct](https://wiki.gnome.org/Foundation/CodeOfConduct) when participating in project spaces.

### Commit style

**Please follow the following commit style:**

 - All commits have a prefix that contains the area of the code that has been changed:
   - For the README.md file, build files (meson.build) and things like .gitignore, this is `meta:`
   - For anything in the data directory, this is `data:`
   - For anything related to translations or the po directory, this is `po:`
   - For the actual code, this is the filename of the main file you've edited, e.g. `fileview:`
 - Commit messages are in all lowercase, except for class names, filenames (if they're capitalized - like README, COPYING etc.) and project names (e.g. Musicbrainz).

## TODO

While Ear Tag is ready to use as-is, there are a few nice features that may be added in the near future. You can find them in our [bug tracker](https://gitlab.gnome.org/World/eartag/-/issues/?label_name%5B%5D=feature%20request).

The project's fully open-source, so if you feel like you could try to implement one of these features, feel free to do so and send a patch to us!