Merge pull request #5 from neatc0der/release/v0.2

Release/v0.2

Author: neatc0der

.build/mkdocs_markmap_build/common.py

@@ -1,3 +1,4 @@
+import fnmatch
 import os
 import sys
 from pathlib import Path
@@ -9,15 +10,15 @@
 from github.GitRelease import GitRelease
 from github.Repository import Repository
 
-from mkdocs_markmap.__meta__ import PACKAGE_NAME, PROJECT_NAME, PROJECT_VERSION, REPOSITORY
+from mkdocs_markmap.__meta__ import PACKAGE_NAME, PROJECT_NAME, PROJECT_VERSION, REPOSITORY_NAME
 
 
 PROJECT_PATH: Path = Path(__file__).parent.parent.parent.absolute()
 DIST_PATH: Path = PROJECT_PATH / 'dist'
 CHANGELOG_PATH: Path = PROJECT_PATH / 'changelog'
 
-GZ_WILDCARD: str = f'{PROJECT_NAME}-{PROJECT_VERSION}*.gz'
-WHL_WILDCARD: str = f'{PACKAGE_NAME}-{PROJECT_VERSION}*.whl'
+GZ_WILDCARD: str = f'{PROJECT_NAME}-{{version}}*.gz'
+WHL_WILDCARD: str = f'{PACKAGE_NAME}-{{version}}*.whl'
 
 
 class GithubHandler(object):
@@ -28,23 +29,41 @@ def __init__(self, tag: str) -> None:
             print('environment variable "GITHUB_TOKEN" is not set')
             sys.exit(1)
         self.github: Github = Github(github_token)
-        self.repository: Repository = self.github.get_repo(REPOSITORY)
+        self.repository: Repository = self.github.get_repo(REPOSITORY_NAME)
 
 
 class AssetCollector(object):
+    def __init__(self, tag: str = None) -> None:
+        self.tag = tag
+
+        version = PROJECT_VERSION if tag is None else tag[1:]
+        self.gz_wildcard = GZ_WILDCARD.format(version=version)
+        self.whl_wildcard = WHL_WILDCARD.format(version=version)
+
     def get_assets(self) -> List[str]:
-        gz_assets: List[str] = list(str(p) for p in DIST_PATH.glob(GZ_WILDCARD))
-        whl_assets: List[str] = list(str(p) for p in DIST_PATH.glob(WHL_WILDCARD))
+        gz_assets: List[str] = list(str(p) for p in DIST_PATH.glob(self.gz_wildcard))
+        whl_assets: List[str] = list(str(p) for p in DIST_PATH.glob(self.whl_wildcard))
+
+        help_text = ': run "inv build" first' if self.tag is None else ''
+
+        try:
+            assert len(gz_assets) == 1, \
+                f'release asset "{self.gz_wildcard}" is missing in {DIST_PATH}' + help_text
+            assert len(whl_assets) == 1, \
+                f'release asset "{self.whl_wildcard}" is missing in {DIST_PATH}' + help_text
 
-        assert len(gz_assets) == 1, \
-            f'release asset "{GZ_WILDCARD}" is missing in {self.dist_path}: run "inv build" first'
-        assert len(whl_assets) == 1, \
-            f'release asset "{WHL_WILDCARD}" is missing in {self.dist_path}: run "inv build" first'
+        except AssertionError as e:
+            print(e)
+            sys.exit(1)
 
         return gz_assets + whl_assets
 
 
 class AssetDownloader(GithubHandler):
+    def __init__(self, tag: str) -> None:
+        super().__init__(tag)
+        self._collector = AssetCollector(tag)
+
     def get_assets_from_release(self) -> List[str]:
         try:
             release: GitRelease = next(r for r in self.repository.get_releases() if r.tag_name == self.tag)
@@ -53,10 +72,16 @@ def get_assets_from_release(self) -> List[str]:
             sys.exit(1)
 
         DIST_PATH.mkdir(exist_ok=True)
-        assets = []
 
         http: PoolManager = PoolManager()
         for asset in release.get_assets():
+            if not any(
+                pattern
+                for pattern in (self._collector.gz_wildcard, self._collector.whl_wildcard)
+                if fnmatch.fnmatch(asset.browser_download_url, pattern)
+            ):
+                continue
+
             response: HTTPResponse = http.request('GET', asset.browser_download_url)
             if response.status != 200:
                 print(f'Download of asset "{asset.name}" failed: {asset.browser_download_url} ({response.status})')
@@ -66,9 +91,7 @@ def get_assets_from_release(self) -> List[str]:
             with open(file_path, 'wb') as fp:
                 fp.write(response.data)
 
-            assets.append(str(file_path))
-        
-        return assets
+        return self._collector.get_assets()
 
 
 class ChangelogLoader:

.build/mkdocs_markmap_build/distribution.py

@@ -12,7 +12,7 @@ class DistributionHandler(object):
     def __init__(self, tag: str) -> None:
         self._collector = AssetDownloader(tag)
 
-    def distribute(self):
+    def distribute(self, dry_run: bool = True):
         assets: List[str] = self._collector.get_assets_from_release()
         os.environ['TWINE_USERNAME'] = '__token__'
 
@@ -22,4 +22,8 @@ def distribute(self):
             print('environment variable "TWINE_PASSWORD" is not set')
             sys.exit(1)
 
-        dispatch(['upload', *assets])
+        if dry_run:
+            print('This is a dry run!')
+
+        else:
+            dispatch(['upload', *assets])

.build/mkdocs_markmap_build/release.py

@@ -21,7 +21,8 @@ def __init__(self, tag: str) -> None:
         self._changelog = ChangelogLoader()
         self._collector = AssetCollector()
 
-    def create(self, commit: str = None,dry_run: bool = True):
+    def create(self, commit: str = None, dry_run: bool = True):
+        release_message: str = self._changelog.get(self.tag)
         assets: List[str] = self._collector.get_assets()
         tagger: GitAuthor = None
 
@@ -37,7 +38,7 @@ def create(self, commit: str = None,dry_run: bool = True):
         parameters: Dict[str, str] = {
             'object': commit,
             'release_name': self.tag,
-            'release_message': self._changelog.get(self.tag),
+            'release_message': release_message,
             'tag': self.tag,
             'tag_message': f'Release version {self.tag}',
             'type': 'commit',
@@ -59,12 +60,19 @@ def create(self, commit: str = None,dry_run: bool = True):
             pprint(parameters, width=120)
 
         else:
-            release: GitRelease = self.repository.create_git_tag_and_release(**parameters)
+            release: GitRelease = self.repository.create_git_tag_and_release(**parameters, draft=True)
             print(f'Release "{self.tag}" created: {release.html_url}')
             for asset in assets:
                 release_asset: GitReleaseAsset = release.upload_asset(asset)
                 print(f'Release asset "{release_asset.name}" uploaded: {release_asset.url}')
 
+            release.update_release(
+                name=self.tag,
+                message=release_message,
+                draft=True,
+            )
+            print('Release published')
+
     def delete(self):
         try:
             next(t for t in self.repository.get_tags() if t.name == self.tag)

.github/workflows/distribute.yml

@@ -0,0 +1,31 @@
+name: Distribution Workflow
+
+on:
+  release:
+    types:
+      - released
+
+jobs:
+  build:
+    name: Distribute
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Prepare Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8 
+
+      - name: Install Dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          pip install -r requirements/build.txt
+          python3 setup.py install
+
+      - name: Distribute Package to PyPI
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          TWINE_PASSWORD: ${{ secrets.TWINE_TOKEN }}
+        run: inv distribute --tag ${GITHUB_REF#refs/*/} --no-dry-run

.github/workflows/release.yml

@@ -31,9 +31,3 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: inv release --no-dry-run
-
-      - name: Distribute Package to PyPI
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          TWINE_PASSWORD: ${{ secrets.TWINE_TOKEN }}
-        run: inv distribute

mkdocs_markmap/__meta__.py

@@ -1,6 +1,6 @@
 PACKAGE_NAME = 'mkdocs_markmap'
 PROJECT_NAME = PACKAGE_NAME.replace('_', '-')
-PROJECT_VERSION = '0.1'
+PROJECT_VERSION = '0.2'
 
 OWNER = 'neatc0der'
-REPOSITORY = f'{OWNER}/{PROJECT_NAME}'
+REPOSITORY_NAME = f'{OWNER}/{PROJECT_NAME}'

mkdocs_markmap/extension.py

@@ -7,7 +7,7 @@
 from markdown.preprocessors import Preprocessor
 
 
-INC_SYNTAX = re.compile(r'\{!\s*(?P<path>.+?)\s*!\}')
+INCLUDE_SYNTAX = re.compile(r'\{!\s*(?P<path>.+?)\s*!\}')
 
 
 class MarkmapPreprocessor(Preprocessor):
@@ -25,7 +25,7 @@ def run(self, lines: List[str]) -> List[str]:
         done: bool = False
         while not done:
             for loc, line in enumerate(lines):
-                match: Optional[re.Match[AnyStr]] = INC_SYNTAX.search(line)
+                match: Optional[re.Match[AnyStr]] = INCLUDE_SYNTAX.search(line)
                 if match is None:
                     continue
 
@@ -42,10 +42,10 @@ def run(self, lines: List[str]) -> List[str]:
 
                 except Exception as e:
                     print('Warning: could not include file {}. Ignoring statement. Error: {}'.format(path, e))
-                    lines[loc] = INC_SYNTAX.sub('',line)
+                    lines[loc] = INCLUDE_SYNTAX.sub('',line)
                     break
 
-                line_split: List[str] = INC_SYNTAX.split(line)
+                line_split: List[str] = INCLUDE_SYNTAX.split(line)
                 if len(markmap) == 0:
                     markmap.append('')
                 else:
@@ -69,7 +69,7 @@ def run(self, lines: List[str]) -> List[str]:
 
 # todo: replace this functionality with an "include"
 class MarkmapExtension(Extension):
-    def __init__(self, configs: Dict[str, str] = {}):
+    def __init__(self, **configs: Dict[str, str]):
         self.config: Dict[str, str] = {
             'base_path': ['docs', 'Default location from which to evaluate relative paths for the include statement.'],
             'encoding': ['utf-8', 'Encoding of the files used by the include statement.'],

setup.py

@@ -2,7 +2,7 @@
 from setuptools import setup, find_packages
 from typing import List
 
-from mkdocs_markmap.__meta__ import PROJECT_NAME, PROJECT_VERSION
+from mkdocs_markmap.__meta__ import PROJECT_NAME, PROJECT_VERSION, REPOSITORY_NAME
 
 
 def readme() -> str:
@@ -23,20 +23,14 @@ def get_requirements(filename: str, base_dir: str = 'requirements') -> List[str]
     return install_requires
 
 
-long_description = (
-    "This is a mkdocs plugin that introduces support for markmap."
-    "Please follow the instruction in reame to enable this plugin."
-)
-
-
 setup(
     name=PROJECT_NAME,
     version=PROJECT_VERSION,
     description='MkDocs plugin and extension to creates mindmaps from markdown using markmap',
-    long_description=long_description,
-    long_description_content_type='text/plain',
+    long_description=readme(),
+    long_description_content_type='text/markdown',
     keywords='mkdocs python markdown mermaid',
-    url='https://github.com/neac0der/mkdocs-markmap',
+    url=f'https://github.com/{REPOSITORY_NAME}',
     author='neatc0der',
     author_email='',
     license='MIT',

tasks.py

@@ -45,4 +45,4 @@ def distribute(c, tag=TARGET_TAG, dry_run=True):
     print(f'distribute release: {tag}')
 
     handler: DistributionHandler = DistributionHandler(tag)
-    handler.distribute()
+    handler.distribute(dry_run=dry_run)