Merge pull request #1 from R5dan/rename

Rename to Better-MD
Better-MD · Dec 8, 2024 · 0d5780a · 0d5780a
2 parents 885e104 + 479a556
commit 0d5780a
Show file tree

Hide file tree

Showing 27 changed files with 130 additions and 76 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -0,0 +1,30 @@
+name: Upload Python Package to PyPI when a Release is Created
+
+on:
+    release:
+        types: [created]
+
+jobs:
+    pypi-publish:
+        name: Publish release to PyPI
+        runs-on: ubuntu-latest
+        environment:
+            name: pypi
+            url: https://pypi.org/p/Better-MD
+        permissions:
+            id-token: write
+        steps:
+            - uses: actions/checkout@v4
+            - name: Set up Python
+              uses: actions/setup-python@v4
+              with:
+                  python-version: "3.x"
+            - name: Install dependencies
+              run: |
+                  python -m pip install --upgrade pip
+                  pip install setuptools wheel
+            - name: Build package
+              run: |
+                  python setup.py sdist bdist_wheel
+            - name: Publish package distributions to PyPI
+              uses: pypa/gh-action-pypi-publish@release/v1
diff --git a/better_md/__init__.py → Better-MD/__init__.py b/better_md/__init__.py → Better-MD/__init__.py
diff --git a/better_md/elements/__init__.py → Better-MD/elements/__init__.py b/better_md/elements/__init__.py → Better-MD/elements/__init__.py
diff --git a/better_md/elements/a.py → Better-MD/elements/a.py b/better_md/elements/a.py → Better-MD/elements/a.py
diff --git a/better_md/elements/blockquote.py → Better-MD/elements/blockquote.py b/better_md/elements/blockquote.py → Better-MD/elements/blockquote.py
diff --git a/better_md/elements/br.py → Better-MD/elements/br.py b/better_md/elements/br.py → Better-MD/elements/br.py
diff --git a/better_md/elements/code.py → Better-MD/elements/code.py b/better_md/elements/code.py → Better-MD/elements/code.py
diff --git a/better_md/elements/div.py → Better-MD/elements/div.py b/better_md/elements/div.py → Better-MD/elements/div.py
diff --git a/better_md/elements/h.py → Better-MD/elements/h.py b/better_md/elements/h.py → Better-MD/elements/h.py
diff --git a/better_md/elements/head.py → Better-MD/elements/head.py b/better_md/elements/head.py → Better-MD/elements/head.py
diff --git a/better_md/elements/hr.py → Better-MD/elements/hr.py b/better_md/elements/hr.py → Better-MD/elements/hr.py
diff --git a/better_md/elements/img.py → Better-MD/elements/img.py b/better_md/elements/img.py → Better-MD/elements/img.py
diff --git a/better_md/elements/input.py → Better-MD/elements/input.py b/better_md/elements/input.py → Better-MD/elements/input.py
diff --git a/better_md/elements/li.py → Better-MD/elements/li.py b/better_md/elements/li.py → Better-MD/elements/li.py
diff --git a/better_md/elements/p.py → Better-MD/elements/p.py b/better_md/elements/p.py → Better-MD/elements/p.py
diff --git a/better_md/elements/span.py → Better-MD/elements/span.py b/better_md/elements/span.py → Better-MD/elements/span.py
diff --git a/better_md/elements/symbol.py → Better-MD/elements/symbol.py b/better_md/elements/symbol.py → Better-MD/elements/symbol.py
diff --git a/better_md/elements/table.py → Better-MD/elements/table.py b/better_md/elements/table.py → Better-MD/elements/table.py
diff --git a/better_md/elements/text.py → Better-MD/elements/text.py b/better_md/elements/text.py → Better-MD/elements/text.py
diff --git a/better_md/elements/text_formatting.py → Better-MD/elements/text_formatting.py b/better_md/elements/text_formatting.py → Better-MD/elements/text_formatting.py
diff --git a/better_md/html/__init__.py → Better-MD/html/__init__.py b/better_md/html/__init__.py → Better-MD/html/__init__.py
diff --git a/better_md/html/custom_html.py → Better-MD/html/custom_html.py b/better_md/html/custom_html.py → Better-MD/html/custom_html.py
diff --git a/better_md/markdown/__init__.py → Better-MD/markdown/__init__.py b/better_md/markdown/__init__.py → Better-MD/markdown/__init__.py
diff --git a/better_md/markdown/custom_markdown.py → Better-MD/markdown/custom_markdown.py b/better_md/markdown/custom_markdown.py → Better-MD/markdown/custom_markdown.py
diff --git a/README.md b/README.md
@@ -2,9 +2,9 @@
 
 ## Todo
 
-- [x] Add basic architecture
-- [ ] Add HTML elelemts
-- [ ] Publish to Pypi
-- [ ] Add innerline support
-- [ ] Add escape chars (\\)
-- [ ] Add other languages
+-   [x] Add basic architecture
+-   [x] Add HTML elelemts
+-   [x] Publish to Pypi
+-   [ ] Add innerline support
+-   [ ] Add escape chars (\\)
+-   [ ] Add other languages
diff --git a/setup.py b/setup.py
@@ -0,0 +1,24 @@
+from setuptools import setup, find_packages
+
+VERSION = "0.0.1"
+DESCRIPTION = "A better markdown library"
+
+setup(
+        name="Better-MD", 
+        version=VERSION,
+        author="R5dan",
+        description=DESCRIPTION,
+        long_description=open("README.md").read(),
+        long_description_content_type="text/markdown",
+        packages=find_packages(),
+        keywords=['python', 'better markdown', 'markdown'],
+        classifiers= [
+            "Development Status :: 3 - Alpha",
+            "Intended Audience :: Developers",
+            "Programming Language :: Python :: 3",
+            "Operating System :: MacOS :: MacOS X",
+            "Operating System :: Microsoft :: Windows",
+            "Operating System :: POSIX :: Linux",
+        ],
+        url="https://github.com/Betters-Markdown/better_md"
+)
diff --git a/tests/test.py b/tests/test.py
@@ -1,80 +1,80 @@
-from better_md import H1, H2, Text, Div, LI, OL, UL, A, Strong, Table, Tr, Td, Th, Blockquote, Em, Input
+from Better-MD import H1, H2, Text, Div, LI, OL, UL, A, Strong, Table, Tr, Td, Th, Blockquote, Em, Input
 
-# print(H1(inner=[Text("Hi")]).to_html())
-# print(H1(inner=[Text("Hi")]).to_md())
+print(H1(inner=[Text("Hi")]).to_html())
+print(H1(inner=[Text("Hi")]).to_md())
 
 
-# print(
-#     Div(
-#         inner=[Div(
-#             inner=[H1(inner=[Text("Hi this is a H1")])]
-#         ),
-#         A(inner=[Text("Link")], href="https://www.google.com"),
-#         Div(
-#             inner=[
-#                 OL(
-#                     inner=[
-#                         LI(inner=[Text("LI1")]),
-#                         LI(inner=[Text("LI2")]),
-#                         LI(inner=[Text("LI3")])
-#                     ]
-#                 ),
-#                 A(inner=[Text("Link")], href="https://www.google.com")
-#             ]
-#         ),
-#         UL(
-#             inner=[
-#                 LI(inner=[Text("LI1")]),
-#                 LI(inner=[Text("LI2")]),
-#                 LI(inner=[Text("LI3")])
-#             ]
-#         )
-#         ]
-#     ).prepare(None).to_md()
-# )
+print(
+    Div(
+        inner=[Div(
+            inner=[H1(inner=[Text("Hi this is a H1")])]
+        ),
+        A(inner=[Text("Link")], href="https://www.google.com"),
+        Div(
+            inner=[
+                OL(
+                    inner=[
+                        LI(inner=[Text("LI1")]),
+                        LI(inner=[Text("LI2")]),
+                        LI(inner=[Text("LI3")])
+                    ]
+                ),
+                A(inner=[Text("Link")], href="https://www.google.com")
+            ]
+        ),
+        UL(
+            inner=[
+                LI(inner=[Text("LI1")]),
+                LI(inner=[Text("LI2")]),
+                LI(inner=[Text("LI3")])
+            ]
+        )
+        ]
+    ).prepare(None).to_md()
+)
 
 # Bold text
-# print(Strong(inner=[Text("Bold text")]).prepare(None).to_md())  # **Bold text**
+print(Strong(inner=[Text("Bold text")]).prepare(None).to_md())  # **Bold text**
 
-# # Table example
-# print(
-#     Table(
-#         inner=[
-#             Tr(
-#                 inner=[
-#                     Th(inner=[Text("Header 1")]),
-#                     Th(inner=[Text("Header 2")])
-#                 ],
-#                 is_header=True
-#             ),
-#             Tr(
-#                 inner=[
-#                     Td(inner=[Text("Cell 1")]),
-#                     Td(inner=[Text("Cell 2")])
-#                 ]
-#             )
-#         ]
-#     ).prepare(None).to_md()
-# )
-# """
-# |Header 1|Header 2|
-# |---|---|
-# |Cell 1|Cell 2|
-# """
+# Table example
+print(
+    Table(
+        inner=[
+            Tr(
+                inner=[
+                    Th(inner=[Text("Header 1")]),
+                    Th(inner=[Text("Header 2")])
+                ],
+                is_header=True
+            ),
+            Tr(
+                inner=[
+                    Td(inner=[Text("Cell 1")]),
+                    Td(inner=[Text("Cell 2")])
+                ]
+            )
+        ]
+    ).prepare(None).to_md()
+)
+"""
+|Header 1|Header 2|
+|---|---|
+|Cell 1|Cell 2|
+"""
 
-# # Blockquote with formatting
-# print(
-#     Blockquote(
-#         inner=[
-#             Text("A quote with "),
-#             Strong(inner=[Text("bold")]),
-#             Text(" and "),
-#             Em(inner=[Text("italic")]),
-#             Text(" text.")
-#         ]
-#     ).prepare(None).to_md()
-# )
-# > A quote with **bold** and *italic* text.
+# Blockquote with formatting
+print(
+    Blockquote(
+        inner=[
+            Text("A quote with "),
+            Strong(inner=[Text("bold")]),
+            Text(" and "),
+            Em(inner=[Text("italic")]),
+            Text(" text.")
+        ]
+    ).prepare(None).to_md()
+)
+> A quote with **bold** and *italic* text.
 
 # Text input
 print(Input(type="text", placeholder="Enter your name", required=True).prepare(None).to_html())