Historie 0.1.0__py3-none-any.whl

historie/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.1.0'

historie/__main__.py

@@ -0,0 +1,5 @@
+from .cli import main
+
+
+if __name__ == '__main__':
+    main()

historie/cli.py

@@ -0,0 +1,66 @@
+import argparse
+import fileinput
+import logging
+import sys
+from pathlib import Path
+
+from . import exporters
+
+
+logger = logging.getLogger(__package__)
+
+
+def build_parser():
+    parser = argparse.ArgumentParser(
+        prog='historie',
+        description=(
+            'Generate a résumé in a publish format from reStructuredText.'
+        ),
+    )
+    parser.add_argument(
+        '--logging-level',
+        help='Logging level. By default: %(default)s.',
+        default='INFO',
+    )
+    parser.add_argument(
+        '-f', '--format',
+        choices=['html', 'pdf'],
+        default='html',
+        help='Output format. By default: %(default)s.',
+    )
+    parser.add_argument(
+        '-o', '--output',
+        type=Path,
+        help='Output file: By default ".rst" is appended to input.',
+    )
+    parser.add_argument('input', help='Input reStructuredText file')
+
+    return parser
+
+
+def main():
+    logging.basicConfig(
+        level=logging.INFO,
+        format='%(asctime)s %(levelname)-7s %(name)s %(message)s',
+        datefmt='%Y-%m-%d %H:%M:%S',
+    )
+
+    args = build_parser().parse_args()
+    logging.root.setLevel(args.logging_level)
+
+    input_path = Path(args.input)
+    if args.input and args.input != '-' and not input_path.exists():
+        logger.error('Input file not found: %s', args.input)
+        sys.exit(1)
+
+    if args.output:
+        output = args.output
+    elif args.input and args.input != '-':
+        output = f'{input_path.stem}.{args.format}'
+    else:
+        output = f'output.{args.format}'
+
+    exporter = exporters.registry[args.format]
+    with fileinput.input(files=args.input) as f_in:
+        with open(output, 'wb') as f_out:
+            exporter(''.join(line for line in f_in), f_out)

historie/directives.py

@@ -0,0 +1,447 @@
+from datetime import date
+from urllib.parse import quote
+
+from docutils import nodes
+from docutils.parsers import rst
+from docutils.parsers.rst.directives import register_directive, unchanged
+
+from . import utility
+
+
+__all__ = 'register_directives',
+
+
+def register_directives():
+    directives = (
+        ContactDirective,
+        EducationDirective,
+        JobDirective,
+        LinkDirective,
+        ProjectDirective,
+        StackExchangeProfileDirective,
+        SummaryDirective,
+        TechnologyPreferenceDirective,
+    )
+    for d in directives:
+        register_directive(d.name, d)
+
+
+def split_tags(s: str) -> list[str]:
+    return [t.strip() for t in s.split(',') if t.strip()]
+
+
+def format_date_range(start: date | None, finish: date | None) -> str:
+    if start and finish:
+        return f'{start.strftime("%b %Y")} – {finish.strftime("%b %Y")}'
+    elif start:
+        return f'{start.strftime("%b %Y")} – present'
+    else:
+        return ''
+
+
+class ContactDirective(rst.Directive):
+
+    name = 'his-contacts'
+
+    has_content = True
+    option_spec = {
+        'name': unchanged,
+        'title': unchanged,
+        'location': unchanged,
+        'email': unchanged,
+    }
+
+    def run(self):
+        container = nodes.container(classes=[self.name])
+        for k, v in self.options.items():
+            if k == 'email':
+                ref = nodes.reference('', v, refuri=f'mailto:{v}')
+                li = nodes.list_item('', nodes.inline('', '', ref), classes=[f'{self.name}-{k}'])
+            else:
+                li = nodes.list_item('', nodes.inline('', v), classes=[f'{self.name}-{k}'])
+            container.append(li)
+
+        if 'name' in self.options:
+            self.state.document.settings.title = self.options['name']
+
+        return [container]
+
+
+class LinkDirective(rst.Directive):
+
+    name = 'his-links'
+
+    has_content = True
+
+    def run(self):
+        container = nodes.container(classes=[self.name])
+
+        if not self.content:
+            return [container]
+
+        node = nodes.Element()
+        self.state.nested_parse(self.content, self.content_offset, node)
+
+        items = []
+        for child in node:
+            if not isinstance(child, nodes.definition_list):
+                continue
+
+            for item in child:
+                if not isinstance(item, nodes.definition_list_item):
+                    continue
+
+                term = item[0].astext() if item.children else ''
+                definition = item[1].astext().strip() if len(item) > 1 else ''
+                if term and definition:
+                    ref = nodes.reference('', term, refuri=definition)
+                    ref['classes'].append('his-link')
+                    li = nodes.list_item('', nodes.inline('', '', ref))
+                    items.append(li)
+
+        if items:
+            container.append(nodes.bullet_list('', *items))
+
+        return [container]
+
+
+class StackExchangeProfileDirective(rst.Directive):
+
+    name = 'his-stack-exchange-profiles'
+
+    has_content = False
+    option_spec = {
+        'stackoverflow': unchanged,
+        'serverfault': unchanged,
+        'superuser': unchanged,
+        'askubuntu': unchanged,
+        'unix': unchanged,
+        'dba': unchanged,
+        'softwareengineering': unchanged,
+    }
+
+    _site_urls = {
+        'stackoverflow': 'https://stackoverflow.com/users/{}',
+        'serverfault': 'https://serverfault.com/users/{}',
+        'superuser': 'https://superuser.com/users/{}',
+        'askubuntu': 'https://askubuntu.com/users/{}',
+        'unix': 'https://unix.stackexchange.com/users/{}',
+        'dba': 'https://dba.stackexchange.com/users/{}',
+        'softwareengineering': 'https://softwareengineering.stackexchange.com/users/{}',
+    }
+    _site_names = {
+        'stackoverflow': 'Stack Overflow',
+        'serverfault': 'Server Fault',
+        'superuser': 'Super User',
+        'askubuntu': 'Ask Ubuntu',
+        'unix': 'Unix & Linux',
+        'dba': 'Database Administrators',
+        'softwareengineering': 'Software Engineering',
+    }
+
+    def _create_header(
+        self, profile: utility.StackExchangeProfile | None, site: str, user_id: int
+    ) -> nodes.container:
+        header = nodes.container(classes=[f'{self.name}-header'])
+
+        site_name = self._site_names[site]
+        url = self._site_urls[site].format(user_id)
+
+        site_para = nodes.paragraph('', '', classes=[f'{self.name}-site'])
+        ref = nodes.reference('', site_name, refuri=url)
+        ref['classes'].append('his-link')
+        site_para.append(ref)
+        if profile:
+            if profile.answer_count > 0:
+                site_para.append(nodes.inline('', ' · '))
+                answers_ref = nodes.reference(
+                    '', f'{profile.answer_count} answers', refuri=f'{url}?tab=answers'
+                )
+                answers_ref['classes'].append(f'{self.name}-badge')
+                site_para.append(answers_ref)
+
+            if profile.question_count > 0:
+                site_para.append(nodes.inline('', ' · '))
+                questions_ref = nodes.reference(
+                    '', f'{profile.question_count} questions', refuri=f'{url}?tab=questions'
+                )
+                questions_ref['classes'].append(f'{self.name}-badge')
+                site_para.append(questions_ref)
+        header.append(site_para)
+
+        if profile:
+            date_range = format_date_range(profile.member_since.date(), None)
+            if date_range:
+                header.append(nodes.paragraph(
+                    '', date_range, classes=[f'{self.name}-dates']
+                ))
+
+        return header
+
+    def _create_top_tags(self, profile: utility.StackExchangeProfile) -> nodes.container:
+        tag_container = nodes.container(classes=[f'{self.name}-tags'])
+        for tag in profile.top_tags[:5]:
+            uri = 'https://stackoverflow.com/tags/{}'.format(quote(tag))
+            ref = nodes.reference('', tag, refuri=uri)
+            ref['classes'].append('his-tag')
+            tag_container.append(ref)
+
+        return tag_container
+
+    def run(self):
+        container = nodes.container(classes=[self.name])
+
+        for site, user_id in self.options.items():
+            if not user_id or site not in self._site_urls:
+                continue
+
+            profile = utility.fetch_stack_exchange_profile(site, user_id)
+
+            item = nodes.container(classes=[f'{self.name}-item', f'{self.name}-{site}'])
+            item.append(self._create_header(profile, site, user_id))
+            if profile and profile.top_tags:
+                item.append(self._create_top_tags(profile))
+            container.append(item)
+
+        return [container]
+
+
+class TechnologyPreferenceDirective(rst.Directive):
+
+    name = 'his-technology-preference'
+
+    has_content = False
+    option_spec = {
+        'desired': split_tags,
+        'undesired': split_tags,
+    }
+
+    def _create_tag_item(self, tag: str) -> nodes.list_item:
+        uri = 'https://stackoverflow.com/tags/{}'.format(quote(tag))
+        ref = nodes.reference('', tag, refuri=uri)
+        ref['classes'].append('his-tag')
+        return nodes.list_item('', nodes.inline('', '', ref))
+
+    def run(self):
+        desired: list[str] = self.options.get('desired', [])
+        undesired: list[str] = self.options.get('undesired', [])
+
+        container = nodes.container(classes=[self.name])
+        if desired:
+            section = nodes.container(classes=[f'{self.name}-desired'])
+            section.append(nodes.paragraph('', 'I want to work with'))
+            section.append(nodes.bullet_list('', *map(self._create_tag_item, desired)))
+            container.append(section)
+        if undesired:
+            section = nodes.container(classes=[f'{self.name}-undesired'])
+            section.append(nodes.paragraph('', 'I prefer not to work with'))
+            section.append(nodes.bullet_list('', *map(self._create_tag_item, undesired)))
+            container.append(section)
+
+        return [container]
+
+
+class SummaryDirective(rst.Directive):
+
+    name = 'his-summary'
+
+    has_content = True
+
+    def run(self):
+        self.assert_has_content()
+        container = nodes.container(classes=[self.name])
+        self.state.nested_parse(self.content, self.content_offset, container)
+        return [container]
+
+
+class JobDirective(rst.Directive):
+
+    name = 'his-job'
+    section_title = 'Experience'
+
+    has_content = True
+    option_spec = {
+        'company-name': unchanged,
+        'company-website': unchanged,
+        'role': unchanged,
+        'start': date.fromisoformat,
+        'finish': date.fromisoformat,
+        'technology': split_tags,
+    }
+
+    def run(self):
+        company_name: str = self.options.get('company-name', '')
+        company_website: str | None = self.options.get('company-website')
+        role: str = self.options.get('role', '')
+        start: date | None = self.options.get('start')
+        finish: date | None = self.options.get('finish')
+        technology: list[str] = self.options.get('technology', [])
+
+        result = []
+        if not getattr(self.state.document, '_his_job_seen', False):
+            self.state.document._his_job_seen = True
+            title = nodes.paragraph('', self.section_title, classes=['his-section-title'])
+            result.append(title)
+
+        container = nodes.container(classes=[self.name])
+
+        header = nodes.container(classes=[f'{self.name}-header'])
+        if company_website:
+            company_ref = nodes.reference('', company_name, refuri=company_website)
+            company_ref['classes'].append('his-link')
+            header.append(nodes.paragraph('', '', company_ref, classes=[f'{self.name}-company']))
+        else:
+            header.append(nodes.paragraph('', company_name, classes=[f'{self.name}-company']))
+
+        if role:
+            header.append(nodes.paragraph('', role, classes=[f'{self.name}-role']))
+
+        date_range = format_date_range(start, finish)
+        if date_range:
+            header.append(nodes.paragraph('', date_range, classes=[f'{self.name}-dates']))
+
+        container.append(header)
+
+        if technology:
+            tech_container = nodes.container(classes=[f'{self.name}-technology'])
+            for tag in technology:
+                uri = 'https://stackoverflow.com/tags/{}'.format(quote(tag))
+                ref = nodes.reference('', tag, refuri=uri)
+                ref['classes'].append('his-tag')
+                tech_container.append(ref)
+            container.append(tech_container)
+
+        if self.content:
+            description = nodes.container(classes=[f'{self.name}-description'])
+            self.state.nested_parse(self.content, self.content_offset, description)
+            container.append(description)
+
+        result.append(container)
+        return result
+
+
+class EducationDirective(rst.Directive):
+
+    name = 'his-education'
+    section_title = 'Education'
+
+    has_content = True
+    option_spec = {
+        'institution': unchanged,
+        'institution-website': unchanged,
+        'degree': unchanged,
+        'start': date.fromisoformat,
+        'finish': date.fromisoformat,
+        'technology': split_tags,
+    }
+
+    def run(self):
+        institution: str = self.options.get('institution', '')
+        institution_website: str | None = self.options.get('institution-website')
+        degree: str = self.options.get('degree', '')
+        start: date | None = self.options.get('start')
+        finish: date | None = self.options.get('finish')
+        technology: list[str] = self.options.get('technology', [])
+
+        result = []
+        if not getattr(self.state.document, '_his_education_seen', False):
+            self.state.document._his_education_seen = True
+            title = nodes.paragraph('', self.section_title, classes=['his-section-title'])
+            result.append(title)
+
+        container = nodes.container(classes=[self.name])
+
+        header = nodes.container(classes=[f'{self.name}-header'])
+        if institution_website:
+            ref = nodes.reference('', institution, refuri=institution_website)
+            ref['classes'].append('his-link')
+            header.append(nodes.paragraph('', '', ref, classes=[f'{self.name}-institution']))
+        else:
+            header.append(nodes.paragraph('', institution, classes=[f'{self.name}-institution']))
+
+        if degree:
+            header.append(nodes.paragraph('', degree, classes=[f'{self.name}-degree']))
+
+        date_range = format_date_range(start, finish)
+        if date_range:
+            header.append(nodes.paragraph('', date_range, classes=[f'{self.name}-dates']))
+
+        container.append(header)
+
+        if technology:
+            tech_container = nodes.container(classes=[f'{self.name}-technology'])
+            for tag in technology:
+                uri = 'https://stackoverflow.com/tags/{}'.format(quote(tag))
+                ref = nodes.reference('', tag, refuri=uri)
+                ref['classes'].append('his-tag')
+                tech_container.append(ref)
+            container.append(tech_container)
+
+        if self.content:
+            description = nodes.container(classes=[f'{self.name}-description'])
+            self.state.nested_parse(self.content, self.content_offset, description)
+            container.append(description)
+
+        result.append(container)
+        return result
+
+
+class ProjectDirective(rst.Directive):
+
+    name = 'his-project'
+    section_title = 'Projects'
+
+    has_content = True
+    option_spec = {
+        'name': unchanged,
+        'url': unchanged,
+        'start': date.fromisoformat,
+        'finish': date.fromisoformat,
+        'technology': split_tags,
+    }
+
+    def run(self):
+        name: str = self.options.get('name', '')
+        url: str | None = self.options.get('url')
+        start: date | None = self.options.get('start')
+        finish: date | None = self.options.get('finish')
+        technology: list[str] = self.options.get('technology', [])
+
+        result = []
+        if not getattr(self.state.document, '_his_project_seen', False):
+            self.state.document._his_project_seen = True
+            title = nodes.paragraph('', self.section_title, classes=['his-section-title'])
+            result.append(title)
+
+        container = nodes.container(classes=[self.name])
+
+        header = nodes.container(classes=[f'{self.name}-header'])
+        if url:
+            ref = nodes.reference('', name, refuri=url)
+            ref['classes'].append('his-link')
+            header.append(nodes.paragraph('', '', ref, classes=[f'{self.name}-name']))
+        else:
+            header.append(nodes.paragraph('', name, classes=[f'{self.name}-name']))
+
+        date_range = format_date_range(start, finish)
+        if date_range:
+            header.append(nodes.paragraph('', date_range, classes=[f'{self.name}-dates']))
+
+        container.append(header)
+
+        if technology:
+            tech_container = nodes.container(classes=[f'{self.name}-technology'])
+            for tag in technology:
+                uri = 'https://stackoverflow.com/tags/{}'.format(quote(tag))
+                ref = nodes.reference('', tag, refuri=uri)
+                ref['classes'].append('his-tag')
+                tech_container.append(ref)
+            container.append(tech_container)
+
+        if self.content:
+            description = nodes.container(classes=[f'{self.name}-description'])
+            self.state.nested_parse(self.content, self.content_offset, description)
+            container.append(description)
+
+        result.append(container)
+        return result

historie/exporters.py

@@ -0,0 +1,32 @@
+import io
+from typing import BinaryIO
+
+from docutils.core import publish_string
+
+from .directives import register_directives
+from .html_writer import HistorieHtmlWriter
+
+
+__all__ = 'registry',
+
+
+def export_html(source_rst: str, output_file: BinaryIO):
+    register_directives()
+    writer = HistorieHtmlWriter()
+    html = publish_string(source_rst, writer=writer)
+    output_file.write(html)
+
+
+def export_pdf(source_rst: str, output_file: BinaryIO):
+    import weasyprint
+
+    buffer = io.BytesIO()
+    export_html(source_rst, buffer)
+
+    weasyprint.HTML(file_obj=buffer).write_pdf(output_file)
+
+
+registry = {
+    'html': export_html,
+    'pdf': export_pdf,
+}

historie/html_writer.py

@@ -0,0 +1,61 @@
+from pathlib import Path
+
+from docutils import nodes
+from docutils.writers import html5_polyglot
+
+from . import utility
+
+
+__all__ = 'HistorieHtmlWriter',
+
+
+class HistorieHtmlTranslator(html5_polyglot.HTMLTranslator):
+
+    def visit_reference(self, node: nodes.reference):
+        if 'his-link' in node.get('classes', []):
+            refuri = node.get('refuri', '')
+            if refuri:
+                favicon = utility.fetch_favicon(refuri)
+                self.body.append(f'<img src="{favicon}" class="favicon" alt="" />')
+
+        super().visit_reference(node)
+
+    def visit_paragraph(self, node):
+        if 'his-section-title' in node.get('classes', []):
+            self.body.append(self.starttag(node, 'h2', ''))
+            self.context.append('</h2>\n')
+        else:
+            super().visit_paragraph(node)
+
+    def depart_paragraph(self, node):
+        if 'his-section-title' in node.get('classes', []):
+            self.body.append(self.context.pop())
+        else:
+            super().depart_paragraph(node)
+
+    def visit_list_item(self, node):
+        if 'his-contacts-name' in node.get('classes', []):
+            self.body.append(self.starttag(node, 'h1', ''))
+            self.context.append('</h1>\n')
+        else:
+            super().visit_list_item(node)
+
+    def depart_list_item(self, node):
+        if 'his-contacts-name' in node.get('classes', []):
+            self.body.append(self.context.pop())
+        else:
+            super().depart_list_item(node)
+
+
+class HistorieHtmlWriter(html5_polyglot.Writer):
+
+    config_section = 'historie writer'
+
+    def __init__(self):
+        super().__init__()
+        self.translator_class = HistorieHtmlTranslator
+
+    settings_default_overrides = {
+        'stylesheet_path': [str(Path(__file__).parent / 'static' / 'style.css')],
+        'embed_stylesheet': True,
+    }

historie/static/default_favicon.svg

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="#718096" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
+  <circle cx="12" cy="12" r="10"/>
+  <line x1="2" y1="12" x2="22" y2="12"/>
+  <path d="M12 2a15.3 15.3 0 0 1 4 10 15.3 15.3 0 0 1-4 10 15.3 15.3 0 0 1-4-10 15.3 15.3 0 0 1 4-10z"/>
+</svg>