| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| |
| |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| |
| <title>About Apache Chemistry cmislib — Apache Chemistry cmislib 0.6.0 documentation</title> |
| |
| <link rel="stylesheet" href="_static/classic.css" type="text/css" /> |
| <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT: './', |
| VERSION: '0.6.0', |
| 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> |
| <link rel="author" title="About these documents" href="#" /> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="Installation" href="install.html" /> |
| <link rel="prev" title="Welcome to the Apache Chemistry cmislib documentation!" href="index.html" /> |
| </head> |
| <body role="document"> |
| <div class="related" role="navigation" aria-label="related navigation"> |
| <h3>Navigation</h3> |
| <ul> |
| <li class="right" style="margin-right: 10px"> |
| <a href="genindex.html" title="General Index" |
| accesskey="I">index</a></li> |
| <li class="right" > |
| <a href="py-modindex.html" title="Python Module Index" |
| >modules</a> |</li> |
| <li class="right" > |
| <a href="install.html" title="Installation" |
| accesskey="N">next</a> |</li> |
| <li class="right" > |
| <a href="index.html" title="Welcome to the Apache Chemistry cmislib documentation!" |
| accesskey="P">previous</a> |</li> |
| <li class="nav-item nav-item-0"><a href="index.html">Apache Chemistry cmislib 0.6.0 documentation</a> »</li> |
| </ul> |
| </div> |
| |
| <div class="document"> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| <div class="body" role="main"> |
| |
| <div class="section" id="about-apache-chemistry-cmislib"> |
| <h1>About Apache Chemistry cmislib<a class="headerlink" href="#about-apache-chemistry-cmislib" title="Permalink to this headline">¶</a></h1> |
| <p>The goal of this project is to create a CMIS client for Python that can be used to work with any CMIS-compliant repository.</p> |
| <dl class="docutils"> |
| <dt>The library is being developed with the following guidelines:</dt> |
| <dd><ul class="first last simple"> |
| <li>Developers using this API should be able to work with CMIS domain objects without having to worry about the underlying implementation details.</li> |
| <li>The library will use the Resftul AtomPub Binding and the Browser Binding (added with CMIS 1.1).</li> |
| <li>The library will conform to the <a class="reference external" href="http://docs.oasis-open.org/cmis/CMIS/v1.1/CMIS-v1.1.html">CMIS spec</a> as closely as possible. Several public CMIS repositories are being used to test the API.</li> |
| <li>The library should have no hard-coded URL’s. It should be able to get everything it needs regarding how to work with the CMIS service from the CMIS service URL response and subsequent calls.</li> |
| <li>There shouldn’t have to be a vendor-specific version of this library. The goal is for it to be interoperable with CMIS-compliant providers.</li> |
| </ul> |
| </dd> |
| </dl> |
| <div class="section" id="quick-example"> |
| <h2>Quick Example<a class="headerlink" href="#quick-example" title="Permalink to this headline">¶</a></h2> |
| <dl class="docutils"> |
| <dt>This should give you an idea of how easy and natural it is to work with the API:</dt> |
| <dd><div class="first last highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">cmisClient</span> <span class="o">=</span> <span class="n">cmislib</span><span class="o">.</span><span class="n">CmisClient</span><span class="p">(</span><span class="s1">'http://localhost:8080/alfresco/api/-default-/public/cmis/versions/1.1/atom'</span><span class="p">,</span> <span class="s1">'admin'</span><span class="p">,</span> <span class="s1">'admin'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">repo</span> <span class="o">=</span> <span class="n">cmisClient</span><span class="o">.</span><span class="n">defaultRepository</span> |
| <span class="gp">>>> </span><span class="n">rootFolder</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">rootFolder</span> |
| <span class="gp">>>> </span><span class="n">children</span> <span class="o">=</span> <span class="n">rootFolder</span><span class="o">.</span><span class="n">getChildren</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">newFolder</span> <span class="o">=</span> <span class="n">rootFolder</span><span class="o">.</span><span class="n">createFolder</span><span class="p">(</span><span class="s1">'testDeleteFolder folder'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">props</span> <span class="o">=</span> <span class="n">newFolder</span><span class="o">.</span><span class="n">properties</span> |
| <span class="gp">>>> </span><span class="n">newFolder</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span> |
| </pre></div> |
| </div> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| |
| |
| </div> |
| </div> |
| </div> |
| <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
| <div class="sphinxsidebarwrapper"> |
| <h3><a href="index.html">Table Of Contents</a></h3> |
| <ul> |
| <li><a class="reference internal" href="#">About Apache Chemistry cmislib</a><ul> |
| <li><a class="reference internal" href="#quick-example">Quick Example</a></li> |
| </ul> |
| </li> |
| </ul> |
| |
| <h4>Previous topic</h4> |
| <p class="topless"><a href="index.html" |
| title="previous chapter">Welcome to the Apache Chemistry cmislib documentation!</a></p> |
| <h4>Next topic</h4> |
| <p class="topless"><a href="install.html" |
| title="next chapter">Installation</a></p> |
| <div role="note" aria-label="source link"> |
| <h3>This Page</h3> |
| <ul class="this-page-menu"> |
| <li><a href="_sources/about.rst.txt" |
| rel="nofollow">Show Source</a></li> |
| </ul> |
| </div> |
| <div id="searchbox" style="display: none" role="search"> |
| <h3>Quick search</h3> |
| <form class="search" action="search.html" method="get"> |
| <div><input type="text" name="q" /></div> |
| <div><input type="submit" value="Go" /></div> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| <script type="text/javascript">$('#searchbox').show(0);</script> |
| </div> |
| </div> |
| <div class="clearer"></div> |
| </div> |
| <div class="related" role="navigation" aria-label="related navigation"> |
| <h3>Navigation</h3> |
| <ul> |
| <li class="right" style="margin-right: 10px"> |
| <a href="genindex.html" title="General Index" |
| >index</a></li> |
| <li class="right" > |
| <a href="py-modindex.html" title="Python Module Index" |
| >modules</a> |</li> |
| <li class="right" > |
| <a href="install.html" title="Installation" |
| >next</a> |</li> |
| <li class="right" > |
| <a href="index.html" title="Welcome to the Apache Chemistry cmislib documentation!" |
| >previous</a> |</li> |
| <li class="nav-item nav-item-0"><a href="index.html">Apache Chemistry cmislib 0.6.0 documentation</a> »</li> |
| </ul> |
| </div> |
| <div class="footer" role="contentinfo"> |
| © Copyright 2017, Apache Software Foundation. |
| Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.1. |
| </div> |
| </body> |
| </html> |
