From 23c14893a22b2beefc42c97e68d8fc7c1aa036d0 Mon Sep 17 00:00:00 2001 From: Antonio War Date: Sat, 27 Apr 2024 17:34:10 +0200 Subject: [PATCH 1/7] refactor: change license to MIT --- LICENSE.md | 222 +++++------------------------------------------------ 1 file changed, 21 insertions(+), 201 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index 261eeb9..c72abf8 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,201 +1,21 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. +The MIT License (MIT) + +Copyright (c) 2023 SwiftyGPT + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. From da993cf29173f19d2cd160bb4f7d96591948f459 Mon Sep 17 00:00:00 2001 From: Antonio War Date: Sat, 27 Apr 2024 17:34:19 +0200 Subject: [PATCH 2/7] build: remove unused workspace --- .github/workflows/build_and_test.yml | 20 -------------------- 1 file changed, 20 deletions(-) delete mode 100644 .github/workflows/build_and_test.yml diff --git a/.github/workflows/build_and_test.yml b/.github/workflows/build_and_test.yml deleted file mode 100644 index 106af85..0000000 --- a/.github/workflows/build_and_test.yml +++ /dev/null @@ -1,20 +0,0 @@ -# This workflow will build a Swift project -# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-swift - -name: Build & Test - -on: - push: - branches: [ "develop" ] - pull_request: - branches: [ "develop" ] - -jobs: - build: - runs-on: macos-latest - steps: - - uses: actions/checkout@v3 - - name: Build - run: swift build -v - - name: Test - run: swift test -v From 1659c8c5f5df33b1f9bfdb9a994de2adba6619bb Mon Sep 17 00:00:00 2001 From: Antonio Guerra <59933379+antonio-war@users.noreply.github.com> Date: Sat, 27 Apr 2024 18:01:59 +0200 Subject: [PATCH 3/7] Update README.md --- README.md | 68 +++++-------------------------------------------------- 1 file changed, 6 insertions(+), 62 deletions(-) diff --git a/README.md b/README.md index b081dcb..7e74650 100644 --- a/README.md +++ b/README.md @@ -2,67 +2,11 @@

-[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fantonio-war%2FSwiftyGPT%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/antonio-war/SwiftyGPT) [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fantonio-war%2FSwiftyGPT%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/antonio-war/SwiftyGPT) +[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fantonio-war%2FSwiftyGPT%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/antonio-war/SwiftyGPT) -SwiftyGPT is a simple and lightweight wrapper around OpenAI API which exposes services provided by ChatGPT and DALL-E. -It was born with the aim of provide a Swift like interface around all OpenAI capabilities, so you can make requestes and get responses with minimal coding effort. - -- **Easy to use:** no configuration needed, SwiftyGPT is ready to go, you just need an API Key. -- **Configurable:** you can choose some parameters like model, temperature or just use default values. -- **SwiftUI compatible:** provides an elegant SwiftUI support that is very easy to use. - ---- - -# Installation - -You can use Swift Package Manager to add SwiftyGPT to your project. - -## Add Package Dependency - -In Xcode, select File > Add Packages... - -## Specify the Repository - -Copy and paste the following into the search/input box. - -https://github.com/antonio-war/SwiftyGPT - -## Specify options - -Use **Up to Next Major Version** as dependency rule and enter the current SwiftyGPT version. -Then click **Add Package**. - ---- - -# Setting Up - -The first step to using SwiftyGPT is to create an instance, you an use the same to access all features. - -```swift -let swiftyGPT = SwiftyGPT(apiKey: "YOUR_API_KEY") -``` ---- - -# Features -- [**Chat**](Documentation/CHAT.md) -- [**Completion**](Documentation/COMPLETION.md) -- [**Image Generation**](Documentation/IMAGE.md) -- [**Grammar Correction**](Documentation/CORRECTION.md) -- [**Language Translation**](Documentation/TRANSLATION.md) -- [**Sentiment Analysis**](Documentation/SENTIMENT.md) -- [**Text Summary**](Documentation/SUMMARY.md) ---- - -# Error Handling - -In case of failure methods return an error, it can be a system error in case something went wrong on the iOS side. For example, network-level issues or decoding issues. If instead the error is related to ChatGPT you will get a SwiftyGPTError. - -```swift -if let error = error as? SwiftyGPTError { - print(error.message) -} -``` ---- -# License -SwiftyGPT is published under the Apache 2.0 license. +SwiftyGPT is an unofficial, lightweight and user-friendly Swift wrapper for accessing [OpenAI API](https://platform.openai.com/docs/api-reference).
+Designed with simplicity and ease of use in mind, SwiftyGPT eliminates the need for extensive configuration, making it ready to use right out of the box—all you need is your API Key.
+With SwiftyGPT, customization is at your fingertips. Whether you want to fine-tune parameters like model selection, temperature, or simply rely on default values, SwiftyGPT offers flexibility to suit your needs.
+Not just functional but elegant, SwiftyGPT proves a smooth and intuitive user experience.
+Say goodbye to cumbersome coding and hello to effortless interaction with OpenAI's capabilities!
From 896d065e10bc7958a9ae96395ff98c4f990d9d42 Mon Sep 17 00:00:00 2001 From: Antonio Guerra <59933379+antonio-war@users.noreply.github.com> Date: Sat, 27 Apr 2024 18:13:42 +0200 Subject: [PATCH 4/7] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 7e74650..8ce232e 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,7 @@ Designed with simplicity and ease of use in mind, SwiftyGPT eliminates the need With SwiftyGPT, customization is at your fingertips. Whether you want to fine-tune parameters like model selection, temperature, or simply rely on default values, SwiftyGPT offers flexibility to suit your needs.
Not just functional but elegant, SwiftyGPT proves a smooth and intuitive user experience.
Say goodbye to cumbersome coding and hello to effortless interaction with OpenAI's capabilities!
+ +--- +# License +SwiftyGPT is published under the MIT license. From eb8395472dad83ca4f96c41e5bd6d80cd74a447e Mon Sep 17 00:00:00 2001 From: Antonio Guerra <59933379+antonio-war@users.noreply.github.com> Date: Sat, 27 Apr 2024 18:33:27 +0200 Subject: [PATCH 5/7] Update README.md --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8ce232e..ec7cac6 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,23 @@ [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fantonio-war%2FSwiftyGPT%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/antonio-war/SwiftyGPT) [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fantonio-war%2FSwiftyGPT%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/antonio-war/SwiftyGPT) -SwiftyGPT is an unofficial, lightweight and user-friendly Swift wrapper for accessing [OpenAI API](https://platform.openai.com/docs/api-reference).
+SwiftyGPT is an **unofficial**, lightweight and user-friendly Swift wrapper for accessing [OpenAI API](https://platform.openai.com/docs/api-reference).
Designed with simplicity and ease of use in mind, SwiftyGPT eliminates the need for extensive configuration, making it ready to use right out of the box—all you need is your API Key.
With SwiftyGPT, customization is at your fingertips. Whether you want to fine-tune parameters like model selection, temperature, or simply rely on default values, SwiftyGPT offers flexibility to suit your needs.
Not just functional but elegant, SwiftyGPT proves a smooth and intuitive user experience.
Say goodbye to cumbersome coding and hello to effortless interaction with OpenAI's capabilities!
+--- +# Support the Project +Your generous donations help sustain and improve this project. Here's why supporting us is important: +1. **Covering API Costs**: Accessing certain features or services may require a paid API key. Your donations help cover the cost of maintaining these subscriptions, ensuring uninterrupted access to essential functionalities. +2. **Development and Maintenance**: Donations enable us to dedicate more time and resources to developing new features, fixing bugs, and maintaining the project's overall health. Your support directly contributes to the project's ongoing improvement and sustainability. +3. **Community Support**: Your contributions show your support for the project and help foster a thriving community around it. Your generosity motivates us to keep pushing the project forward and encourages others to join the cause. +4. **Open Source Sustainability**: By supporting open-source projects like ours, you're contributing to the sustainability of the entire open-source ecosystem. Your donations help ensure that valuable projects remain accessible to everyone. + +Every donation, no matter how small, makes a big difference. Thank you for considering supporting us!

+Buy Me A Coffee + --- # License SwiftyGPT is published under the MIT license. From adf67f8d60ecf856ef193e90a9c106620a8dae5c Mon Sep 17 00:00:00 2001 From: Antonio Guerra <59933379+antonio-war@users.noreply.github.com> Date: Sat, 27 Apr 2024 18:53:24 +0200 Subject: [PATCH 6/7] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ec7cac6..43ad5e9 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,11 @@ [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fantonio-war%2FSwiftyGPT%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/antonio-war/SwiftyGPT) [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fantonio-war%2FSwiftyGPT%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/antonio-war/SwiftyGPT) -SwiftyGPT is an **unofficial**, lightweight and user-friendly Swift wrapper for accessing [OpenAI API](https://platform.openai.com/docs/api-reference).
-Designed with simplicity and ease of use in mind, SwiftyGPT eliminates the need for extensive configuration, making it ready to use right out of the box—all you need is your API Key.
-With SwiftyGPT, customization is at your fingertips. Whether you want to fine-tune parameters like model selection, temperature, or simply rely on default values, SwiftyGPT offers flexibility to suit your needs.
-Not just functional but elegant, SwiftyGPT proves a smooth and intuitive user experience.
-Say goodbye to cumbersome coding and hello to effortless interaction with OpenAI's capabilities!
+**SwiftyGPT** is an unofficial, lightweight and user-friendly Swift wrapper for accessing [OpenAI API](https://platform.openai.com/docs/api-reference). +- **Simple**: Designed with simplicity and ease of use in mind, SwiftyGPT eliminates the need for extensive configuration, making it ready to use right out of the box, all you need is your API Key! Say goodbye to cumbersome coding and hello to effortless interaction with OpenAI's capabilities! +- **Customizable**: Whether you want to fine-tune parameters like model selection, adjust temperature, or rely on default values, SwiftyGPT offers flexibility to suit your needs. +- **Modular**: SwiftyGPT is divided into modules, utilizing a different target for each feature exposed by the API. Import only the code that you really need, keeping your project lightweight and efficient. +- **Mockable**: SwiftyGPT employs protocol-oriented programming to guarantee testability and maintainability. It already exposes some mock objects that can be seamlessly utilized in testing or SwiftUI previews, eliminating the need for actual API calls. --- # Support the Project From 6c99b5ebe750aa9e4a7f74af3a09472482b43b08 Mon Sep 17 00:00:00 2001 From: Antonio Guerra <59933379+antonio-war@users.noreply.github.com> Date: Sat, 27 Apr 2024 19:04:47 +0200 Subject: [PATCH 7/7] Update README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 43ad5e9..4715cc8 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,21 @@ - **Modular**: SwiftyGPT is divided into modules, utilizing a different target for each feature exposed by the API. Import only the code that you really need, keeping your project lightweight and efficient. - **Mockable**: SwiftyGPT employs protocol-oriented programming to guarantee testability and maintainability. It already exposes some mock objects that can be seamlessly utilized in testing or SwiftUI previews, eliminating the need for actual API calls. +--- +# Recommendations + +To ensure security and flexibility, we recommend loading your OpenAI API key using environment variables instead of hardcoding it directly into your source code. This approach offers several advantages: +- **Security**: Storing sensitive information like API keys in environment variables helps prevent accidental exposure of credentials, reducing the risk of unauthorized access to your API resources. +- **Flexibility**: By using environment variables, you can easily switch between different API keys or update them without modifying your code. This flexibility is especially useful in development, testing, and deployment scenarios. +- **Best Practice**: Utilizing environment variables for configuration is considered a best practice in software development, promoting cleaner and more maintainable codebases. + +Here's a simple example of how you can load your OpenAI API key from an environment variable in Swift: +```swift +guard let apiKey = ProcessInfo.processInfo.environment["OPENAI_API_KEY"] else { + fatalError("Missing OpenAI API key. Please set the OPENAI_API_KEY environment variable.") +} +``` + --- # Support the Project Your generous donations help sustain and improve this project. Here's why supporting us is important: