Skip to content

Commit

Permalink
Update README. Upload PyPI release artifacts, GitHub workflow artifacts.
Browse files Browse the repository at this point in the history
Yamlet is now available in PyPI through Pip.

Also checks in a workflow to hopefully run the tests?
  • Loading branch information
JoshDreamland committed Oct 23, 2024
1 parent c2e6120 commit ee5fb36
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 3 deletions.
19 changes: 19 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
__pycache__
/dist/
/yamlet.egg-info/
Yamlet.geanyproj
3 changes: 3 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
include yamlet.py
include README.md
include LICENSE
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
23 changes: 23 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -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',
],
)

0 comments on commit ee5fb36

Please sign in to comment.