{ "info": { "author": "Connexions team", "author_email": "info@cnx.org", "bugtrack_url": null, "classifiers": [], "description": "CNXML Library\n=============\n\nThis is a python library for working with CNXML content, which includes the CNXML and COLLXML formats.\n\nInstall\n-------\n\nThis library requires Python >=3.5.\n\nInstall using::\n\n pip install -e \".\"\n\nTests\n-----\n\nUse the tox to run the tests::\n\n tox\n\nIf tox is not installed, run the following::\n\n pip install tox\n\nEdit/Validate files using `atom.io `_\n------------------------------------------------------\n\nPreparation\n^^^^^^^^^^^\n\n#. Install https://atom.io\n#. Get the cnxml RNG Schema files\n\n #. Download the most recent version from https://github.com/Connexions/cnxml/releases (click the \"zip\" link)\n\n - It should be in your Download foler\n - Move it to ~/.neb/\n\n #. Unzip the file\n #. It should have created a folder named something like `cnxml-2.0.0` (with `/cnxml/xml/cnxml/schema/rng/0.7/cnxml-jing.rng` in it)\n #. Rename the folder to be something you are unlikely to accidentally delete (like `cnxml-validation`)\n\n - Remember the name for later when you are editing `~/.atom/config.cson`\n\nInstall\n^^^^^^^\n\n#. Start up Atom\n#. Install the `linter-autocomplete-jing` package\n\n#. Type \u2318+, (for Mac) to open Settings (or click **Atom**, **Preferences...** in the menu bar)\n\n #. Click **Install** in the left-hand-side\n #. Enter `linter-autocomplete-jing` and click **Install**\n #. **Alternative:** run `apm install linter-autocomplete-jing` from the commandline\n\n#. Edit `~/.atom/config.cson` by clicking **Atom**, **Config** in the menu bar and add the following lines (at the bottom of this document)\n#. Restart Atom\n#. Open an unzipped complete-zip. (I run `atom ~/Downloads/col1234_complete` **From a terminal**)\n#. Verify by opening an `index.cnxml` file and typing in `
` somewhere in the file. If it is a valid location then it should auto-add `id=\"\"` for you\n\n\nChanges to `~/.atom/config.cson`::\n\n \"*\":\n core:\n customFileTypes:\n\n # Add this to the bottom of the customFileTypes area.\n # Note: Indentation is important!\n \"text.xml\": [\n \"index.cnxml\"\n ]\n\n\n # And then this to the bottom of the file\n # 1. Make sure \"linter-autocomplete-jing\" only occurs once in this file!\n # 1. make sure it is indented by 2 spaces just like it is in this example.\n\n \"linter-autocomplete-jing\":\n displaySchemaWarnings: true\n rules: [\n {\n priority: 1\n test:\n pathRegex: \".cnxml$\"\n outcome:\n schemaProps: [\n {\n lang: \"rng\"\n path: \"~/.neb/cnxml-validation/cnxml/xml/cnxml/schema/rng/0.7/cnxml-jing.rng\"\n }\n ]\n }\n ]\n\nLicense\n-------\n\nThis software is subject to the provisions of the GNU Affero General\nPublic License Version 3.0 (AGPL). See license.txt for details.\nCopyright (c) 2016 Rice University\n\n\nChange Log\n==========\n\n.. Use the following to start a new version entry:\n\n |version|\n ----------------------\n\n - feature message\n\n3.0.1\n-----\n\n- Re-release of 3.0.0\n\n3.0.0\n-----\n\n- Add tests for cnxml validation\n- Fix failing derived-from cnxml validation tests\n- Use a self-closing md:derived-from as the valid repr\n- Move the metadata parsing from\n `Press `_ to cnxml (#20)\n- Add a CLI utility for extracting cnxml metadata to json (#22)\n\n2.2.0\n-----\n\n- Extend validation API to accept multiple documents to validate\n\n2.1.1\n-----\n\n- Tweak mdml schema to properly allow any metadata element under derived-from\n\n2.1.0\n-----\n\n- Remove external pathlib dependency\n- Drop support for Python <= 2.7\n- Use versioneer for project versioning\n- Correct license in setup.py\n- Add instructions to validate with the atom.io editor\n\n2.0.0\n-----\n\n- Add a commandline interface for collxml validation\n- Rename main cli function to make room for another entrypoint\n- Make the metadata section required in collxml\n- Add collxml validation function\n\n1.1.0\n-----\n\n- Use a namedtuple for validation error line data.\n\n1.0.0\n-----\n\n- Initial release.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/connexions/cnxml", "keywords": "", "license": "AGPL, See also LICENSE.txt", "maintainer": "", "maintainer_email": "", "name": "cnxml", "package_url": "https://pypi.org/project/cnxml/", "platform": "", "project_url": "https://pypi.org/project/cnxml/", "project_urls": { "Homepage": "https://github.com/connexions/cnxml" }, "release_url": "https://pypi.org/project/cnxml/3.0.1/", "requires_dist": [ "lxml", "pytest ; extra == 'test'" ], "requires_python": "", "summary": "Connexions CNXML Library", "version": "3.0.1" }, "last_serial": 4912750, "releases": { "0.0.0": [], "1.0.0": [ { "comment_text": "", "digests": { "md5": "b03febe336f4d17f0302acdb78ec03ee", "sha256": "36e45caa4b2f0ec123109278588f75ad3edb7f4ff34b3a036bab5b8915f641e9" }, "downloads": -1, "filename": "cnxml-1.0.0.tar.gz", "has_sig": false, "md5_digest": "b03febe336f4d17f0302acdb78ec03ee", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 638454, "upload_time": "2016-09-29T01:05:41", "url": "https://files.pythonhosted.org/packages/25/13/1f2758b5d5c75f2ed8bda905bdabce30014df493d47a16e26021107a2107/cnxml-1.0.0.tar.gz" }, { "comment_text": "", "digests": { "md5": "d08381efeccf44b76fa381fa28697dc1", "sha256": "6b6cca20f58265831e67e9b4095d7e94a588a36dda8e64073932d94525e954cd" }, "downloads": -1, "filename": "cnxml-1.0.0.zip", "has_sig": false, "md5_digest": "d08381efeccf44b76fa381fa28697dc1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 700321, "upload_time": "2016-09-29T01:05:53", "url": "https://files.pythonhosted.org/packages/da/18/0fc7bd693958e7ea80bb5c9d701d47915494127e481279e39a0cea90d5a1/cnxml-1.0.0.zip" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "a0626996bf30c6b6cb3fe32cd885fe5d", "sha256": "b441916eb7c5ad65b21e8029b95ca33efcc72c113d29ff5a81a26d1b977e2979" }, "downloads": -1, "filename": "cnxml-1.1.0.tar.gz", "has_sig": false, "md5_digest": "a0626996bf30c6b6cb3fe32cd885fe5d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 638516, "upload_time": "2016-09-29T20:12:14", "url": "https://files.pythonhosted.org/packages/66/9a/a9efad4d7f30249435a3ca7ef9b26ca083477fed762b8b0bb77a557c8feb/cnxml-1.1.0.tar.gz" }, { "comment_text": "", "digests": { "md5": "6104621b8627d9aa6edaae1a5a2aec50", "sha256": "eed4525251b7d51cf3a57ed20f43a00eda486e2b3dac25024c1c3659586f6dfa" }, "downloads": -1, "filename": "cnxml-1.1.0.zip", "has_sig": false, "md5_digest": "6104621b8627d9aa6edaae1a5a2aec50", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 700387, "upload_time": "2016-09-29T20:12:18", "url": "https://files.pythonhosted.org/packages/33/52/55e2feff7398eded888e118690f9f3e507053ed4c5b823ee8f3ea1ff0353/cnxml-1.1.0.zip" } ], "2.0.0": [ { "comment_text": "", "digests": { "md5": "9005554e64527e43aa80de5e985abb25", "sha256": "53668ae81ce496aab2b12cb8a017ab491e002c0ba5afa124c32df6e645dee87b" }, "downloads": -1, "filename": "cnxml-2.0.0.tar.gz", "has_sig": false, "md5_digest": "9005554e64527e43aa80de5e985abb25", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 641709, "upload_time": "2016-10-07T15:13:08", "url": "https://files.pythonhosted.org/packages/5b/14/35ac399ba3e22031e1ec7e0b7df42cb5537cce697bf3e391e33e1fd5aa19/cnxml-2.0.0.tar.gz" }, { "comment_text": "", "digests": { "md5": "80e5f1678cf2f3ffe1adfeb7634816ee", "sha256": "aac3adc7e487e00698d1a294a29ce9794222803acc0781d5058b704b46b99437" }, "downloads": -1, "filename": "cnxml-2.0.0.zip", "has_sig": false, "md5_digest": "80e5f1678cf2f3ffe1adfeb7634816ee", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 705562, "upload_time": "2016-10-07T15:13:13", "url": "https://files.pythonhosted.org/packages/e5/1a/3c4a6d185c246ceb13d862e0d6c6187ec40747b7e7ecdd0a60102697d750/cnxml-2.0.0.zip" } ], "2.1.0": [ { "comment_text": "", "digests": { "md5": "1c1b1172f33057008a82d42c1291c7f5", "sha256": "8e35992fa6b74ea209b6d771782f3a8237f2d21846b5c4e5b96460059c9c9c9a" }, "downloads": -1, "filename": "cnxml-2.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "1c1b1172f33057008a82d42c1291c7f5", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 698408, "upload_time": "2017-07-12T15:46:17", "url": "https://files.pythonhosted.org/packages/21/c1/7ea3ccc478366538108e089dfc8be79a7627fa68f760155e52fa5d1dd238/cnxml-2.1.0-py3-none-any.whl" } ], "2.1.1": [ { "comment_text": "", "digests": { "md5": "4297eb514a084f574a187f27851f8020", "sha256": "7ff5b6ad3f48a07e39e9873a8659532d4c17b9e4f8efa8927186119ddd6b2e25" }, "downloads": -1, "filename": "cnxml-2.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "4297eb514a084f574a187f27851f8020", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 695461, "upload_time": "2018-07-12T19:31:29", "url": "https://files.pythonhosted.org/packages/60/e2/978ece57d51967cb28c4d454221394a636f81ac31d82b628a265a3b93eb6/cnxml-2.1.1-py3-none-any.whl" } ], "2.2.0": [ { "comment_text": "", "digests": { "md5": "2c909c2d56a176e69006fcf1ebd63c39", "sha256": "8b73f9e6c28ce00f28bd1511edba0908119a9fc2d84063ca4abe4154a2d57a82" }, "downloads": -1, "filename": "cnxml-2.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "2c909c2d56a176e69006fcf1ebd63c39", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 898448, "upload_time": "2018-08-02T16:54:21", "url": "https://files.pythonhosted.org/packages/a4/2b/a8c48f2edd4e4986bbd41e50c5acde6bfffe92c0160de53f06578d36b643/cnxml-2.2.0-py3-none-any.whl" } ], "3.0.0": [ { "comment_text": "", "digests": { "md5": "709b0fc7ea9036333c46239cec80efb4", "sha256": "13deea5891ece63ac5be437205f020f3eecd3801f0cac1b6ec3921666488881d" }, "downloads": -1, "filename": "cnxml-3.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "709b0fc7ea9036333c46239cec80efb4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 914023, "upload_time": "2019-03-07T21:58:29", "url": "https://files.pythonhosted.org/packages/b9/8a/9a6ff31546d00fd052fca24ba28f29918d068c34fb7faffa8ccbb8747c38/cnxml-3.0.0-py3-none-any.whl" } ], "3.0.1": [ { "comment_text": "", "digests": { "md5": "b414ad630329311494d364dabb8d2267", "sha256": "5b313e840b677cb72d36782682a280e6745431b0a40954b0ee2535ebb4d2816e" }, "downloads": -1, "filename": "cnxml-3.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "b414ad630329311494d364dabb8d2267", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 914034, "upload_time": "2019-03-07T22:03:19", "url": "https://files.pythonhosted.org/packages/0a/6a/a22bffdde09d2b0beefcf00a77d735e8250153fa3fa3da35509c271dbba0/cnxml-3.0.1-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b414ad630329311494d364dabb8d2267", "sha256": "5b313e840b677cb72d36782682a280e6745431b0a40954b0ee2535ebb4d2816e" }, "downloads": -1, "filename": "cnxml-3.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "b414ad630329311494d364dabb8d2267", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 914034, "upload_time": "2019-03-07T22:03:19", "url": "https://files.pythonhosted.org/packages/0a/6a/a22bffdde09d2b0beefcf00a77d735e8250153fa3fa3da35509c271dbba0/cnxml-3.0.1-py3-none-any.whl" } ] }