vdmAPI/README.html

88 lines
2.1 KiB
HTML
Raw Normal View History

<!DOCTYPE html><html><head><meta charset="utf-8"><title></title><style type="text/css">body{
font-family: helvetica;
color: #222;
}
li>p{
margin-bottom: 0;
}
.line{
margin-bottom: 0.3em;
display: table;
}
.admonition-title {
font-size: 1.3em;
font-weight: bold;
}
aside{
float: right;
width: 20%;
display: table;
padding: 1em;
margin: 1em;
margin-right: 0;
}
.footnote, .cite{
width: 98%;
display: table;
border: 1px solid #ddd;
padding: 0.5%;
margin: 0.5%;
}
.footnote .du-label, .cite .du-label{
float: left;
height: 100%;
width: 5%;
margin-right: 1em;
padding: 0.5%;
text-align: center;
display: table;
}
th, th p{
font-weight: bold;
}
.field-label{
font-weight: bold;
}
ol.arabic{
list-style-type: decimal;
}
ol.loweralpha{
list-style-type: lower-alpha;
}
ol.upperalpha{
list-style-type: upper-alpha;
}
ol.lowerroman{
list-style-type: lower-roman;
}
ol.upperroman{
list-style-type: upper-roman;
}
img.align-left{
float: left;
}
img.align-right{
float: right;
}
</style></head><body><h1>VDM API</h1><p>V1.0</p><p><strong>VDM API</strong> is a python api for pull random api.</p><section id="use-case"><header><h2>Use case</h2></header><p>You can use this API in python langage by instanciate a VDM() object :</p><pre>from VDMAPI.VDM import VDM
if __name__ == "__main__":
vdm = VDM()
lstAllVDM = vdm.get()
for i, vdm in enumerate(lstAllVDM):
2016-07-20 16:38:50 +00:00
print(str(i)+" : "+vdm)</pre></section><section id="available-gui"><header><h2>Available GUI</h2></header><p><strong>VDM API</strong> include four display mode :</p><ul><li><p><strong>i3</strong> : this GUI use dmenu for display the list of VDM</p></li><li><p><strong>tkinter</strong> : this use tkinter native interface</p></li><li><p><strong>kivy</strong> : use kivy library</p></li><li><p><strong>console</strong> : this last mode display the list of VDM in plain text mode</p></li></ul></section><section id="installing"><header><h2>Installing</h2></header><p>For <strong>setup</strong> you could do with this :</p><pre>pip install --no-index --find-links=&lt;pathToDistIncludeIntoGitClone&gt; VDM_API</pre></section></body></html>