{ "info": { "author": "Gilles Lenfant", "author_email": "gilles.lenfant@alterway.fr", "bugtrack_url": null, "classifiers": [ "Development Status :: 2 - Pre-Alpha", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Topic :: Database :: Front-Ends", "Topic :: Software Development :: Documentation" ], "description": "=====\r\nmllib\r\n=====\r\n\r\nA REST client for `MarkLogic 8 `_ documentation\r\nmanagement.\r\n\r\n`MarkLogic 8`_ is a NOSQL database and application framework for documentation\r\nmanagement applications.\r\n\r\nThis package is still at an early WIP state and APIs may change before the\r\nfirst release.\r\n\r\nAs said in the subtitle, this package focuses on **documentation management\r\nservices** (CRUD operations, searching, ...). If you need a pythonic way to\r\ncreate, fine tune and populate `MarkLogic 8`_ databases and clusters, you may\r\nprefer `MarkLogic_Python `_.\r\n\r\nHey! Where are the docs\r\n=======================\r\n\r\nAs above written, this package is at an early stage of development, and\r\nwriting a cool doc with an API and features that may change before the first\r\nbeta release is a waste of time.\r\n\r\nMeanwhile, you may read and play with the code that's in the ``sandbox/``\r\ndirectory that explores most features of the provided resources.\r\n\r\nInstallation\r\n============\r\n\r\nJump to `Contributing`_ if you want the full source distro and contribute to\r\nthe project. Others will use ``pip`` to install ``mllib`` like this, as long\r\nas it is not yet available on PyPI.\r\n\r\n.. code:: console\r\n\r\n pip install git+https://github.com/glenfant/mllib.git#egg=mllib\r\n\r\nSee https://pip.pypa.io/en/latest/reference/pip_install.html#git if you need a\r\nspecific Git branch, tag or commit hash.\r\n\r\nDeveloper notes\r\n===============\r\n\r\nPlease use a virtualenv to maintain this package, but I should not need to say\r\nthat.\r\n\r\nGrab the source from the SCM repository\r\n---------------------------------------\r\n\r\n.. code:: console\r\n\r\n $ git clone https://github.com/glenfant/mllib.git\r\n $ python setup.py develop\r\n $ pip install mllib[dev]\r\n\r\nRun the tests\r\n-------------\r\n\r\nRunning the tests require :\r\n\r\n- Connection to http://httpbin.org/ . If you can see its home page in your browser, it's OK\r\n\r\n- Running a MarkLogic 8 REST tests instance at http://localhost:8000 with\r\n username and password being both ``admin``. If you prefer to use another\r\n instance listening on port ``9000`` of host ``my.marklogic-rest.tld`` and\r\n which user is ``foo`` authenticated by password ``bar``, you need to provide\r\n this in a ``MLLIB_TEST_SERVER`` environment variable that contains\r\n ``my.marklogic-rest.tld:9000:foo:bar``.\r\n\r\n if your MarkLogic REST server expects an HTTP Basic Authentication token, append\r\n ``:basic`` to the ``MLLIB_TEST_SERVER`` environment variable. Otherwise an HTTP\r\n Digest Auth token will be issued.\r\n\r\n.. code:: console\r\n\r\n $ export MLLIB_TEST_SERVER=my.marklogic-rest.tld:9000:foo:bar # Optional\r\n $ python setup.py test\r\n $ python run_tests.py\r\n\r\nBuild the Sphinx documentation\r\n------------------------------\r\n\r\n.. code:: console\r\n\r\n $ python setup.py build_sphinx\r\n $ firefox build/sphinx/html/index.html\r\n\r\nContributing\r\n============\r\n\r\n- Register to `Github `_ if not already done.\r\n\r\n- Please file a ticket at the `Github tracker\r\n `_ that explains your feature or\r\n improvement.\r\n\r\n- Fork the project in your personal repository\r\n\r\n- Do the job\r\n\r\n- Always check the existing unit tests (see above) and add unit tests that\r\n verify your feature or bugfix.\r\n\r\n- Prefer \"git rebase\" to \"git merge\" when synching with the original master.\r\n See the worflow explained at http://blog.bigbinary.com/2013/09/13/how-to-keep-your-fork-uptodate.html\r\n\r\n- Issue a pull request when you're done, mentioning the original ticket you\r\n created at step 2.\r\n\r\n- Don't forget to \"star\" the project on Github if you like it. ;)\r\n\r\nLinks\r\n=====\r\n\r\nProject home page\r\n\r\n https://github.com/glenfant/mllib\r\n\r\nIssues tracker\r\n\r\n https://github.com/glenfant/mllib/isues\r\n\r\nCredits\r\n=======\r\n\r\nThe development of this library is sponsored by the `Assembl\u00e9e Nationale\r\n`_ (France's Chamber of Deputies).\r\n\r\n- Project leader : `Gilles Lenfant `_\r\n\r\nLicense\r\n=======\r\n\r\nThis software is distributed under the terms of the `MIT license\r\n`_.\r\n\r\nChanges log\r\n===========\r\n\r\n1.0.0a2\r\n-------\r\n\r\n- Fixed packaging issue\r\n [glenfant]\r\n\r\n1.0.0a1\r\n-------\r\n\r\nNo changes. Just a version normalization.\r\n\r\n1.0.0.a1\r\n--------\r\n\r\nFirst release.\r\n\r\n- Package creation with ``bobtemplates.gillux``\r\n [glenfant]", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://pypi.python.org/pypi/mllib", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "mllib", "package_url": "https://pypi.org/project/mllib/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/mllib/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://pypi.python.org/pypi/mllib" }, "release_url": "https://pypi.org/project/mllib/1.0.0a2/", "requires_dist": null, "requires_python": null, "summary": "A REST client for MarkLogic 8", "version": "1.0.0a2" }, "last_serial": 1737849, "releases": { "1.0.0a1": [ { "comment_text": "", "digests": { "md5": "7f945301e12355b9f3979f9d2add6ae0", "sha256": "715cfb891dda7646cc87f3c856940d7c448c57fc4ad1f9688c801ee05cc49bf3" }, "downloads": -1, "filename": "mllib-1.0.0a1.tar.gz", "has_sig": false, "md5_digest": "7f945301e12355b9f3979f9d2add6ae0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12283, "upload_time": "2015-09-11T10:28:23", "url": "https://files.pythonhosted.org/packages/93/30/cecf6b37eefa61f0036f40f73f5b135fbc4c05e2bebbe32bc7698799ded7/mllib-1.0.0a1.tar.gz" } ], "1.0.0a2": [ { "comment_text": "", "digests": { "md5": "3f47a6e3002af90e17163e217ffd8067", "sha256": "b752cb4a7fa3e76315f68ad9fbcb384b7c223d9b345cad9ceb1c883ca5edec11" }, "downloads": -1, "filename": "mllib-1.0.0a2.tar.gz", "has_sig": false, "md5_digest": "3f47a6e3002af90e17163e217ffd8067", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12513, "upload_time": "2015-09-11T10:36:32", "url": "https://files.pythonhosted.org/packages/b8/7e/4940e39f23686d0fe5d1dc3eaafa7f5389560008e2a894483c907b1ac293/mllib-1.0.0a2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "3f47a6e3002af90e17163e217ffd8067", "sha256": "b752cb4a7fa3e76315f68ad9fbcb384b7c223d9b345cad9ceb1c883ca5edec11" }, "downloads": -1, "filename": "mllib-1.0.0a2.tar.gz", "has_sig": false, "md5_digest": "3f47a6e3002af90e17163e217ffd8067", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12513, "upload_time": "2015-09-11T10:36:32", "url": "https://files.pythonhosted.org/packages/b8/7e/4940e39f23686d0fe5d1dc3eaafa7f5389560008e2a894483c907b1ac293/mllib-1.0.0a2.tar.gz" } ] }