GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - openkm/python-wrapper: Python API client implementation

BranchesTags
Open more actions menu

Latest commit

 

History

7 Commits
7 Commits

Folders and files

NameName
Last commit message
Last commit date
OKMObjects
OKMObjects
 
 
.gitignore
.gitignore
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
setup.py
setup.py
 
 

Repository files navigation

PyOKM

Python wrapper of the OpenKM RESTful API.


Install

Go to the downloaded folder and execute on command line:

sudo python setup.py install

Use

To use the package, you can import it with:

from OKMObjects.okmDocument import OkmDocument

Now, you only have to create a new OkmDocument and call the methods that you need.

mDocumentAPI = OkmDocument('username', 'password', 'http://<localhost>:8080/OpenKM')

mDocumentAPI.getDocument('<document-route>', '<destination-name>')
mDocumentAPI.deleteDocument('<document-route>')

Methods

The methods that are available to use in this package are

deleteDocument(srcPath)

@srcPath could be the UUID or the route of the file in the OKM Server.

This method deletes a concrete document.

getDocument(srcPath, dstName)

@srcPath could be the UUID or the route of the file in the OKM Server. @dstName is the name that the file will have in our computer.

This method downloads a concrete document.

getDocumentProperties(srcPath)

@srcPath could be the UUID or the route of the file in the OKM Server.

This method downloads the properties of a concrete document into a JSON file.

getDocumentVersionHistory(srcPath)

@srcPath could be the UUID or the route of the file in the OKM Server.

This method downloads the versions history of a concrete document into a JSON file.

copyDocument(srcPath, dstPath)

@srcPath could be the UUID or the route of the file in the OKM Server. @dstPath is the route of the file in the OKM Server.

This method duplicates the document into the destination path.

moveDocument(srcPath, dstPath)

@srcPath could be the UUID or the route of the file in the OKM Server. @dstPath is the route of the file in the OKM Server.

This method moves the document into the destination path.

uploadDocument(srcPatch, dstName)

@srcPath is the local route of the file in our computer. @dstName is the name that the file will have in the OKM Server

This method uploads a document to our server.

About

Python API client implementation

Resources

Readme
GPL-3.0 license
Activity
Custom properties

Stars

4 stars

Watchers

2 watching

Forks

5 forks
Report repository

Releases

Packages

Used by

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.