Metadata-Version: 2.1
Name: serl
Version: 0.3.0b0
Summary: Serl - A tool for creating and using languages
Author: Harry Downing
Author-email: harry.downing17@gmail.com
License: MIT
Project-URL: Repository, https://github.com/harrydowning/serl
Project-URL: Documentation, https://serl.readthedocs.io/en/latest/index.html
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE

# Serl - A tool for creating and using languages
<a href="https://pypi.org/project/serl/">
  <img src="https://img.shields.io/pypi/v/serl"/>
</a>
<a href="https://github.com/harrydowning/serl/blob/master/LICENSE">
  <img src="https://img.shields.io/github/license/harrydowning/serl"/>
</a>

Serl (serialized languages) is a format and corresponding command line tool for creating and using textual domain specific or markup languages with arbitrary syntax. This is achieved through the concept of language configurations, which are YAML files for specifying language syntax and functionality, used by the tool to execute language programs. These configurations can then be linked, allowing languages to be used like any other command line tool.

Documentation can be found on [Read The Docs](https://serl.readthedocs.io/en/latest/index.html).

### Development Workflow
| Command | Description |
| ------- | ----------- |
| `pip install .` | Build/install locally |
| `serl help` | Show the tool command line help screen |
| `pytest tests` or `test.bat` | Run automated test suite |
| `py -m build` | Build distribution |
| `py -m twine upload dist/*` | Upload distribution |
| `sphinx-build -b html docs/source/ docs/build/html` | Build documentation |


MIT License

Copyright (c) 2023 Harry Downing

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:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

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.
