eyeD3 0.9.4__tar.gz → 0.9.8__tar.gz

eyed3-0.9.8/.readthedocs.yaml

@@ -0,0 +1,17 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .[dev]

{eyeD3-0.9.4 → eyed3-0.9.8}/AUTHORS.rst

@@ -27,15 +27,19 @@ and has been contributed to by (ordered by date of first contribution):
   * Hans Petter Jansson <hpj@copyleft.no>
   * Sebastian Patschorke <sludgefeast@users.noreply.github.com>
   * Bouke Versteegh <info@boukeversteegh.nl>
+  * gaetano-guerriero <x.guerriero@tin.it>
   * mafro <github@mafro.net>
-  * Gaetano Guerriero <x.guerriero@tin.it>
-  * Grun Seid <grunseid@gmail.com>
-  * pyup-bot <github-bot@pyup.io>
+  * Gabriel Diego Teixeira <gabrieldiegoteixeira@gmail.com>
   * Chris Newton <redshodan@gmail.com>
-  * deoren@users.noreply.github.com
-  * chamatht@gmail.com
-  * Mic92@users.noreply.github.com
-  * gabrieldiegoteixeira@gmail.com
-  * guillaume.web@gmail.com
-  * tim.gates@iress.com
-  * zhumumu@gmail.com
+  * Thomas Klausner <tk@giga.or.at>
+  * Tim Gates <tim.gates@iress.com>
+  * chamatht <chamatht@gmail.com>
+  * grun <grunseid@gmail.com>
+  * guiweber <guillaume.web@gmail.com>
+  * zhu <zhumumu@gmail.com>
+  * Michał Górny <mgorny@gentoo.org>
+  * Jonathan Herlin <Jonte@jherlin.se>
+  * Ramiro Gómez <code@ramiro.org>
+  * Steve Kowalik <steven@wedontsleep.org>
+  * gersonkurz <gerson.kurz@gmail.com>
+  * obskyr <powpowd@gmail.com>

{eyeD3-0.9.4 → eyed3-0.9.8}/HISTORY.rst

@@ -3,6 +3,107 @@ Release History
 
 .. :changelog:
 
+v0.9.8 (2025-04-26) : Armed & Dangerous
+---------------------------------------
+
+New
+~~~
+* Added rudimentary support for iTunes MVNM and MVIN frames. (#644) (obskyr <powpowd@gmail.com>)
+
+Changes
+~~~~~~~
+* Added support for Python 3.11, 3.12, and 3.13 (Travis Shirk <travis@pobox.com>)
+* Using PDM for dependency management. (Travis Shirk <travis@pobox.com>)
+* Raise GenreException instead of ValueError (Travis Shirk <travis@pobox.com>)
+* Removed support for Python 3.7 and 3.8 (Travis Shirk <travis@pobox.com>)
+
+Fix
+~~~
+* recording date fix (#623) (TJ-59>)
+* improve printing of WXXX frames (#662) (Todd Zullinger <tmz@pobox.com>)
+* align output from classic plugin (#660) (Todd Zullinger <tmz@pobox.com>)
+* classic plugin: decode ufid.owner_id for display (#661) (Todd Zullinger <tmz@pobox.com>)
+* handle BrokenPipeError (#663) (Todd Zullinger <tmz@pobox.com>)
+* Improved TextFrame ID checking. (Travis Shirk <travis@pobox.com>)
+* Fix dependency on `coverage` to be conditional to `test` extra (#606) (Michał Górny <mgorny@gentoo.org>)
+
+Other
+~~~~~
+* Skip tests if the data directory isn't found (#647) (Steve Kowalik <steven@wedontsleep.org>)
+
+
+v0.9.7 (2022-10-07) : Sunshine
+----------------------------------
+
+New
+~~~
+- [fixup-plugin] Added --no-dir-rename.
+- Add remove-all-unknown to classic plugin. <gobater@users.noreply.github.com>
+- Track/disc number support for JSON/YAML plugins (and tests)
+- CountAndTotalTuple named tuple for count/total values.
+- EyeD3 __all__ includes core.AudioFile.
+- AudioFile.__str__ returns path.
+- Strict render Frame flag to continue on render errors. Applied to RelVolAdjFrameV24, etc
+- Track unsupported frames and add `--remove-all-unknown` classic plugin
+  option (#586) <gobater@users.noreply.github.com>
+
+Changes
+~~~~~~~
+- Removed display-plugin due to Grako EOL (#585)
+- [stats] Print bytes as text and filter private members.
+- Remove Python 3.6 support, EOL. (#560)
+
+Fix
+~~~
+- Doc grammar fixed (#537) <74979584+piatrashkakanstantinass@users.noreply.github.com>
+- Fix problem when frame file format invalid, and input.read() returns
+  no more data at all - this had the potential to loop endlessly. (#539)
+  <gerson.kurz@ng-branch-technology.com, gerson.kurz@gmail.com>
+
+Other
+~~~~~
+- Create codeql-analysis.yml.
+- Documentation updates.
+- Also updated deps, and removed Python 3.7 from official testing.
+- Docs: Fix a few typos (#573) <tim.gates@iress.com>
+- Spelling fixes (#559) <Jonte@jherlin.se>
+- Typo fixes (#558) <code@ramiro.org>
+
+v0.9.6 (2020-12-28) : True Blue
+----------------------------------
+
+New
+~~~
+- Id3.Tag(version=) keyword argument.
+- Expose TextFrame ctor kwargs to Apple frames. fixes #407
+- Added --about CLI argument for extra version/program info.
+
+Fix
+~~~
+- Preserve linked file info in Tag.clear(). fixes #442
+- Handle v1 .id3/.tag files.
+- Improved `art` plugin behavior when missing dependencies.
+- [art plugin] Improved error for missing dependencies.
+- TYER conversion (and restored non v2.2 breakage, for now)
+- ID3 v2.2, date getters return values again.
+- Passed filtered files list or handleDirectory, and skip non-existant symlinks
+- Fixed installation supported Python text. fixes #405
+- Implement v1.0/v1.1 tag conversion rules.
+
+Other
+~~~~~
+- Poetry build system (#500)
+
+
+v0.9.5 (2020-03-28) : I Knew Her, She Knew Me
+----------------------------------------------
+
+Fix
+~~~
+- `eyeD3 --genre ""` to clear genre frame restored.
+- Genre id->name mapping for non-standard genres and custom maps.
+
+
 v0.9.4 (2020-03-21) : The Devil Made Me Do It
 -----------------------------------------------
 

{eyeD3-0.9.4 → eyed3-0.9.8}/MANIFEST.in

@@ -5,11 +5,15 @@ include LICENSE
 include README.rst
 include Makefile
 include tox.ini
+include setup.py
+include pdm.lock
+include .readthedocs.yaml
 
 graft docs
 prune docs/_build
 
-recursive-include test *.py
+recursive-include tests *.py
+include tests/pytest.ini
 
 exclude .cookiecutter.yml
 exclude .gitchangelog.rc
@@ -17,14 +21,11 @@ global-exclude __pycache__
 global-exclude .editorconfig
 global-exclude *.py[co]
 
-include requirements.txt
-recursive-include requirements *.txt *.yml
+recursive-include requirements *.txt
 
 recursive-include eyed3 *.py
-include eyed3/plugins/DisplayPattern.ebnf
 recursive-include examples *
 
-exclude fabfile.py
-exclude mkenv.sh
-exclude pavement.py
+exclude pdm.lock
 prune etc
+

eyed3-0.9.8/Makefile

@@ -0,0 +1,322 @@
+SHELL := /bin/bash
+.DEFAULT_GOAL := build
+
+## User settings
+PYTEST_ARGS ?= ./tests
+PYPI_REPO ?= pypi
+BUMP ?= prerelease
+TEST_DATA_DIR ?= $(shell pwd)/tests
+CC_MERGE ?= yes
+CC_OPTS ?= --no-input
+
+ifdef TERM
+BOLD_COLOR = $(shell tput bold)
+HELP_COLOR = $(shell tput setaf 6)
+HEADER_COLOR = $(BOLD_COLOR)$(shell tput setaf 2)
+NO_COLOR = $(shell tput sgr0)
+endif
+
+help:  ## List all commands
+	@printf "\n$(BOLD_COLOR)***** eyeD3 Makefile help *****$(NO_COLOR)\n"
+	@# This code borrowed from https://github.com/jedie/poetry-publish/blob/master/Makefile
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z0-9 -]+:.*?## / {printf "$(HELP_COLOR)%-20s$(NO_COLOR) %s\n", $$1, $$2}' $(MAKEFILE_LIST)
+	@echo ""
+	@printf "$(BOLD_COLOR)Options:$(NO_COLOR)\n"
+	@printf "$(HELP_COLOR)%-20s$(NO_COLOR) %s\n" PYTEST_ARGS "If defined PDB options are added when 'pytest' is invoked"
+	@printf "$(HELP_COLOR)%-20s$(NO_COLOR) %s\n" PYPI_REPO "The package index to publish, 'pypi' by default."
+	@printf "$(HELP_COLOR)%-20s$(NO_COLOR) %s\n" BROWSER "HTML viewer used by docs-view/coverage-view"
+	@printf "$(HELP_COLOR)%-20s$(NO_COLOR) %s\n" CC_MERGE "Set to no to disable cookiecutter merging."
+	@printf "$(HELP_COLOR)%-20s$(NO_COLOR) %s\n" CC_OPTS "OVerrided the default options (--no-input) with your own."
+	@echo ""
+
+
+all: clean build test  ## Build and test
+
+
+## Config
+PROJECT_NAME := $(shell sed -n "s/^name = \"\(.*\)\"/\1/p" pyproject.toml)
+ifeq ($(strip $(PROJECT_NAME)),)
+  $(error "PROJECT_NAME not set")
+endif
+VERSION := $(shell sed -n "s/^version = \"\(.*\)\"/\1/p" pyproject.toml)
+ifeq ($(strip $(VERSION)),)
+  $(error "VERSION not set")
+endif
+RELEASE_NAME = $(shell sed -n "s/^release_name = \"\(.*\)\"/\1/p" pyproject.toml)
+RELEASE_TAG := v$(VERSION)
+
+SRC_DIRS = ./eyed3
+GITHUB_USER = nicfit
+GITHUB_REPO = eyeD3
+CHANGELOG = HISTORY.rst
+CHANGELOG_HEADER = v${VERSION} ($(shell date --iso-8601))$(if ${RELEASE_NAME}, : ${RELEASE_NAME},)
+TEST_DATA = eyeD3-test-data
+TEST_DATA_FILE = ${TEST_DATA}.tgz
+ABOUT_PY := eyed3/__regarding__.py
+
+
+## Build
+.PHONY: build
+BUILD_OPTS ?=
+build: $(ABOUT_PY)  ## Build the project
+	pdm build -d dist/ $(BUILD_OPTS)
+
+$(ABOUT_PY): pyproject.toml
+	regarding -o $@
+
+
+## Clean
+clean: clean-test clean-dist clean-local clean-docs  # Clean the project
+	touch pyproject.toml
+	rm -rf ./build
+	rm -rf eye{d,D}3.egg-info
+	rm -fr .eggs/
+	find . -name '*.egg' -exec rm -f {} +
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	find . -name '__pycache__' -exec rm -fr {} +
+
+clean-local:
+	-rm tags
+	-rm all.id3 example.id3
+	find . -name '*.rej' -exec rm -f '{}' \;
+	find . -name '*.orig' -exec rm -f '{}' \;
+	find . -type f -name '*~' | xargs -r rm
+
+
+### Test
+.PHONY: test
+test:  ## Run tests with default python
+	tox -e py,lint
+
+SKIP_TEST_ALL ?= no
+test-all:  ## Run tests with all supported versions of Python
+	@if [ "$(SKIP_TEST_ALL)" != yes ]; then \
+	    tox --parallel=all ;\
+	fi
+
+test-data:
+	# Move these to eyed3.nicfit.net
+	test -f ${TEST_DATA_DIR}/${TEST_DATA_FILE} || \
+		wget --quiet "http://eyed3.nicfit.net/releases/${TEST_DATA_FILE}" \
+		     -O ${TEST_DATA_DIR}/${TEST_DATA_FILE}
+	tar xzf ${TEST_DATA_DIR}/${TEST_DATA_FILE} -C ${TEST_DATA_DIR}
+	cd tests && rm -f ./data && ln -s ${TEST_DATA_DIR}/${TEST_DATA} ./data
+
+clean-test:
+	rm -fr .tox/
+	rm -f .coverage
+	find . -name '.pytest_cache' -type d -exec rm -rf {} +
+	-rm .testmondata
+	-rm examples/*.id3
+
+clean-test-data:
+	-rm tests/data
+	-rm tests/${TEST_DATA_FILE}
+
+pkg-test-data:
+	test -d build || mkdir build
+	tar czf ./build/${TEST_DATA_FILE} -h --exclude-vcs -C ./tests \
+		    ./eyeD3-test-data
+
+publish-test-data: pkg-test-data
+	scp ./build/${TEST_DATA_FILE} eyed3.nicfit.net:./data1/eyeD3-releases/
+
+coverage:
+	coverage run --source $(SRC_DIRS) -m pytest $(PYTEST_ARGS)
+	coverage report
+	coverage html
+
+coverage-view:
+	@if [ ! -f build/tests/coverage/index.html ]; then \
+		${MAKE} coverage; \
+	fi
+	@${BROWSER} build/tests/coverage/index.html
+
+lint:  ## Check coding style
+	tox -e lint
+
+
+### Documentation
+.PHONY: docs
+docs:  ## Generate project documentation with Sphinx
+	rm -f docs/eyed3.rst
+	rm -f docs/modules.rst
+	sphinx-apidoc --force -H "$(shell echo $(PROJECT_NAME) | tr '[:upper:]' '[:lower:]') module" -V $(VERSION) -o docs/ ${SRC_DIRS}
+	$(MAKE) -C docs clean
+	etc/mycog.py
+	$(MAKE) -C docs html
+	-rm example.id3
+
+DOCS_DIST := $(PROJECT_NAME)-$(VERSION)-docs.tar.gz
+docs-dist: docs
+	cd docs/_build && tar czvf ./$(DOCS_DIST) html
+
+docs-view: docs
+	$(BROWSER) docs/_build/html/index.html
+
+clean-docs:
+	$(MAKE) -C docs clean
+	-rm README.html
+
+
+### Distribute
+.PHONY: dist
+dist: clean-dist lint all docs-dist ## Create source and binary distribution files
+
+_dist-md5:
+	@# The cd dist/docs keeps the dist/ prefix out of the md5sum files
+	cd docs/_build/ &&  md5sum $(DOCS_DIST) >| $(DOCS_DIST).md5
+	@cd dist && \
+	for f in $$(ls -I '*.md5'); do \
+		md5sum $${f} >| $${f}.md5; \
+	done
+	@ls -l docs/_build/$(DOCS_DIST)* dist
+
+
+clean-dist:  ## Clean distribution artifacts (included in `clean`)
+	rm -rf dist
+
+check-manifest:
+	check-manifest
+
+release-tag: _check-clean-repo _check-version-tag _check-main-branch
+	@if ! git tag --annotate $(RELEASE_TAG) -m "$(RELEASE_NAME)" 2> /dev/null; then \
+       echo "!!! $(RELEASE_TAG) already exists; update pyproject.toml !!!"; \
+       exit 1; \
+    fi
+	git push origin $(RELEASE_TAG)
+
+authors:
+	@# requires git-extras
+	@git authors --list | while read auth ; do \
+  		email=`echo "$$auth" | awk 'match($$0, /.*<(.*)>/, m)  {print m[1]}'`;\
+		echo "Checking $$email...";\
+  		if echo "$$email" | grep -v 'users.noreply.github.com'\
+  		                  | grep -v 'github-bot@pyup.io' \
+  		                  > /dev/null ; then \
+			grep "$$email" AUTHORS.rst > /dev/null || echo "  * $$auth" >> AUTHORS.rst;\
+		fi;\
+	done
+
+
+## Install
+install:  ## Install project and dependencies
+	python -m pip install --editable .
+
+install-dev:  ## Install project, dependencies, and developer tools
+	python -m pip install --editable .[dev,test]
+
+install-extra:  ## Install project, dependencies, and developer tools
+	python -m pip install --editable .[art-plugin,yaml-plugin]
+
+install-all: install install-extra install-dev
+
+
+## Release
+.PHONY: release
+release: _check-on-release-tag _check-clean-repo _check-gh _check-pypi dist publish-release
+
+pre-release: _check-version-tag dist check-manifest test-all requirements authors _check-clean-repo
+#pre-release: #	         changelog
+
+# Order is import here
+publish-release: _pypi-publish _web-publish _github-publish _docs-publish
+
+_pypi-publish:
+	pdm publish --no-build -r $(PYPI_REPO) --skip-existing  --dest ./dist
+
+_web-publish: _dist-md5
+	for f in `find ./dist -type f`; do \
+	    scp $$f eyed3.nicfit.net:./data1/eyeD3-releases/`basename $$f`; \
+	done
+
+_docs-publish:
+	# TODO: READTHEDOCS move latest to release version
+
+_github-publish:
+	@# TODO: --prerelease if appropriate
+	@# TODO: --notes-file when release notes are available
+	@# TODO: --latest=false when prerelease is used
+	gh release --repo nicfit/eyeD3 create $(RELEASE_TAG) --verify-tag \
+               --title "$(RELEASE_TAG) ($(RELEASE_NAME))" \
+               --draft \
+               --generate-notes ./dist/*.tar.gz ./dist/*.whl
+
+
+### MISC
+#
+#GIT_COMMIT_HOOK = .git/hooks/commit-msg
+#cookiecutter:
+#	tmp_d=`mktemp -d`; cc_d=$$tmp_d/eyeD3; \
+#	if test "${CC_MERGE}" = "no"; then \
+#		nicfit cookiecutter ${CC_OPTS} "$${tmp_d}"; \
+#		git -C "$$cc_d" diff; \
+#		git -C "$$cc_d" status -s -b; \
+#	else \
+#		nicfit cookiecutter --merge ${CC_OPTS} "$${tmp_d}" \
+#		       --extra-merge ${GIT_COMMIT_HOOK} ${GIT_COMMIT_HOOK};\
+#	fi; \
+#	rm -rf $$tmp_d
+
+## Runtime environment
+VENV_NAME ?= dev-eyeD3
+VENV_DIR ?= $(HOME)/.virtualenvs
+VENV_ACTIVATE := $(VENV_DIR)/$(VENV_NAME)/bin/activate
+clean-venv:
+	test -n "$(VENV_DIR)" && test -n "$(VENV_NAME)" && rm -rf $(VENV_DIR)/$(VENV_NAME)
+
+venv:
+	python -m venv --upgrade-deps $(VENV_DIR)/$(VENV_NAME)
+	@printf "\n$(BOLD_COLOR)To activate the virtualenv:$(NO_COLOR) source $(VENV_ACTIVATE)\n"
+	@printf "$(BOLD_COLOR)To deactivate the virtualenv:$(NO_COLOR) deactivate\n\n"
+
+
+_check-version-tag:
+	@if git tag -l | grep -E '^$(shell echo ${RELEASE_TAG} | sed 's|\.|.|g')$$' > /dev/null; then \
+        echo "!!! Version tag '${RELEASE_TAG}' already exists !!!"; \
+        false; \
+    else\
+        echo "Version tag '${RELEASE_TAG}' is available."; \
+    fi
+
+MAIN_BRANCH ?= 0.9.x
+_check-main-branch:
+	@if [ `git branch --show-current` != $(MAIN_BRANCH) ]; then \
+	   echo "!!! Not on $(MAIN_BRANCH) branch. !!!"; \
+	   exit 1; \
+	fi
+
+_check-on-release-tag:
+	@if [ "`git describe --tags`" != "$(RELEASE_TAG)" ]; then \
+	   echo "!!! Not on $(RELEASE_TAG) checkout. !!!"; \
+	   exit 1; \
+	fi
+
+_check-clean-repo:
+	@if [ -n "`git status --porcelain --untracked-files=no`" ]; then \
+	   echo "!!! Working repo has uncommitted/un-staged changes. !!!"; \
+	   exit 1; \
+	else \
+	   echo "Repo clean.";\
+	fi
+
+_check-gh:
+	@test -n "${GH_TOKEN}" || (echo "GH_TOKEN not set, needed for gh" && false)
+	@gh --help > /dev/null || (echo "gh not installed" && false)
+
+_check-pypi:
+	@(test -n "${PDM_PUBLISH_USERNAME}" && test -n "${PDM_PUBLISH_PASSWORD}") || \
+	 	(echo "PDM_BUBLISH_* not set, needed for PyPI publish" && false)
+
+#bump-release:
+#	@# TODO: is not a pre-release, clear release_name
+#	poetry version $(BUMP)
+
+.PHONY: requirements
+requirements:
+	pdm lock -G:all
+	pdm export --prod --no-hashes >| requirements/requirements.txt
+	pdm export -G test,dev --no-hashes  >| requirements/dev-requirements.txt
+	pdm export -G yaml-plugim,art-plugin --no-hashes  >| requirements/plugin-requirements.txt

eyed3-0.9.8/PKG-INFO

@@ -0,0 +1,158 @@
+Metadata-Version: 2.4
+Name: eyeD3
+Version: 0.9.8
+Summary: Python audio data toolkit (ID3 and MP3)
+Author-email: Travis Shirk <travis@pobox.com>
+Project-URL: homepage, https://eyeD3.nicfit.net/
+Project-URL: repository, https://github.com/nicfit/eyeD3
+Keywords: id3,mp3,python
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Topic :: Multimedia :: Sound/Audio :: Editors
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: POSIX
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: <4.0,>=3.9
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: filetype>=1.2.0
+Requires-Dist: deprecation>=2.1.0
+Provides-Extra: yaml-plugin
+Requires-Dist: PyYAML>=6.0.2; extra == "yaml-plugin"
+Provides-Extra: art-plugin
+Requires-Dist: Pillow>=11.2.1; extra == "art-plugin"
+Requires-Dist: pylast>=5.5.0; extra == "art-plugin"
+Requires-Dist: requests>=2.32.3; extra == "art-plugin"
+Provides-Extra: test
+Requires-Dist: pytest>=8.3.5; extra == "test"
+Requires-Dist: coverage>=7.8.0; extra == "test"
+Requires-Dist: tox>=4.25.0; extra == "test"
+Requires-Dist: factory-boy>=3.3.3; extra == "test"
+Requires-Dist: pytest-cov>=6.1.1; extra == "test"
+Requires-Dist: check-manifest>=0.50; extra == "test"
+Requires-Dist: flake8>=7.2.0; extra == "test"
+Provides-Extra: dev
+Requires-Dist: twine>=6.1.0; extra == "dev"
+Requires-Dist: Sphinx>=7.4.7; extra == "dev"
+Requires-Dist: sphinx-rtd-theme>=3.0.2; extra == "dev"
+Requires-Dist: sphinx-issues>=5.0.1; extra == "dev"
+Requires-Dist: cogapp>=3.4.1; extra == "dev"
+Requires-Dist: Paver>=1.3.4; extra == "dev"
+Requires-Dist: nicfit-py[cookiecutter]>=0.8.7; extra == "dev"
+Requires-Dist: regarding>=0.2.0; extra == "dev"
+Dynamic: license-file
+
+Status
+------
+.. image:: https://img.shields.io/pypi/v/eyeD3.svg
+   :target: https://pypi.python.org/pypi/eyeD3/
+   :alt: Latest Version
+.. image:: https://img.shields.io/pypi/l/eyeD3.svg
+   :target: https://pypi.python.org/pypi/eyeD3/
+   :alt: License
+.. image:: https://img.shields.io/pypi/pyversions/eyeD3.svg
+   :target: https://pypi.python.org/pypi/eyeD3/
+   :alt: Supported Python versions
+.. image:: https://img.shields.io/pypi/dm/eyeD3
+   :alt: PyPI - Downloads
+.. image:: https://img.shields.io/github/stars/nicfit/eyeD3
+   :alt: GitHub Repo stars
+
+
+About
+-----
+eyeD3_ is a Python tool for working with audio files, specifically MP3 files
+containing ID3_ metadata (i.e. song info).
+
+It provides a command-line tool (``eyeD3``) and a Python library
+(``import eyed3``) that can be used to write your own applications or
+plugins that are callable from the command-line tool.
+
+For example, to set some song information in an mp3 file called
+``song.mp3``::
+
+  $ eyeD3 -a Integrity -A "Humanity Is The Devil" -t "Hollow" -n 2 song.mp3
+
+With this command we've set the artist (``-a/--artist``), album
+(``-A/--album``), title (``-t/--title``), and track number
+(``-n/--track-num``) properties in the ID3 tag of the file. This is the
+standard interface that eyeD3 has always had in the past, therefore it
+is also the default plugin when no other is specified.
+
+The results of this command can be seen by running the ``eyeD3`` with no
+options.
+
+::
+
+  $ eyeD3 song.mp3
+  song.mp3	[ 3.06 MB ]
+  -------------------------------------------------------------------------
+  ID3 v2.4:
+  title: Hollow
+  artist: Integrity
+  album: Humanity Is The Devil
+  album artist: None
+  track: 2
+  -------------------------------------------------------------------------
+
+The same can be accomplished using Python.
+
+::
+
+  import eyed3
+
+  audiofile = eyed3.load("song.mp3")
+  audiofile.tag.artist = "Token Entry"
+  audiofile.tag.album = "Free For All Comp LP"
+  audiofile.tag.album_artist = "Various Artists"
+  audiofile.tag.title = "The Edge"
+  audiofile.tag.track_num = 3
+
+  audiofile.tag.save()
+
+eyeD3_ is written and maintained by `Travis Shirk`_ and is licensed under
+version 3 of the GPL_.
+
+Features
+--------
+
+* Python package (`import eyed3`) for writing applications and plugins.
+* `eyeD3` : Command-line tool driver script that supports plugins.
+* Easy ID3 editing/viewing of audio metadata from the command-line.
+* Plugins for: Tag to string formatting (display), album fixing (fixup),
+  cover art downloading (art), collection stats (stats),
+  and json/yaml/jabber/nfo output formats, and more included.
+* Support for ID3 versions 1.x, 2.2 (read-only), 2.3, and 2.4.
+* Support for the MP3 audio format exposing details such as play time, bit
+  rate, sampling frequency, etc.
+* Abstract design allowing future support for different audio formats and
+  metadata containers.
+
+Get Started
+-----------
+
+Python >= 3.9 is required.
+
+For `installation instructions`_ or more complete `documentation`_ see
+http://eyeD3.nicfit.net/
+
+Please post feedback and/or defects on the `issue tracker`_, or `mailing list`_.
+
+.. _eyeD3: http://eyeD3.nicfit.net/
+.. _Travis Shirk: travis@pobox.com
+.. _issue tracker: https://github.com/nicfit/eyeD3/issues
+.. _mailing list: https://groups.google.com/forum/?fromgroups#!forum/eyed3-users
+.. _installation instructions: http://eyeD3.nicfit.net/index.html#installation
+.. _documentation: http://eyeD3.nicfit.net/index.html#documentation
+.. _GPL: http://www.gnu.org/licenses/gpl-2.0.html
+.. _ID3: http://id3.org/
+