v1 ✨

* Fix #27, #28

* Corrects namespace to be neoteroi.mkdocs

* Replace setup.py with pyproject.toml

* Update CHANGELOG.md

Author: RobertoPrevato

.github/workflows/build.yml

@@ -16,7 +16,7 @@ env:
 
 jobs:
   build:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
@@ -47,7 +47,7 @@ jobs:
         if: matrix.python-version == '3.10'
 
       - name: Use Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v3
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -96,29 +96,29 @@ jobs:
           bash <(curl -s https://codecov.io/bash)
 
       - name: Install distribution dependencies
-        run: pip install --upgrade twine setuptools wheel
+        run: pip install build
         if: matrix.python-version == '3.10'
 
       - name: Create distribution package
-        run: python setup.py sdist bdist_wheel
+        run: python -m build
         if: matrix.python-version == '3.10'
 
       - name: Upload distribution package
         uses: actions/upload-artifact@master
         with:
-          name: dist-package-${{ matrix.python-version }}
+          name: dist
           path: dist
         if: matrix.python-version == '3.10'
 
   publish:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     needs: build
     if: github.event_name == 'release'
     steps:
       - name: Download the distribution package
         uses: actions/download-artifact@v2
         with:
-          name: dist-package-3.10
+          name: dist
           path: dist
 
       - name: Publish distribution 📦 to Test PyPI
@@ -148,17 +148,6 @@ jobs:
         with:
           upload_url: ${{ github.event.release.upload_url }}
           asset_path: ./dist-css/neoteroi-mkdocs.css
-          asset_name: css-${{ github.event.release.tag_name }}.zip
-          asset_content_type: application/zip
-        continue-on-error: true
-
-      - name: Add CSS package to the release
-        uses: actions/upload-release-asset@v1.0.1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ github.event.release.upload_url }}
-          asset_path: ./dist-css/neoteroi-mkdocs.min.css
-          asset_name: css-${{ github.event.release.tag_name }}.zip
-          asset_content_type: application/zip
+          asset_name: css-${{ github.event.release.tag_name }}.css
+          asset_content_type: text/css
         continue-on-error: true

.gitignore

@@ -13,3 +13,4 @@ __*.html
 __file_out.py
 
 docs/res/contribs-new.html
+dist/

CHANGELOG.md

@@ -1,20 +1,23 @@
 .PHONY: release test annotate
 
 
-artifacts: test
-	python setup.py sdist
+artifacts: test build
 
 
 prepforbuild:
-	pip install --upgrade twine setuptools wheel
+	pip install build
 
 
-testrelease:
-	twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+build:
+	python -m build
 
 
-release: artifacts
-	twine upload --repository-url https://upload.pypi.org/legacy/ dist/*
+test-release:
+	twine upload --repository testpypi dist/*
+
+
+release:
+	twine upload --repository pypi dist/*
 
 
 test:

Makefile

@@ -0,0 +1 @@
+__version__ = "1.0.0"

neoteroi/contribs/py.typed

@@ -8,9 +8,12 @@
 """
 from markdown import Extension
 
-from neoteroi.markdown.images import Image
-from neoteroi.markdown.processors import EmbeddedBlockProcessor, SourceBlockProcessor
-from neoteroi.markdown.utils import create_instance, create_instances
+from neoteroi.mkdocs.markdown.images import Image
+from neoteroi.mkdocs.markdown.processors import (
+    EmbeddedBlockProcessor,
+    SourceBlockProcessor,
+)
+from neoteroi.mkdocs.markdown.utils import create_instance, create_instances
 
 from .domain import CardItem, Cards
 from .html import CardsHTMLBuilder, CardsViewOptions

neoteroi/markdown/py.typed

@@ -1,7 +1,7 @@
 from dataclasses import dataclass
 from typing import List, Optional
 
-from neoteroi.markdown.images import Image
+from neoteroi.mkdocs.markdown.images import Image
 
 
 @dataclass

neoteroi/mkdocs/__init__.py

@@ -2,7 +2,7 @@
 import xml.etree.ElementTree as etree
 from dataclasses import dataclass
 
-from neoteroi.markdown.images import build_image_html
+from neoteroi.mkdocs.markdown.images import build_image_html
 
 from .domain import CardItem, Cards
 
@@ -12,6 +12,7 @@
 @dataclass
 class CardsViewOptions:
     id: str = ""
+    class_name: str = ""
     cols: int = 3
     image_bg: bool = False
 
@@ -36,9 +37,16 @@ def get_item_props(self, item: CardItem):
 
         return item_props
 
+    def _get_root_class(self):
+        base_class = f"nt-cards nt-grid cols-{self.options.cols}"
+
+        if self.options.class_name:
+            return base_class + " " + self.options.class_name
+        return base_class
+
     def build_html(self, parent, cards: Cards):
         root_element = etree.SubElement(
-            parent, "div", {"class": f"nt-cards nt-grid cols-{self.options.cols}"}
+            parent, "div", {"class": self._get_root_class()}
         )
 
         for item in cards.items: