From ee5fb36aa5d40f49013eae0d2967a77db5957e02 Mon Sep 17 00:00:00 2001 From: Josh Ventura Date: Tue, 22 Oct 2024 23:09:43 -0400 Subject: [PATCH] Update README. Upload PyPI release artifacts, GitHub workflow artifacts. Yamlet is now available in PyPI through Pip. Also checks in a workflow to hopefully run the tests? --- .github/workflows/test.yml | 19 +++++++++++++++++++ .gitignore | 3 +++ MANIFEST.in | 3 +++ README.md | 8 +++++--- setup.py | 23 +++++++++++++++++++++++ 5 files changed, 53 insertions(+), 3 deletions(-) create mode 100644 .github/workflows/test.yml create mode 100644 MANIFEST.in create mode 100644 setup.py diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..450ccb1 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,19 @@ +name: Run Tests + +on: [push, pull_request] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: '3.x' + - name: Install dependencies + run: pip install ruamel-yaml + - name: Run tests + run: python3 tests.py + env: + yamlet_stress: full diff --git a/.gitignore b/.gitignore index bee8a64..5db29c5 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,4 @@ __pycache__ +/dist/ +/yamlet.egg-info/ +Yamlet.geanyproj diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..820ec6c --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,3 @@ +include yamlet.py +include README.md +include LICENSE diff --git a/README.md b/README.md index fac242a..bb2805f 100644 --- a/README.md +++ b/README.md @@ -61,10 +61,12 @@ for when someone inevitably forgets or doesn't read this. ## Installation -Yamlet is not currently available on Pip. It is a single Python file; you may -copy it into your project wherever you like. +```bash +pip install yamlet +``` -I will attempt to publish to PyPI sooner or later. +Yamlet is a single Python file; you may also just copy `yamlet.py` into your +project wherever you like. ## Features diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..2528ffb --- /dev/null +++ b/setup.py @@ -0,0 +1,23 @@ +from setuptools import setup, find_packages + +at, g_mail = '@', 'gmail.com' +setup( + name="yamlet", + version="0.0.1.1", + author="Josh Ventura", + author_email=f"JoshV{10}{at}{g_mail}", + description="A GCL-like templating engine for YAML", + long_description=open('README.md').read(), + long_description_content_type='text/markdown', + url="https://github.com/JoshDreamland/Yamlet", + py_modules=["yamlet"], + classifiers=[ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: MIT License", + "Operating System :: OS Independent", + ], + python_requires='>=3.6', + install_requires=[ + 'ruamel.yaml>=0.17.0', + ], +)