Hey! Where are the docs

As 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 the sandbox/ directory that explores most features of the provided resources.

Installation

Jump to Contributing if you want the full source distro and contribute to the project. Others will use pip to install mllib like this, as long as it is not yet available on PyPI.

pip install git+https://github.com/glenfant/mllib.git#egg=mllib

See https://pip.pypa.io/en/latest/reference/pip_install.html#git if you need a specific Git branch, tag or commit hash.

Developer notes

Please use a virtualenv to maintain this package, but I should not need to say that.

$ git clone https://github.com/glenfant/mllib.git
$ python setup.py develop
$ pip install mllib[dev]

$ export MLLIB_TEST_SERVER=my.marklogic-rest.tld:9000:foo:bar  # Optional
$ python setup.py test
$ python run_tests.py

$ python setup.py build_sphinx
$ firefox build/sphinx/html/index.html

Contributing

• Register to Github if not already done.

• Please file a ticket at the Github tracker that explains your feature or improvement.

• Fork the project in your personal repository

• Do the job

• Always 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 at http://blog.bigbinary.com/2013/09/13/how-to-keep-your-fork-uptodate.html

• Issue 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. ;)

Links

Project home page

https://github.com/glenfant/mllib

Issues tracker

https://github.com/glenfant/mllib/isues

Credits

The development of this library is sponsored by the Assemblée Nationale (France’s Chamber of Deputies).

• Project leader : Gilles Lenfant

License

This software is distributed under the terms of the MIT license.

Changes log