Changed LICESCE to MIT, frist version of release workflow

.github/workflows/release.yml

@@ -0,0 +1,26 @@
+name: Release
+
+on:
+  push:
+    branches:
+        - main
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    name: Release to PyPI
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Test and Release
+        run: bash package-release.sh
+        env:
+          PYPI_REPOSITORY: ${{ vars.PYPI_REPOSITORY }}
+          PYPI_URL: ${{ vars.PYPI_URL }}
+          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+          GOOGLE_CLOUD_API_KEY: ${{ secrets.GOOGLE_CLOUD_API_KEY }}
+          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
+

.gitignore

@@ -26,3 +26,7 @@ docs/build/
 .vscode
 tmp
 lib
+
+# Tests
+
+package-test

LICENCE

@@ -1,93 +1,7 @@
-Elastic License 2.0
+Copyright 2023 Combinatrix.ai
 
-URL: https://www.elastic.co/licensing/elastic-license
+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:
 
-## Acceptance
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-By using the software, you agree to all of the terms and conditions below.
-
-## Copyright License
-
-The licensor grants you a non-exclusive, royalty-free, worldwide,
-non-sublicensable, non-transferable license to use, copy, distribute, make
-available, and prepare derivative works of the software, in each case subject to
-the limitations and conditions below.
-
-## Limitations
-
-You may not provide the software to third parties as a hosted or managed
-service, where the service provides users with access to any substantial set of
-the features or functionality of the software.
-
-You may not move, change, disable, or circumvent the license key functionality
-in the software, and you may not remove or obscure any functionality in the
-software that is protected by the license key.
-
-You may not alter, remove, or obscure any licensing, copyright, or other notices
-of the licensor in the software. Any use of the licensor’s trademarks is subject
-to applicable law.
-
-## Patents
-
-The licensor grants you a license, under any patent claims the licensor can
-license, or becomes able to license, to make, have made, use, sell, offer for
-sale, import and have imported the software, in each case subject to the
-limitations and conditions in this license. This license does not cover any
-patent claims that you cause to be infringed by modifications or additions to
-the software. If you or your company make any written claim that the software
-infringes or contributes to infringement of any patent, your patent license for
-the software granted under these terms ends immediately. If your company makes
-such a claim, your patent license ends immediately for work on behalf of your
-company.
-
-## Notices
-
-You must ensure that anyone who gets a copy of any part of the software from you
-also gets a copy of these terms.
-
-If you modify the software, you must include in any modified copies of the
-software prominent notices stating that you have modified the software.
-
-## No Other Rights
-
-These terms do not imply any licenses other than those expressly granted in
-these terms.
-
-## Termination
-
-If you use the software in violation of these terms, such use is not licensed,
-and your licenses will automatically terminate. If the licensor provides you
-with a notice of your violation, and you cease all violation of this license no
-later than 30 days after you receive that notice, your licenses will be
-reinstated retroactively. However, if you violate these terms after such
-reinstatement, any additional violation of these terms will cause your licenses
-to terminate automatically and permanently.
-
-## No Liability
-
-*As far as the law allows, the software comes as is, without any warranty or
-condition, and the licensor will not be liable to you for any damages arising
-out of these terms or the use or nature of the software, under any kind of
-legal claim.*
-
-## Definitions
-
-The **licensor** is the entity offering these terms, and the **software** is the
-software the licensor makes available under these terms, including any portion
-of it.
-
-**you** refers to the individual or entity agreeing to these terms.
-
-**your company** is any legal entity, sole proprietorship, or other kind of
-organization that you work for, plus all organizations that have control over,
-are under the control of, or are under common control with that
-organization. **control** means ownership of substantially all the assets of an
-entity, or the power to direct its management and policies by vote, contract, or
-otherwise. Control can be direct or indirect.
-
-**your licenses** are all the licenses granted to you for the software under
-these terms.
-
-**use** means anything you do with the software requiring one of your licenses.
-
-**trademark** means trademarks, service marks, and similar rights.
+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.

README.md

@@ -341,9 +341,7 @@ File an issue if you have any requests!
 
 ## License
 
-- This project is licensed under the [Elastic License 2.0](https://www.elastic.co/licensing/elastic-license).
-  - It's basically you cannot sell a managed service of PromptTrail. Except that, you can use it for free for any purpose.
-  - See [LICENCE](LICENCE) for more details.
+- PromptTrail is licensed under the MIT License.
 
 ## Contributing
 

docs/quickstart-preparation.md

@@ -2,10 +2,9 @@
 
 ## Install
 
-```{Note}
-PromptTrail is currently in alpha. We are working on the first release on PyPI.
-Please use the latest version from GitHub for now.
-```
+``pip install prompttrail``
+
+or install the latest version from the repository:
 
 ``pip install git+https://github.com/combinatrix-ai/PromptTrail.git``
 

package-release.sh

@@ -0,0 +1,35 @@
+# Abort on error
+set -e
+
+# Check if rye is installed
+if ! command -v rye &> /dev/null
+then
+    echo "rye could not be found"
+    echo "Installing rye"
+    curl -sSf https://rye-up.com/get | RYE_INSTALL_OPTION="--yes" bash
+    source "$HOME/.rye/env"
+fi
+
+# Build
+rye build --clean
+
+# Delete old folder if exists
+rm -rf package-test
+
+# Test as newly installed package
+mkdir -p package-test
+cd package-test
+rye init
+rye add --path ../dist/prompttrail-*-py3-none-any.whl prompttrail
+rye add pytest
+rye sync
+./.venv/bin/pytest --log-cli-level=DEBUG ../tests
+cd ..
+
+# Cleanup
+rm -rf package-test
+
+# Release
+rye publish --repository $PYPI_REPOSITORY --repository-url $PYPI_URL --token $PYPI_TOKEN --yes
+
+

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "prompttrail"
 version = "0.1.0"
-description = "Add a short description here"
+description = "A lightweight library for Prompt Programming: Agent as Code"
 authors = [
     { name = "hmirin", email = "[email protected]" }
 ]
@@ -15,9 +15,21 @@ dependencies = [
     "typing_inspect>=0.9.0",
     "anthropic>=0.21.0",
     "typing-inspect>=0.9.0",
+    "jinja2>=3.1.2",
 ]
 readme = "README.md"
 requires-python = ">= 3.11"
+license = "MIT"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.11",
+]
+
+[project.urls]
+Documentation = "https://prompttrail.readthedocs.io"
+Repository = "https://github.com/combinatrix-ai/PromptTrail"
 
 [build-system]
 requires = ["hatchling"]
@@ -32,7 +44,6 @@ dev-dependencies = [
     "autoflake>=2.2.0",
     "pyproject-autoflake>=1.0.2",
     "ipython>=8.14.0",
-    "jinja2>=3.1.2",
     "sphinx>=7.1.1",
     "pylint>=2.17.5",
     "flake8>=6.1.0",