Docker/documize
Docker/documize
1
0
Fork 0
mirror of https://github.com/documize/community.git synced 2025-07-18 20:59:43 +02:00
Code Releases Activity
documize/sdk/README.md
Harvey Kandola 18933c6767 initial commit
2016-07-07 18:54:16 -07:00

946 B
Raw Blame History

SDK for the Documize system

The SDK is in development, please do not use in a live environment.

documize command

The directory "documize" contains a command line utility to load files onto the Documize server. Run the command with "--help" to see the available flags.

test suite (currently disabled)

The directory "exttest" contains a set of tests that are used both to test this package and to test the main documize code.

In order to run these tests two environment variables must be set:

  • DOCUMIZEAPI - the url of the endpoint, which must be http://localhost:5002 at present
  • DOCUMIZEAUTH - the authorization credentials in the form domain:email:password, which must be of the form :mick@jagger.com:demo123 at present, with the Documize DB organistion record having the default (empty) subdomain.

There must also be a single folder named "Test" for code to find and use. TODO(Elliott) remove this restriction.