From 34f6753c8d5ec0bbf83805f331370669123a2b36 Mon Sep 17 00:00:00 2001 From: Kutu Date: Sun, 2 Jun 2024 23:46:09 +0200 Subject: [PATCH] Add PyPI metadata --- CHANGELOG.md | 3 +++ README.md | 10 +++++++++- TODO.md | 6 ------ docs/changelog.md | 1 + mkdocs.yml | 2 ++ pyproject.toml | 36 +++++++++++++++++++++++++++++++++++- tests/api/test_browsing.py | 2 -- tests/conftest.py | 5 ----- 8 files changed, 50 insertions(+), 15 deletions(-) delete mode 100644 TODO.md create mode 100644 docs/changelog.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 0fb0894..a40a667 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,7 @@ # Changelog +## 0.2.0 +- PyPI automatic upload with GitHub release test. + ## 0.1.0 - PyPI automatic CI update upload test. diff --git a/README.md b/README.md index 4d29905..c92fe8e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,13 @@ +
# Knuckles -> A [OpenSubsonic](https://opensubsonic.netlify.app/) API wrapper for Python 3.11.0+. + +![PyPI - Version](https://img.shields.io/pypi/v/knuckles) +![PyPI - Python Version](https://img.shields.io/pypi/pyversions/knuckles) +![GitHub Actions - PyPI Publishing](https://github.com/kutu-dev/knuckles/actions/workflows/publish.yml/badge.svg) +![GitHub Actions - Docs Deploying](https://github.com/kutu-dev/knuckles/actions/workflows/docs.yml/badge.svg) + +An unopinionated [OpenSubsonic](https://opensubsonic.netlify.app/) API wrapper for Python. +
## Compatiblity Knuckles **only** works with servers compatible with the REST API version 1.4.0 onwards (Subsonic 4.2+). diff --git a/TODO.md b/TODO.md deleted file mode 100644 index e9c91cc..0000000 --- a/TODO.md +++ /dev/null @@ -1,6 +0,0 @@ -# TODO - -- [ ] Remove prints. -- [ ] Make the README.md more beautiful. -- [ ] Add tags to PyPI -- [ ] Release the `1.0.0`. diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 0000000..786b75d --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1 @@ +--8<-- "CHANGELOG.md" diff --git a/mkdocs.yml b/mkdocs.yml index 3f76378..f329983 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -40,6 +40,7 @@ nav: - Home: Getting Started: "index.md" Contributing: "contributing.md" + Changelog: "changelog.md" - Reference: "reference/" plugins: @@ -69,3 +70,4 @@ markdown_extensions: - pymdownx.snippets - pymdownx.emoji - admonition + - md_in_html diff --git a/pyproject.toml b/pyproject.toml index be60338..045dc53 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -2,13 +2,47 @@ name = "knuckles" description = "A Subsonic/OpenSubsonic API wrapper for Python." requires-python = ">=3.11.0" + dependencies = [ "requests>=2.32.3", "python-dateutil>=2.8.2" ] -version = "0.1.0" + +version = "0.2.0" readme = "README.md" +authors = [ + {name = 'Jorge "Kutu" Dobón Blanco', email="code@dobon.dev"} +] + +keywords = [ + "api-wrapper", + "api", + "wrapper", + "library", + "subsonic", + "opensubsonic", +] + +classifiers = [ + "Development Status :: 5 - Production/Stable", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Environment :: Web Environment", + "Operating System :: OS Independent", + "Topic :: Internet", + "Topic :: Internet :: WWW/HTTP", + "Topic :: Multimedia", + "Topic :: Software Development :: Libraries", + "Topic :: Software Development :: Libraries :: Python Modules", + "Typing :: Typed", +] + [project.optional-dependencies] dev = [ "pip-tools>=7.4.1", diff --git a/tests/api/test_browsing.py b/tests/api/test_browsing.py index 2657773..d5ba9fa 100644 --- a/tests/api/test_browsing.py +++ b/tests/api/test_browsing.py @@ -38,8 +38,6 @@ def test_get_artist_indexes( music_folders[0]["id"], modified_date ) - print(response.index) - assert response.ignored_articles == indexes["ignoredArticles"] assert isinstance(response.index, dict) assert ( diff --git a/tests/conftest.py b/tests/conftest.py index b1b3fca..3fceb6a 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -128,9 +128,6 @@ def inner( decoded_post_body[key] = value[0] - print(f"{mocked_params=}") - print(f"{decoded_post_body=}") - if mocked_params != decoded_post_body: return False, ( "Mismatch data between the request POST body and " @@ -160,8 +157,6 @@ def inner( if extra_params is not None: mocked_params.update(extra_params) - print("CC", extra_params) - mocked_data = {"subsonic-response": {**subsonic_response}} if extra_data is not None: mocked_data["subsonic-response"].update(extra_data)