Metadata-Version: 2.1
Name: pubdoc
Version: 0.5.2
Summary: Make technical documentstion from data sets
Home-page: https://github.com/brobots-corporation/pubdoc
Author: Evgenii Alaev
Author-email: ev.alaev@yandex.ru
License: GPL-3.0
Project-URL: Bug Reports, https://github.com/brobots-corporation/pubdoc/issues
Project-URL: Source, https://github.com/brobots-corporation/pubdoc
Description: 
        # pubdoc
        Публикация документации
        
        [![Build Status](https://travis-ci.org/brobots-corporation/pubdoc.svg?branch=master)](https://travis-ci.org/brobots-corporation/pubdoc)
        [![](https://img.shields.io/pypi/v/pubdoc.svg?style=flat&color=blue)](https://pypi.org/project/pubdoc/)
        [![](https://img.shields.io/pypi/pyversions/pubdoc.svg)](https://pypi.python.org/pypi/pubdoc/)
        [![](https://img.shields.io/badge/license-GPL3-yellow.svg)](https://github.com/brobots-corporation/pubdoc/blob/master/LICENSE)
        
        ## Возможности
        * Работа в ОС семейства: `Linux`, `Mac OS X`, `Windows`;
        * Подерживается публикация на:
          * [DokuWiki](https://www.dokuwiki.org/)
        
        ## Установка и обновление
        
        * Установить Python версии не ниже 3.6;
        * Установить пакет d2doc из PyPI командой:
            ```sh
            pip install d2doc
            ```
        * Для обновления пакета необходимо воспользоваться командой:
            ```sh
            pip install -U d2doc
        
        ## Использование скрипта
        ```
        Usage: pubdoc.py [OPTIONS] COMMAND [ARGS]...
        
        Options:
          --log-level TEXT  Log level [CRITICAL, FATAL, ERROR, WARNING, DEBUG, INFO,
                            NOTSET]
          --help            Show this message and exit.
        
        Commands:
          dokuwiki
        ```  
        ### Публикация на DokuWiki
        Команда `dokuwiki`
        ```
        Usage: pubdoc dokuwiki [OPTIONS]
        
        Options:
          -t, --target TEXT         Dokuwiki url.  [required]
          --username TEXT           Dokuwiki username.  [required]
          --password TEXT           Dokuwiki password.  [required]
          -n, --namespace TEXT      Dokuwiki namespace.  [required]
          -d, --data-dir PATH       Input data dir.  [required]
          -m, --data-dir-mask TEXT  Files mask for option '--data-dir'.
          --help                    Show this message and exit.
        ```
        
        #### Пример использования скрипта в Linux
        ```sh
        pubdoc dokuwiki \
            --target 'https://bla.bla.com' \
            --username 'Логин' \
            --password 'Пароль' \
            --namespace 'Проект 1:Техническая документация' \
            --data-dir './testdocs' \
            --data-dir-mask '**/*.md'
        ```
        
        #### Пример использования скрипта в Linux c использованием переменных среды
        ```sh
        export PUBDOC_DOKUWIKI_TARGET='https://bla.bla.com'
        export PUBDOC_DOKUWIKI_USERNAME='Логин'
        export PUBDOC_DOKUWIKI_PASSWORD='Пароль'
        export PUBDOC_DOKUWIKI_NAMESPACE='Проект 1:Техническая документация'
        export PUBDOC_DOKUWIKI_DATA_DIR='./testdocs'
        export PUBDOC_DOKUWIKI_DATA_DIR_MASK='**/*.md'
        export PUBDOC_LOG_LEVEL='DEBUG'
        pubdoc dokuwiki 
        ```
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: Russian
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
