From ca7421951fc5b17d2a3c1e817d8f138b86560cc8 Mon Sep 17 00:00:00 2001 From: Kevin Montag Date: Tue, 2 Jul 2024 14:58:27 +0200 Subject: [PATCH] refactor: rename to alpax (#3) --- CHANGELOG.md | 44 ++++++++++++------------ README.md | 14 ++++---- pyproject.toml | 22 ++++++------ src/{alpacks => alpax}/__about__.py | 0 src/{alpacks => alpax}/__init__.py | 0 tests/{test_alpacks.py => test_alpax.py} | 6 ++-- 6 files changed, 43 insertions(+), 43 deletions(-) rename src/{alpacks => alpax}/__about__.py (100%) rename src/{alpacks => alpax}/__init__.py (100%) rename tests/{test_alpacks.py => test_alpax.py} (93%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0867325..71ccdb0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,56 +4,56 @@ ### Build -* build: fix detection of semantic release output ([`6b78cfd`](https://github.com/kmontag/alpacks/commit/6b78cfdf7fc482f246c34352b9c972f104dd2d56)) +- build: fix detection of semantic release output ([`6b78cfd`](https://github.com/kmontag/alpax/commit/6b78cfdf7fc482f246c34352b9c972f104dd2d56)) -* build: install hatch during semantic release execution ([`e3ee436`](https://github.com/kmontag/alpacks/commit/e3ee4363122fbec47283bf8812742ffa32a3bdd0)) +- build: install hatch during semantic release execution ([`e3ee436`](https://github.com/kmontag/alpax/commit/e3ee4363122fbec47283bf8812742ffa32a3bdd0)) -* build: update semantic release build command ([`bbc20df`](https://github.com/kmontag/alpacks/commit/bbc20df150279d3055651952c7692344e16870e5)) +- build: update semantic release build command ([`bbc20df`](https://github.com/kmontag/alpax/commit/bbc20df150279d3055651952c7692344e16870e5)) -* build: use standard actions for PyPi and GitHub Releases publish ([`c73227d`](https://github.com/kmontag/alpacks/commit/c73227d3a8f9a2c20ce8a31fa35cd12fdcd950e1)) +- build: use standard actions for PyPi and GitHub Releases publish ([`c73227d`](https://github.com/kmontag/alpax/commit/c73227d3a8f9a2c20ce8a31fa35cd12fdcd950e1)) ### Chore -* chore: fixes in semantic release workflow ([`a145bbe`](https://github.com/kmontag/alpacks/commit/a145bbe583c4fa0dd252561b8c635e0a23edf2c5)) +- chore: fixes in semantic release workflow ([`a145bbe`](https://github.com/kmontag/alpax/commit/a145bbe583c4fa0dd252561b8c635e0a23edf2c5)) -* chore: update fetch depth in semantic release action ([`dfdd7f6`](https://github.com/kmontag/alpacks/commit/dfdd7f69d4d10762b469182a7ed3f0b363a37fb2)) +- chore: update fetch depth in semantic release action ([`dfdd7f6`](https://github.com/kmontag/alpax/commit/dfdd7f69d4d10762b469182a7ed3f0b363a37fb2)) ### Documentation -* docs: fix github actions badge ([`c6fb7bf`](https://github.com/kmontag/alpacks/commit/c6fb7bf525ce1bce72a21f56c794edfc7359fe87)) +- docs: fix github actions badge ([`c6fb7bf`](https://github.com/kmontag/alpax/commit/c6fb7bf525ce1bce72a21f56c794edfc7359fe87)) ### Refactor -* refactor: add semantic release and PyPi upload (#2) ([`be088ec`](https://github.com/kmontag/alpacks/commit/be088eceed561ffe7c7a6ceca828682d719224ee)) +- refactor: add semantic release and PyPi upload (#2) ([`be088ec`](https://github.com/kmontag/alpax/commit/be088eceed561ffe7c7a6ceca828682d719224ee)) ## v0.0.1 (2024-07-02) ### Unknown -* v0.0.1 ([`11f9beb`](https://github.com/kmontag/alpacks/commit/11f9beb244c5ec65004befec4807fc5cd09eee57)) +- v0.0.1 ([`11f9beb`](https://github.com/kmontag/alpax/commit/11f9beb244c5ec65004befec4807fc5cd09eee57)) -* Add github workflows (#1) +- Add github workflows (#1) -* Add github workflow for testing/linting +- Add github workflow for testing/linting -* Change test command +- Change test command -* Drop python 3.8, fixes for pre-3.12 versions +- Drop python 3.8, fixes for pre-3.12 versions -* Remove Tuple import +- Remove Tuple import -* Rename workflow file, add badge to README ([`f06e324`](https://github.com/kmontag/alpacks/commit/f06e3240660f604c810676c686445c97e83bd997)) +- Rename workflow file, add badge to README ([`f06e324`](https://github.com/kmontag/alpax/commit/f06e3240660f604c810676c686445c97e83bd997)) -* Linter fixes ([`258e7f0`](https://github.com/kmontag/alpacks/commit/258e7f0bc70c8a10e363189ca50806a534d60e42)) +- Linter fixes ([`258e7f0`](https://github.com/kmontag/alpax/commit/258e7f0bc70c8a10e363189ca50806a534d60e42)) -* Bump version ([`bc7d608`](https://github.com/kmontag/alpacks/commit/bc7d608d205f04143f9613067431947f28d6a782)) +- Bump version ([`bc7d608`](https://github.com/kmontag/alpax/commit/bc7d608d205f04143f9613067431947f28d6a782)) -* Fix errors when writing async packs ([`5d4d461`](https://github.com/kmontag/alpacks/commit/5d4d461beccd879a164c7615d846c6d14de4e5d2)) +- Fix errors when writing async packs ([`5d4d461`](https://github.com/kmontag/alpax/commit/5d4d461beccd879a164c7615d846c6d14de4e5d2)) -* Change package name again, needs to differ sufficiently from 'alpacka' ([`e39bfcd`](https://github.com/kmontag/alpacks/commit/e39bfcd7c59180fd03c48db59d23dce29eaf0b29)) +- Change package name again, needs to differ sufficiently from 'alpacka' ([`e39bfcd`](https://github.com/kmontag/alpax/commit/e39bfcd7c59180fd03c48db59d23dce29eaf0b29)) -* Ignore build artifacts ([`ad8e5bf`](https://github.com/kmontag/alpacks/commit/ad8e5bf870cdd5946e7fa2913b18fdd3b4262e23)) +- Ignore build artifacts ([`ad8e5bf`](https://github.com/kmontag/alpax/commit/ad8e5bf870cdd5946e7fa2913b18fdd3b4262e23)) -* Change package name, the original is taken ([`2b713e7`](https://github.com/kmontag/alpacks/commit/2b713e7bab13f80edd782caff7f01312aa648907)) +- Change package name, the original is taken ([`2b713e7`](https://github.com/kmontag/alpax/commit/2b713e7bab13f80edd782caff7f01312aa648907)) -* Initial commit ([`8ab60af`](https://github.com/kmontag/alpacks/commit/8ab60af515761bf4bb29bb74c677f025294dc2e5)) +- Initial commit ([`8ab60af`](https://github.com/kmontag/alpax/commit/8ab60af515761bf4bb29bb74c677f025294dc2e5)) diff --git a/README.md b/README.md index 44ac72e..5090256 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# alpacks +# alpax -[![PyPI - Version](https://img.shields.io/pypi/v/alpacks.svg)](https://pypi.org/project/alpacks) -![Test & Release](https://github.com/kmontag/alpacks/actions/workflows/test_and_release.yml/badge.svg?branch=main) +[![PyPI - Version](https://img.shields.io/pypi/v/alpax.svg)](https://pypi.org/project/alpax) +![Test & Release](https://github.com/kmontag/alpax/actions/workflows/test_and_release.yml/badge.svg?branch=main) --- -`alpacks` allows you to generate custom Ableton Live packs. It supports +`alpax` allows you to generate custom Ableton Live packs. It supports adding audio previews and Live 12 tags to the pack content. Currently, only directory-based packs can be created - **generating @@ -21,13 +21,13 @@ you run into trouble._ ## Installation ```console -pip install alpacks +pip install alpax ``` ## Usage ```python -from alpacks import DirectoryPackWriter +from alpax import DirectoryPackWriter from time import time with DirectoryPackWriter( @@ -50,7 +50,7 @@ An async variant is also available: ```python import asyncio -from alpacks import DirectoryPackWriterAsync +from alpax import DirectoryPackWriterAsync from time import time async def run(): diff --git a/pyproject.toml b/pyproject.toml index 605f073..0f3e362 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ requires = ["hatchling"] build-backend = "hatchling.build" [project] -name = "alpacks" +name = "alpax" dynamic = ["version"] description = 'Generate custom Ableton Live packs' readme = "README.md" @@ -26,12 +26,12 @@ classifiers = [ dependencies = [] [project.urls] -Documentation = "https://github.com/kmontag/alpacks#readme" -Issues = "https://github.com/kmontag/alpacks/issues" -Source = "https://github.com/kmontag/alpacks" +Documentation = "https://github.com/kmontag/alpax#readme" +Issues = "https://github.com/kmontag/alpax/issues" +Source = "https://github.com/kmontag/alpax" [tool.hatch.version] -path = "src/alpacks/__about__.py" +path = "src/alpax/__about__.py" # [tool.hatch.envs.hatch-test] # extra-dependencies = [ @@ -43,19 +43,19 @@ extra-dependencies = [ "mypy>=1.0.0", ] [tool.hatch.envs.types.scripts] -check = "mypy --install-types --non-interactive {args:src/alpacks tests}" +check = "mypy --install-types --non-interactive {args:src/alpax tests}" [tool.coverage.run] -source_pkgs = ["alpacks", "tests"] +source_pkgs = ["alpax", "tests"] branch = true parallel = true omit = [ - "src/alpacks/__about__.py", + "src/alpax/__about__.py", ] [tool.coverage.paths] -alpacks = ["src/alpacks", "*/alpacks/src/alpacks"] -tests = ["tests", "*/alpacks/tests"] +alpax = ["src/alpax", "*/alpax/src/alpax"] +tests = ["tests", "*/alpax/tests"] [tool.coverage.report] exclude_lines = [ @@ -92,7 +92,7 @@ major_on_zero = true allow_zero_version = true no_git_verify = false tag_format = "v{version}" -version_variables = ["src/alpacks/__about__.py:__version__"] +version_variables = ["src/alpax/__about__.py:__version__"] [tool.semantic_release.branches.main] match = "main" diff --git a/src/alpacks/__about__.py b/src/alpax/__about__.py similarity index 100% rename from src/alpacks/__about__.py rename to src/alpax/__about__.py diff --git a/src/alpacks/__init__.py b/src/alpax/__init__.py similarity index 100% rename from src/alpacks/__init__.py rename to src/alpax/__init__.py diff --git a/tests/test_alpacks.py b/tests/test_alpax.py similarity index 93% rename from tests/test_alpacks.py rename to tests/test_alpax.py index c824924..0ac22c5 100644 --- a/tests/test_alpacks.py +++ b/tests/test_alpax.py @@ -2,7 +2,7 @@ import os import tempfile -import alpacks +import alpax def test_directory() -> None: @@ -11,7 +11,7 @@ def test_directory() -> None: with tempfile.TemporaryDirectory() as output_dir: path = "test.txt" version = "2.3.4" - with alpacks.DirectoryPackWriter( + with alpax.DirectoryPackWriter( output_dir, name=name, unique_id=unique_id, @@ -55,7 +55,7 @@ def test_simple_directory_async() -> None: with tempfile.TemporaryDirectory() as output_dir: async def run() -> None: - async with alpacks.DirectoryPackWriterAsync(output_dir, name="Test", unique_id="test.id") as pack_writer: + async with alpax.DirectoryPackWriterAsync(output_dir, name="Test", unique_id="test.id") as pack_writer: # Simple test, just make sure the write can happen # without errors. await pack_writer.set_file_content("path.adg", b"content")