Merge pull request #37 from pganssle/prepare-0.6.0

Prepare 0.6.0
pganssle · Nov 27, 2022 · 1a07c8f · 1a07c8f
2 parents 0741388 + fb5e623
commit 1a07c8f
Show file tree

Hide file tree

Showing 12 changed files with 32 additions and 19 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -24,6 +24,8 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: '3.x'
+    - uses: FedericoCarboni/setup-ffmpeg@v1
+      id: setup-ffmpeg
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -0,0 +1,23 @@
+Version 0.6.0
+=============
+
+- Now available: rendered feeds! This adds alternate feeds for files generated from the files as they exist on disk using ``ffmpeg`` (the generated files go into a media cache on disk and are generated when the RSS feed is downloaded). The available types of feed are:
+
+    - Single file: In single file mode, all input files are merged into one big file, with chapter information if it's available (defaulting to considering each separate file a chapter).
+    - Chapters: If chapter information is available, each chapter is a separate entry in the feed.
+    - Segmented: This assumes that you want files broken up into duration ~60 minutes, and tries to accommodate that as best as possible. The segmenting algorithm recombines the existing files along chapter or file boundaries in such a way as to minimize the overall deviation from "60 minutes per file". It is slightly biased towards longer files, so it will prefer to create 1 90 minute file rather than 2 45 minute files, etc.
+
+  A side-effect of this change is that file metadata is stored in the database now, which will take some time to add when first loading a large number of audiobooks. This also enables us to have chapter information in the RSS feeds.
+
+- Added a test server script for easy manual debugging and testing.
+
+- Changed config directory specification. You can now set the environment variable ``AF_CONFIG_DIR`` to specify exactly where your configuration comes from. Whether or not the current working directory is in the search path is also now context dependent.
+
+- Removed ``schema.yml`` in favor of defining the schema types in ``object_handler.py``
+
+- Updated the ``audio-feeder install`` script to use ``importlib.resources`` and made sure that it can be run a second time to update the install base.
+
+- "Updating database" status now cleared if the database update fails.
+
+- Updated books pagination to consistently use a zero-based index.
+
diff --git a/changelog.d/.keepdir b/changelog.d/.keepdir
diff --git a/changelog.d/add_rendered_feeds.rst b/changelog.d/add_rendered_feeds.rst
diff --git a/changelog.d/add_test_server.rst b/changelog.d/add_test_server.rst
diff --git a/changelog.d/config_dir.rst b/changelog.d/config_dir.rst
diff --git a/changelog.d/schema_types.rst b/changelog.d/schema_types.rst
diff --git a/changelog.d/update_installer.rst b/changelog.d/update_installer.rst
diff --git a/changelog.d/update_status.rst b/changelog.d/update_status.rst
diff --git a/changelog.d/zero_index.rst b/changelog.d/zero_index.rst
diff --git a/pyproject.toml b/pyproject.toml
@@ -11,7 +11,7 @@ authors = [{name = "Paul Ganssle"}]
 description = """
 audio-feeder provides a server that serves your audiobooks and other audio
 content as RSS feeds, with rich metadata, and provides a web frontent for navigation."""
-license = {file = "LICENSE"}
+license = {text = "Apache 2.0"}
 requires-python = ">= 3.9"
 dependencies = [
     "Flask>=0.11.1",
@@ -40,14 +40,15 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
 ]
-dynamic = ["version"]
+dynamic = ["version", "readme"]
 
 [project.scripts]
 audio-feeder = "audio_feeder.cli:cli"
 
 [tool.setuptools]
 packages = {find = {where = ["src"]}}
 package-data = { audio_feeder=["data/**/*"] }
+license-files = ["LICENSE"]
 
 [tool.setuptools.dynamic]
 version = {attr = "audio_feeder.__version__.VERSION"}

diff --git a/src/audio_feeder/__version__.py b/src/audio_feeder/__version__.py
@@ -1,7 +1,7 @@
-VERSION_MAJOR = 0
-VERSION_MINOR = 5
-VERSION_PATCH = 0
+VERSION_MAJOR: int = 0
+VERSION_MINOR: int = 6
+VERSION_PATCH: int = 0
 
 VERSION_TUPLE = (VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH)
 
-VERSION = f"{VERSION_MAJOR}.{VERSION_MINOR}.{VERSION_PATCH}"
+VERSION: str = f"{VERSION_MAJOR}.{VERSION_MINOR}.{VERSION_PATCH}"