Package: mllib
A REST client forMarkLogic 8documentation
management.MarkLogic 8is a NOSQL database and application framework for documentation
management applications.This package is still at an early WIP state and APIs may change before the
first release.As said in the subtitle, this package focuses ondocumentation management
services(CRUD operations, searching, …). If you need a pythonic way to
create, fine tune and populateMarkLogic 8databases and clusters, you may
preferMarkLogic_Python.Hey! Where are the docsAs above written, this package is at an early stage of development, and
writing a cool doc with an API and features that may change before the first
beta release is a waste of time.Meanwhile, you may read and play with the code that’s in thesandbox/directory that explores most features of the provided resources.InstallationJump toContributingif you want the full source distro and contribute to
the project. Others will usepipto installmlliblike this, as long
as it is not yet available on PyPI.pip install git+https://github.com/glenfant/mllib.git#egg=mllibSeehttps://pip.pypa.io/en/latest/reference/pip_install.html#gitif you need a
specific Git branch, tag or commit hash.Developer notesPlease use a virtualenv to maintain this package, but I should not need to say
that.Grab the source from the SCM repository$gitclonehttps://github.com/glenfant/mllib.git$pythonsetup.pydevelop$pipinstallmllib[dev]Run the testsRunning the tests require :Connection tohttp://httpbin.org/. If you can see its home page in your browser, it’s OKRunning a MarkLogic 8 REST tests instance athttp://localhost:8000with
username and password being bothadmin. If you prefer to use another
instance listening on port9000of hostmy.marklogic-rest.tldand
which user isfooauthenticated by passwordbar, you need to provide
this in aMLLIB_TEST_SERVERenvironment variable that containsmy.marklogic-rest.tld:9000:foo:bar.if your MarkLogic REST server expects an HTTP Basic Authentication token, append:basicto theMLLIB_TEST_SERVERenvironment variable. Otherwise an HTTP
Digest Auth token will be issued.$exportMLLIB_TEST_SERVER=my.marklogic-rest.tld:9000:foo:bar# Optional$pythonsetup.pytest$pythonrun_tests.pyBuild the Sphinx documentation$pythonsetup.pybuild_sphinx$firefoxbuild/sphinx/html/index.htmlContributingRegister toGithubif not already done.Please file a ticket at theGithub trackerthat explains your feature or
improvement.Fork the project in your personal repositoryDo the jobAlways check the existing unit tests (see above) and add unit tests that
verify your feature or bugfix.Prefer “git rebase” to “git merge” when synching with the original master.
See the worflow explained athttp://blog.bigbinary.com/2013/09/13/how-to-keep-your-fork-uptodate.htmlIssue a pull request when you’re done, mentioning the original ticket you
created at step 2.Don’t forget to “star” the project on Github if you like it. ;)LinksProject home pagehttps://github.com/glenfant/mllibIssues trackerhttps://github.com/glenfant/mllib/isuesCreditsThe development of this library is sponsored by theAssemblée Nationale(France’s Chamber of Deputies).Project leader :Gilles LenfantLicenseThis software is distributed under the terms of theMIT license.Changes log1.0.0a2Fixed packaging issue
[glenfant]1.0.0a1No changes. Just a version normalization.1.0.0.a1First release.Package creation withbobtemplates.gillux[glenfant]