From aeb4de6c8973cfa8667c8a2e8bbf11b35976d4b9 Mon Sep 17 00:00:00 2001 From: Abram Date: Wed, 28 Jun 2023 12:49:12 +0100 Subject: [PATCH 1/4] Update: change package homepage url --- setup.cfg | 4 ++-- setup.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/setup.cfg b/setup.cfg index ed58e31..76965c4 100644 --- a/setup.cfg +++ b/setup.cfg @@ -6,9 +6,9 @@ author_email = israelvictory87@gmail.com description = A go-to production API response with an easy format for building APIs with Python. long_description = file: README.md long_description_content_type = text/markdown -url = https://github.com/israelabraham/api-response +url = https://github.com/aybruhm/api-response project_urls = - Bug Tracker = https://github.com/israelabraham/api-response/issues + Bug Tracker = https://github.com/aybruhm/api-response/issues classifiers = Development Status :: 5 - Production/Stable Intended Audience :: Education diff --git a/setup.py b/setup.py index 9e8f03d..231b842 100644 --- a/setup.py +++ b/setup.py @@ -14,7 +14,7 @@ description="A go-to production API response with an easy format for building APIs with Python.", # noqa: E501 long_description_content_type="text/markdown", long_description=open("README.md").read(), - url="https://github.com/israelabraham/api-response", + url="https://github.com/aybruhm/api-response", author="Abram", author_email="israelvictory87@gmail.com", license="MIT", From 6585e6546179df262252410b960c5e183a663e14 Mon Sep 17 00:00:00 2001 From: Abram Date: Wed, 28 Jun 2023 12:50:04 +0100 Subject: [PATCH 2/4] Update: formatted code examples --- README.md | 75 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 38 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 1005b4b..694b6b6 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ pip install rest-api-response 2). In the file (.py) that you wish to use it, import it: ```python - from rest_api_response import success_response, error_response +from rest_api_response import success_response, error_response ``` That's pretty much it - you can now call the function and pass the required arguments! @@ -41,23 +41,23 @@ class PostListAPIView(views.APIView): The API response would be: ```json - [ - { - "title": "First blog post", - "content": "Lorem ipsume content", - "author": 1 - }, - { - "title": "Second blog post", - "content": "Lorem ipsume content", - "author": 2 - }, - { - "title": "Third blog post", - "content": "Lorem ipsume content", - "author": 3 - } - ] +[ + { + "title": "First blog post", + "content": "Lorem ipsume content", + "author": 1 + }, + { + "title": "Second blog post", + "content": "Lorem ipsume content", + "author": 2 + }, + { + "title": "Third blog post", + "content": "Lorem ipsume content", + "author": 3 + } +] ``` This works too, but let's take the response to the next level by doing this: @@ -86,26 +86,27 @@ class PostListAPIView(views.APIView): The API response would be: ```json - [ "status": true, - "message": "Posts retrieved!", - "data": [ - { - "title": "First blog post", - "content": "Lorem ipsume content", - "author": 1 - }, - { - "title": "Second blog post", - "content": "Lorem ipsume content", - "author": 2 - }, - { - "title": "Third blog post", - "content": "Lorem ipsume content", - "author": 3 - } - ] +[ + "status": true, + "message": "Posts retrieved!", + "data": [ + { + "title": "First blog post", + "content": "Lorem ipsume content", + "author": 1 + }, + { + "title": "Second blog post", + "content": "Lorem ipsume content", + "author": 2 + }, + { + "title": "Third blog post", + "content": "Lorem ipsume content", + "author": 3 + } ] +] ``` And that's it. You have a nicely catchy response. :-) From a5258f3cfd0a6908c70013e8a2ca0e597d4956ea Mon Sep 17 00:00:00 2001 From: Abram Date: Wed, 28 Jun 2023 12:57:30 +0100 Subject: [PATCH 3/4] Update: bump version to 0.1.1 --- setup.cfg | 2 +- setup.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/setup.cfg b/setup.cfg index 76965c4..95a51c7 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = rest-api-response -version = 0.1 +version = 0.1.1 author = Abram author_email = israelvictory87@gmail.com description = A go-to production API response with an easy format for building APIs with Python. diff --git a/setup.py b/setup.py index 231b842..52dcf2d 100644 --- a/setup.py +++ b/setup.py @@ -10,7 +10,7 @@ setup( name="rest_api_response", - version="0.1", + version="0.1.1", description="A go-to production API response with an easy format for building APIs with Python.", # noqa: E501 long_description_content_type="text/markdown", long_description=open("README.md").read(), From eae2420eb35945f0b195bca677c00e34518a5799 Mon Sep 17 00:00:00 2001 From: Abram Date: Wed, 28 Jun 2023 13:00:54 +0100 Subject: [PATCH 4/4] Update: added 0.1.1 change log --- CHANGELOG.txt | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.txt b/CHANGELOG.txt index d4da856..d40959e 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -48,4 +48,10 @@ Change Log - Modified test cases - Renamed package name, changed description and url - Modified README documentation -- Bump version to 0.1 \ No newline at end of file +- Bump version to 0.1 + +0.1.1 (28/06/2023) +-------------------- +- Modified README documentation +- Bump version to 0.1.1 +- Changed home page url \ No newline at end of file