From e3268c79b40e6ea6b98e92b6be1f820ebc17ee3e Mon Sep 17 00:00:00 2001 From: ImShyMike <122023566+ImShyMike@users.noreply.github.com> Date: Wed, 18 Dec 2024 22:54:18 +0000 Subject: [PATCH] README + cmd entrypoint + bump version --- README.md | 31 ++++++++++++++++++++++++++++++- eryx/__init__.py | 2 +- eryx/__main__.py | 2 -- setup.cfg | 11 ++++++++++- 4 files changed, 41 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2ceaaa4..721b020 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ # Eryx - A decently fast simple dynamically typed programming language similar to javascript/python. +[![License](https://img.shields.io/pypi/l/Eryx)](/LICENSE) +[![PyPI](https://img.shields.io/pypi/v/Eryx)][pypi_url] +[![Build Status](https://img.shields.io/github/actions/workflow/status/ImShyMike/Eryx/ci.yml)](https://github.com/ImShyMike/Eryx/actions) +[![Python Version](https://img.shields.io/pypi/pyversions/Eryx)][pypi_url] +[![PyPI - Downloads](https://img.shields.io/pypi/dm/Eryx)][pypi_url] +[![PyPI - Wheel](https://img.shields.io/pypi/wheel/Eryx)][pypi_url] + +[pypi_url]: https://pypi.org/project/Eryx + +## What is Eryx? + Eryx is a decently fast simple dynamically typed programming language similar to javascript/python. + +## Installation + To install the latest stable release, just install it from PyPI using: +```sh +pip install eryx +``` +If you want to install the latest beta version head over to the [beta releases](https://github.com/ImShyMike/Eryx/releases/tag/beta) page, download the desired `.whl` file and install it using: +```sh +pip install Eryx-(version)-py3-none-any.whl +``` + +## Documentation +Coming soon... + +## Thanks +A huge thanks to [tylerlaceby](https://www.youtube.com/@tylerlaceby) for his ["Build a Custom Scripting Language In Typescript"](https://www.youtube.com/playlist?list=PL_2VhOvlMk4UHGqYCLWc6GO8FaPl8fQTh) playlist. + +## License +This project is licensed under the [MIT License](LICENSE). diff --git a/eryx/__init__.py b/eryx/__init__.py index 6067d5f..2f0f4da 100644 --- a/eryx/__init__.py +++ b/eryx/__init__.py @@ -1,3 +1,3 @@ """Version of the package.""" -CURRENT_VERSION = "0.1.0" +CURRENT_VERSION = "0.1.1" diff --git a/eryx/__main__.py b/eryx/__main__.py index 93f3591..9aa6605 100644 --- a/eryx/__main__.py +++ b/eryx/__main__.py @@ -9,8 +9,6 @@ from eryx.runtime.repl import start_repl from eryx.runtime.runner import run_code -CURRENT_VERSION = "0.1.0" - init(autoreset=True) diff --git a/setup.cfg b/setup.cfg index 91fa5a5..7ccb483 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,10 +1,15 @@ [metadata] name = Eryx -version = 0.1.0 +version = attr: eryx.__init__.CURRENT_VERSION author = ShyMike description = A decently fast simple dynamically typed programming language similar to javascript/python. +license = MIT long_description = file: README.md long_description_content_type = text/markdown +classifiers = + Programming Language :: Python :: 3 + License :: OSI Approved :: MIT License + Operating System :: OS Independent [options] packages = find: @@ -14,3 +19,7 @@ install_requires = flask pytest include_package_data = True + +[options.entry_points] +console_scripts = + eryx = eryx.__main__:main