Giter Club home page Giter Club logo

dash.py's Introduction

Dash.py

Dash.py is a tool that helps you install python documents to Dash easily.

Usage

Installing python documents to Dash via Dash.py is easy

dash.py install flask
dash.py install tornado jinja2 sqlalchemy

Installation

You can install dash.py via pip

pip install dash.py

If you don't have pip, you should install it first

curl https://raw.github.com/pypa/pip/master/contrib/get-pip.py | python

Adding a package

Note

You don't need to add a package which is hosted on rtfd.org . Dash.py can download docset from rtfd.org automatically.

It's pretty easy to add a new package in Dash.py :

  • Fork the project
  • Add a new file in dash_py/packages folder.

Filename should be package_name.yaml . Now that package name should be lower case.

It should be a vailed yaml file.

It looks like

name: Jinja2 # Package name
type: html # Type. Supported types are ``html`` , ``docset`` and ``sphinx``
format: zip  # Format. Should be either ``zip``, ``tar`` or ``git``. Note that Gzipped Tar file should be ``tar``
url: http://jinja.pocoo.org/docs/jinja-docs.zip  # URL to download the file or to clone the git repo.
icon: _static/jinja-small.png  # OPTIONAL. path to icon file.
sphinx_doc_path: doc  # OPTIONAL. If the type is sphinx and sphinx conf file isn't in the root path, you need to provide this.
  • git add && git commit
  • Send a pull request.

dash.py's People

Contributors

whtsky avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

dash.py's Issues

Error when install docsets

% dash.py install werkzeug requests !10138
[I 130730 00:52:39] Downloading package Werkzeug
[I 130730 00:53:03] Creating docset for package Werkzeug
Traceback (most recent call last):
File "/usr/local/bin/dash.py", line 10, in
load_entry_point('dash.py==0.1.1', 'console_scripts', 'dash.py')()
File "/usr/local/Cellar/python/2.7.5/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/dash_py/cli.py", line 88, in main
parguments.run()
File "/usr/local/Cellar/python/2.7.5/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/parguments/init.py", line 176, in run
result = cmd(**args)
File "/usr/local/Cellar/python/2.7.5/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/parguments/init.py", line 19, in call
self._func(**kwargs)
File "/usr/local/Cellar/python/2.7.5/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/dash_py/cli.py", line 39, in install
return [install(n) for n in name]
File "/usr/local/Cellar/python/2.7.5/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/dash_py/cli.py", line 58, in install
install_package(package)
File "/usr/local/Cellar/python/2.7.5/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/dash_py/installer.py", line 98, in install_package
installer(package)
File "/usr/local/Cellar/python/2.7.5/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/dash_py/installer.py", line 58, in html_installer
generate_docset(package, document_path)
File "/usr/local/Cellar/python/2.7.5/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/dash_py/installer.py", line 40, in generate_docset
if call(command):
File "/usr/local/Cellar/python/2.7.5/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/dash_py/utils.py", line 51, in call
code = subprocess.call(shlex.split(command), *_kwargs)
File "/usr/local/Cellar/python/2.7.5/Frameworks/Python.framework/Versions/2.7/lib/python2.7/subprocess.py", line 524, in call
return Popen(_popenargs, **kwargs).wait()
File "/usr/local/Cellar/python/2.7.5/Frameworks/Python.framework/Versions/2.7/lib/python2.7/subprocess.py", line 711, in init
errread, errwrite)
File "/usr/local/Cellar/python/2.7.5/Frameworks/Python.framework/Versions/2.7/lib/python2.7/subprocess.py", line 1308, in _execute_child
raise child_exception
OSError: [Errno 2] No such file or directory

TypeError when trying to install a docset

Tried to run "dash.py install sqlalchemy", but failed:

Traceback (most recent call last):
  File "/usr/local/bin/dash.py", line 9, in <module>
    load_entry_point('dash.py==0.2.1', 'console_scripts', 'dash.py')()
  File "/Library/Python/2.7/site-packages/dash_py/cli.py", line 100, in main
    parguments.run()
  File "/Library/Python/2.7/site-packages/parguments/__init__.py", line 176, in run
    result = cmd(**args)
  File "/Library/Python/2.7/site-packages/parguments/__init__.py", line 19, in __call__
    self._func(**kwargs)
  File "/Library/Python/2.7/site-packages/dash_py/cli.py", line 40, in install
    return [install(n) for n in name]
  File "/Library/Python/2.7/site-packages/dash_py/cli.py", line 58, in install
    install_package(package)
  File "/Library/Python/2.7/site-packages/dash_py/installer.py", line 91, in install_package
    type = package["type"]
TypeError: string indices must be integers, not str

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.