Merge pull request #16 from neatc0der/release/v2.0

Release/v2.0

Author: neatc0der

.build/mkdocs_markmap_build/info.py

@@ -0,0 +1,83 @@
+import json
+from typing import Dict, List
+from urllib3.poolmanager import PoolManager
+from urllib3.response import HTTPResponse
+
+from github.GitRelease import GitRelease
+
+from mkdocs_markmap.__meta__ import PROJECT_NAME
+from .common import GithubHandler
+
+
+PYPI_URL = f'https://pypi.org/pypi/{PROJECT_NAME}/json'
+
+
+class ReleaseInfo(GithubHandler):
+    def print(self, github: bool = True, pypi: bool = False) -> None:
+        if github:
+            self._print_github()
+        if pypi:
+            self._print_pypi()
+        
+    def _print_github(self) -> None:
+        release: GitRelease
+        if self.tag is None:
+            release = self.repository.get_latest_release()
+        
+        else:
+            try:
+                release = next(r for r in self.repository.get_releases() if r.tag_name == self.tag)
+            except StopIteration:
+                print(f'release not found on github: {self.tag}')
+                return
+
+        print(f"""
+        Release:    {release.title}
+        Url:        {release.url}
+        Created:    {release.created_at}
+        Published:  {release.published_at}
+        Draft:      {release.draft}
+        Prerelease: {release.prerelease}
+        Assets:     {', '.join(a.name for a in release.get_assets())}
+        """)
+
+    def _print_pypi(self) -> None:
+        http: PoolManager = PoolManager()
+        response: HTTPResponse = http.request('GET', PYPI_URL)
+        if response.status != 200:
+            print(f'error on pypi request: {response._request_url} ({response.status})')
+            return
+
+        project_data = json.loads(response.data)
+        release_url: str = project_data['info']['release_url']
+        downloads: Dict[str, int] = project_data['info']['downloads']
+
+        version: str
+        if self.tag is None:
+            version = project_data['info']['version']
+        else:
+            version = self.tag[1:]
+            release_url = release_url.replace(project_data['info']['version'], version)
+
+        try:
+            assets: List[Dict[str, str]] = project_data['releases'][version]
+        except KeyError:
+            print(f'release not found on pypi: {self.tag}')
+            return
+
+        uploaded: str
+        if not any(assets):
+            uploaded = 'no assets!'
+        else:
+            uploaded = assets[0]['upload_time'].replace('T', ' ')
+
+        print(f"""
+        Release:    {version}
+        Url:        {release_url}
+        Assets:     {', '.join(a['filename'] for a in assets)}
+        Uploaded:   {uploaded}
+        Downloads:
+            Last Month: {downloads['last_month']}
+            Last Week:  {downloads['last_week']}
+            Last Day:   {downloads['last_day']}
+        """)

.github/workflows/distribute.yml

@@ -4,6 +4,7 @@ on:
   release:
     types:
       - published
+      - released
 
 jobs:
   build:

.github/workflows/release.yml

@@ -30,4 +30,6 @@ jobs:
       - name: Create Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: inv release --no-dry-run
+        run: |
+          inv release --no-dry-run
+          inv latest --github

README.md

@@ -24,8 +24,6 @@ pip install mkdocs-markmap
 Add this to `mkdocs.yml`:
 
 ```yaml
-markdown_extensions:
-  - markmap
 plugins:
   - markmap
 ```
@@ -36,12 +34,11 @@ There are more options available for `mkdocs.yml` (shown values are defaults):
 
 ```yaml
 markdown_extensions:
+plugins:
   - markmap:
       base_path: docs
       encoding: utf-8
       file_extension: .mm.md
-plugins:
-  - markmap:
       d3_version: 6.3.1
       lib_version: 0.11.1
       view_version: 0.2.1
@@ -62,40 +59,6 @@ extra_javascript:
 * `markmap-lib`
 * `markmap-view`
 
-## Wait, what?! Do I need an extension or a plugin? :unamused:
-
-_Q: What does the plugin do?_
-
-A: It supports code blocks of markdown as follows:
-
-````markdown
-```markmap
-# Root
-
-## Branch 1
-
-* Branchlet 1a
-* Branchlet 1b
-
-## Branch 2
-
-* Branchlet 2a
-* Branchlet 2b
-```
-````
-
-_Q: What does the extension do?_
-
-A: Well, having such a support is nice, but huge mindmap blocks might be annoying within your tidy markdown files. That is why the extension provides an addition to the markdown syntax. It includes files whereever you need them to be:
-
-```markdown
-Look at this beautiful mindmap:
-
-{!mindmap.mm.md!}
-```
-
-But you _do_ need the plugin for that. Thus, don't forget to follow the quickstart example above.
-
 ## Credits :clap:
 
 Some of the development approaches are based on implementations provided by the following projects:

changelog/v2.0.md

@@ -0,0 +1,5 @@
+# v2.0
+
+* Simplification for configuration (automated extension registration)
+* Extended build commands
+

mkdocs_markmap/__meta__.py

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

mkdocs_markmap/extension.py

@@ -72,12 +72,14 @@ def run(self, lines: List[str]) -> List[str]:
 
 
 class MarkmapExtension(Extension):
+    config_defaults: 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.'],
+        'file_extension': ['.mm.md', 'File extension of mindmap files'],
+    }
+
     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.'],
-            'file_extension': ['.mm.md', 'File extension of mindmap files'],
-        }
+        self.config: Dict[str, str] = self.config_defaults
         for key, value in configs.items():
             self.setConfig(key, value)
 

mkdocs_markmap/plugin.py

@@ -1,4 +1,5 @@
 import logging
+from mkdocs_markmap.extension import MarkmapExtension
 import re
 from pathlib import Path
 from typing import Dict, Tuple
@@ -8,7 +9,6 @@
 from mkdocs.structure.pages import Page
 from mkdocs.config.base import Config
 from mkdocs.config.config_options import Type as PluginType
-from mkdocs.utils import copy_file
 
 from .defaults import MARKMAP
 from .utils import download
@@ -30,6 +30,9 @@ class MarkmapPlugin(BasePlugin):
             (f'{name}_version', PluginType(str, default=module.version))
             for name, module in MARKMAP.items()
         ),
+        ('base_path', PluginType(str, default='docs')),
+        ('encoding', PluginType(str, default='utf-8')),
+        ('file_extension', PluginType(str, default='.mm.md')),
     )
 
     def __init__(self):
@@ -78,6 +81,16 @@ def _add_statics(soup: BeautifulSoup):
                 tag.string = fp.read()
             getattr(soup, attribute).append(tag)    
 
+    def on_config(self, config: Config) -> Config:
+        config['markdown_extensions'].append('markmap')
+        config['mdx_configs']['markmap'] = {
+            key: value
+            for key, value in config['plugins'].get('markmap').config.items()
+            if key in MarkmapExtension.config_defaults
+        }
+
+        return config
+
     def on_post_page(self, output_content: str, config: Config, **kwargs) -> str:
         soup: BeautifulSoup = BeautifulSoup(output_content, 'html.parser')
         page: Page = kwargs.get('page')

tasks.py

@@ -8,8 +8,8 @@
 sys.path.insert(0, str(PROJECT_PATH / '.build'))
 
 from mkdocs_markmap.__meta__ import PROJECT_VERSION
-from mkdocs_markmap_build.common import ChangelogLoader
 from mkdocs_markmap_build.distribution import DistributionHandler
+from mkdocs_markmap_build.info import ReleaseInfo
 from mkdocs_markmap_build.release import ReleaseHandler
 
 
@@ -49,6 +49,20 @@ def release(c, commit=None, tag=TARGET_TAG, dry_run=True):
     handler.create(commit, dry_run=dry_run)
 
 
+@task
+def info(c, tag=None, github=False, pypi=False):
+    if tag is None: 
+        print('show latest release info')
+    else:
+        print(f'show release info: {tag}')
+
+    print_github = github or not (github or pypi)
+    print_pypi = pypi or not (github or pypi)
+
+    release: ReleaseInfo = ReleaseInfo(tag)
+    release.print(github=print_github, pypi=print_pypi)
+
+
 @task
 def distribute(c, tag=TARGET_TAG, dry_run=True):
     print(f'distribute release: {tag}')