Skip to content

Commit

Permalink
README + cmd entrypoint + bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
ImShyMike committed Dec 18, 2024
1 parent 0e778d8 commit e3268c7
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 5 deletions.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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).
2 changes: 1 addition & 1 deletion eryx/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
"""Version of the package."""

CURRENT_VERSION = "0.1.0"
CURRENT_VERSION = "0.1.1"
2 changes: 0 additions & 2 deletions eryx/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)


Expand Down
11 changes: 10 additions & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -14,3 +19,7 @@ install_requires =
flask
pytest
include_package_data = True

[options.entry_points]
console_scripts =
eryx = eryx.__main__:main

0 comments on commit e3268c7

Please sign in to comment.