Python Github Examples

Example #1

from docstr_md.python import PySoup, compile_md
from docstr_md.src_href import Github

src_href = Github('https://github.com/dsbowen/hemlock-berlin/blob/master')

path = 'hemlock_berlin/__init__.py'
soup = PySoup(path=path, parser='sklearn', src_href=src_href)
compile_md(soup, compiler='sklearn', outfile='docs_md/api.md')

Example #2

File: mkdocs.py Project: dsbowen/sqlalchemy-nav

from docstr_md.python import PySoup, compile_md
from docstr_md.src_href import Github

src_href = Github('https://github.com/dsbowen/sqlalchemy-nav/blob/master')
path = 'sqlalchemy_nav/__init__.py'
soup = PySoup(path=path, parser='sklearn', src_href=src_href)
soup.rm_properties()
for obj in soup.objects:
    if hasattr(obj, 'name'):
        if obj.name == 'NavbarMixin':
            obj.rm_methods('navitems')
        elif obj.name == 'NavitemMixin':
            obj.rm_methods('dropdownitems')
compile_md(soup, compiler='sklearn', outfile='docs_md/api.md')

Example #3

File: example.py Project: dsbowen/docstr-md

from docstr_md.python import PySoup, compile_md
from docstr_md.src_href import Github

src_href = Github('https://github.com/dsbowen/docstr-md/blob/master')
soup = PySoup(path='test.py', parser='sklearn', src_href=src_href)
compile_md(soup, compiler='sklearn', outfile='docs_md/test.md')

Example #4

File: mkdocs.py Project: dsbowen/smoother

from docstr_md.python import PySoup, compile_md
from docstr_md.src_href import Github

import os

src_href = Github('https://github.com/dsbowen/smoother/blob/master')

path = 'smoother/smoother.py'
soup = PySoup(path=path, parser='sklearn', src_href=src_href)
soup.import_path = 'smoother'
soup.rm_properties()
compile_md(soup, compiler='sklearn', outfile='docs_md/smoother.md')

path = 'smoother/max_entropy.py'
soup = PySoup(path=path, parser='sklearn', src_href=src_href)
soup.import_path = 'smoother'
soup.rm_properties
compile_md(soup, compiler='sklearn', outfile='docs_md/max_entropy.md')

path = 'smoother/utils.py'
soup = PySoup(path=path, parser='sklearn', src_href=src_href)
soup.import_path = 'smoother'
compile_md(soup, compiler='sklearn', outfile='docs_md/utils.md')

Example #5

File: mkdocs.py Project: dsbowen/hemlock-demographics

from docstr_md.python import PySoup, compile_md
from docstr_md.src_href import Github

src_href = Github(
    'https://github.com/dsbowen/hemlock-demographics/blob/master')

path = 'hemlock_demographics/__init__.py'
soup = PySoup(path=path, parser='sklearn', src_href=src_href)
soup.keep_objects('demographics', 'comprehensive_demographics',
                  'basic_demographics', 'family_demographics',
                  'country_demographics', 'status_demographics', 'register')
compile_md(soup, compiler='sklearn', outfile='docs_md/api.md')

Example #6

File: mkdocs.py Project: dsbowen/gshap

from docstr_md.python import PySoup, compile_md
from docstr_md.src_href import Github

src_href = Github('https://github.com/dsbowen/gshap/blob/master')

soup = PySoup(path='gshap/__init__.py', parser='sklearn', src_href=src_href)
soup.rm_properties()
compile_md(soup, compiler='sklearn', outfile='docs_md/kernel_explainer.md')

g_functions = ('hypothesis', 'intergroup', 'probability_distance')
for g in g_functions:
    soup = PySoup(path='gshap/{}.py'.format(g),
                  parser='sklearn',
                  src_href=src_href)
    compile_md(soup, compiler='sklearn', outfile='docs_md/{}.md'.format(g))

soup = PySoup(path='gshap/datasets/__init__.py',
              parser='sklearn',
              src_href=src_href)
compile_md(soup, compiler='sklearn', outfile='docs_md/datasets.md')

Example #7

File: mkdocs.py Project: dsbowen/fast-automl

from docstr_md.python import PySoup, compile_md
from docstr_md.src_href import Github

import os

src_href = Github('https://github.com/dsbowen/fast-automl/blob/master')
filenames = [
    'automl',
    'baseline',
    'cv_estimators',
    'ensemble',
    'linear_model',
    'metrics',
    'test',
    'utils'
]
for filename in filenames:
    path = os.path.join('fast_automl', filename+'.py')
    soup = PySoup(path=path, parser='sklearn', src_href=src_href)
    outfile = os.path.join('docs_md', 'api', filename+'.md')
    # outfile = 'docs_md/'+filename+'.md'
    compile_md(soup, compiler='sklearn', outfile=outfile)

Example #8

File: mkdocs.py Project: dsbowen/selenium-tools

from docstr_md.python import PySoup, compile_md
from docstr_md.src_href import Github

src_href = Github('https://github.com/dsbowen/selenium-tools/blob/master')

path = 'selenium_tools/__init__.py'
soup = PySoup(path=path, src_href=src_href)
compile_md(soup, outfile='docs_md/api.md')

Example #9

from docstr_md.python import PySoup, compile_md
from docstr_md.src_href import Github

import os

src_href = Github('https://github.com/dsbowen/dash-fcast/blob/master')

path = 'dash_fcast/table.py'
soup = PySoup(path=path, parser='sklearn', src_href=src_href)
soup.import_path = 'dash_fcast'
table_cls = soup.objects[-1]
table_cls.rm_methods('to_plotly_json')
compile_md(soup, compiler='sklearn', outfile='docs_md/table.md')

dist_path = 'dash_fcast/distributions'
outfile_path = 'docs_md/distributions'

path = os.path.join(dist_path, '__init__.py')
soup = PySoup(path=path, parser='sklearn', src_href=src_href)
outfile = os.path.join(outfile_path, 'utils.md')
compile_md(soup, compiler='sklearn', outfile=outfile)

dist_files = ('moments', 'table')

for f in dist_files:
    path = os.path.join(dist_path, f + '.py')
    soup = PySoup(path=path, parser='sklearn', src_href=src_href)
    soup.import_path = dist_path
    for obj in soup.objects:
        try:
            obj.rm_methods('to_plotly_json')

Example #10

from docstr_md.python import PySoup, compile_md
from docstr_md.src_href import Github

src_href = Github(
    'https://github.com/dsbowen/sqlalchemy-mutablesoup/blob/master')

path = 'sqlalchemy_mutablesoup/__init__.py'
soup = PySoup(path=path, parser='sklearn', src_href=src_href)
for obj in soup.objects:
    if hasattr(obj, 'name'):
        if obj.name == 'MutableSoup':
            obj.methods = [m for m in obj.methods if m.name == 'set_element']
        elif obj.name == 'MutableSoupType':
            obj.methods.clear()
compile_md(soup, compiler='sklearn', outfile='docs_md/use.md')

Example #11

from docstr_md.python import PySoup, compile_md
from docstr_md.src_href import Github

src_href = Github('https://github.com/dsbowen/flask-worker/blob/master')

path = 'flask_worker/__init__.py'
soup = PySoup(path=path, parser='sklearn', src_href=src_href)
soup.rm_properties()
compile_md(soup, compiler='sklearn', outfile='docs_md/manager.md')

path = 'flask_worker/worker_mixin.py'
soup = PySoup(path=path, parser='sklearn', src_href=src_href)
soup.rm_properties()
soup.import_path = 'flask_worker'
compile_md(soup, compiler='sklearn', outfile='docs_md/worker_mixin.md')

path = 'flask_worker/router_mixin.py'
soup = PySoup(path=path, parser='sklearn', src_href=src_href)
soup.rm_properties()
soup.import_path = 'flask_worker'
compile_md(soup, compiler='sklearn', outfile='docs_md/router_mixin.md')

Example #12

from docstr_md.python import PySoup, compile_md
from docstr_md.src_href import Github

src_href = Github('https://github.com/dsbowen/flask-download-btn/blob/master')

path = 'flask_download_btn/__init__.py'
soup = PySoup(path=path, parser='sklearn', src_href=src_href)
compile_md(soup, compiler='sklearn', outfile='docs_md/manager.md')

path = 'flask_download_btn/download_btn_mixin.py'
soup = PySoup(path=path, parser='sklearn', src_href=src_href)
soup.rm_properties()
soup.objects[-1].rm_methods('handle_form_functions', 'create_file_functions')
soup.import_path = 'flask_download_btn'
compile_md(soup, compiler='sklearn', outfile='docs_md/download_btn_mixin.md')