Skip to content

Commit efabbb9

Browse files
committed
First commit and first release
0 parents  commit efabbb9

File tree

9 files changed

+399
-0
lines changed

9 files changed

+399
-0
lines changed

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.venv/*
2+
.code/*
3+
.vs/*
4+
.idea/*
5+
dist/*

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 OceanApocalypseStudios
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# RSML.Python
2+
> `pip install rsml_python` and you're ready to go.
3+
4+
Adds [RedSeaMarkupLanguage]("https://github.com/OceanApocalypseStudios/RedSeaMarkupLanguage) support for Python.
5+
6+
<hr />
7+
8+
## Get Started
9+
**Requirements:**
10+
- [ ] RSML.CLI (the executable) and RSML (dll) for the correct system and architecture
11+
- **OR**
12+
- [ ] A way to compile these (requires dotnet)
13+
14+
**Installation (via pip):**
15+
16+
```bash
17+
python -m pip install rsml_python # install via pip
18+
```
19+
20+
**Usage:**
21+
22+
```py
23+
# RSML.Python is not a port of RSML, as the original executable is required
24+
executable = RedSeaCLIExecutable(...)
25+
26+
document = RedSeaDocument()
27+
document.load_from_string(...)
28+
29+
executable.load_document(document)
30+
31+
output = executable.evaluate_document() # non-prettified output
32+
print(output)
33+
```
34+
35+
<hr />
36+
37+
## Fun Facts
38+
<img src="funni/v1_0_2.png" />
39+
40+
^ Version 1.0.2 of this module (first version) was coded in around one hour and half.
41+
42+
<hr />
43+
44+
> **Made with :heart: by OceanApocalypseStudios.**
45+
>
46+
> *Copyright (c) 2025 OceanApocalypseStudios*

__init__.py

Whitespace-only changes.

funni/v1_0_2.png

9.86 KB
Loading

pyproject.toml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
[build-system]
2+
requires = ["hatchling"]
3+
build-backend = "hatchling.build"
4+
5+
[project]
6+
name = "rsml_python"
7+
version = "1.0.2"
8+
authors = [
9+
{ name="MF366", email="[email protected]" },
10+
]
11+
description = "RedSeaMarkupLanguage support for Python."
12+
readme = "README.md"
13+
requires-python = ">=3.11"
14+
classifiers = [
15+
"Programming Language :: Python :: 3",
16+
"License :: OSI Approved :: MIT License",
17+
"Operating System :: OS Independent",
18+
]
19+
20+
[project.urls]
21+
"Homepage" = "https://github.com/OceanApocalypseStudios/RSML.Python"
22+
"Bug Tracker" = "https://github.com/OceanApocalypseStudios/RSML.Python/issues"

src/__init__.py

Whitespace-only changes.

0 commit comments

Comments
 (0)