html
Directory actions
More options
Directory actions
More options
html
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
parent directory.. | ||||
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>OpenSchemas Python — openschemes Python 0.0.14 documentation</title>
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installation" href="installation.html" />
<link rel="prev" title="Welcome to OpenSchemas Python!" href="index.html" />
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> openschemes Python
<img src="_static/logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.0.14
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">OpenSchemas Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="#quick-start">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">openschemas</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributor’s Agreement</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html#contributing">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html#code-of-conduct">Code of Conduct</a></li>
<li class="toctree-l1"><a class="reference internal" href="authors.html">Authors</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
</ul>
<p class="caption"><span class="caption-text">Links:</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://www.github.com/openschemas/openschemas-python">Github</a></li>
<li class="toctree-l1"><a class="reference external" href="https://openschemas.github.io">Open Schemas</a></li>
<li class="toctree-l1"><a class="reference external" href="https://www.github.com/openschemas/openschemas-python/issues">Issues</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">openschemes Python</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>OpenSchemas Python</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/readme.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="openschemas-python">
<h1>OpenSchemas Python<a class="headerlink" href="#openschemas-python" title="Permalink to this headline">¶</a></h1>
<a class="reference external image-reference" href="https://circleci.com/gh/openschemas/openschemas-python"><img alt="CircleCI" src="https://circleci.com/gh/openschemas/openschemas-python.svg?style=svg" /></a>
<a class="reference external image-reference" href="https://badge.fury.io/py/openschemas"><img alt="PyPI version" src="https://badge.fury.io/py/openschemas.svg" /></a>
<a class="reference external image-reference" href="https://github.com/openschemas/spec-template/raw/master/img/hexagon_square_small.png"><img alt="https://github.com/openschemas/spec-template/raw/master/img/hexagon_square_small.png" src="https://github.com/openschemas/spec-template/raw/master/img/hexagon_square_small.png" /></a>
<hr class="docutils" />
<p>This is a small module with helper functions and scripts for interacting with schema.org
specifications, provided as an <a class="reference external" href="https://www.github.com/openschemas">openschemas</a> tool.<span class="raw-html-m2r"><br></span>
Please contribute at <a class="reference external" href="https://www.github.com/openschemas/openschemas-python">openschemas/openschemas-python</a> on
Github. Documentation will be provided as the library is developed.</p>
</div>
<div class="section" id="quick-start">
<h1>Quick Start<a class="headerlink" href="#quick-start" title="Permalink to this headline">¶</a></h1>
<p>To install</p>
<div class="highlight-guess"><div class="highlight"><pre><span></span>git clone https://www.github.com/openschemas/openschemas-python
cd openschemas-python
python setup.py install
</pre></div>
</div>
<p>or the package is hosted on <a class="reference external" href="https://pypi.org/project/openschemas/">pypi</a> and
can be installed with pip:</p>
<div class="highlight-guess"><div class="highlight"><pre><span></span>$ pip install openschemas
<span class="c1"># See the version</span>
$ openschemas --version
<span class="c1"># Run map2model</span>
$ map2model --config configuration.yml --folder specifications
<span class="c1"># Run specification validator</span>
$ openschemas validate --criteria openschemas/main/validate/criteria/dummy.yml --infile Container.html
</pre></div>
</div>
<p>For usage, please see our <a class="reference external" href="https://openschemas.github.io/openschemas-python/html/usage.html">documentation</a> <strong>under development</strong></p>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral" title="Welcome to OpenSchemas Python!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, Vanessa Sochat.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.0.14',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>