Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Connexions CNXML Library

Project Description

CNXML Library

This is a python library for working with CNXML content, which includes the CNXML and COLLXML formats.

Install

This library requires Python >=3.5.

Install using:

pip install -e "."

Tests

Use the tox to run the tests:

tox

If tox is not installed, run the following:

pip install tox

Edit/Validate files using atom.io

Preparation

  1. Install https://atom.io
  2. Get the cnxml RNG Schema files
    1. Download the most recent version from https://github.com/Connexions/cnxml/releases (click the “zip” link)
      • It should be in your Download folder
    2. Unzip the file
    3. 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)
    4. Rename the folder to be something you are unlikely to accidentally delete (like cnxml-validation)
      • Remember the name for later when you are editing ~/.atom/config.cson

Install

  1. Start up Atom
  2. Install the linter-autocomplete-jing package
  3. Type <kbd>⌘</kbd>+<kbd>,</kbd> (for Mac) to open Settings (or click Atom, Preferences… in the menu bar)
    1. Click Install in the left-hand-side
    2. Enter linter-autocomplete-jing and click Install
    3. Alternative: run apm install linter-autocomplete-jing from the commandline
  4. Edit ~/.atom/config.cson by clicking Atom, Config in the menu bar and add the following lines (at the bottom of this document)
  5. Restart Atom
  6. Open an unzipped complete-zip. (I run atom ~/Downloads/col1234_complete From a terminal)
  7. Verify by opening an index.cnxml file and typing in <figure> somewhere in the file. If it is a valid location then it should auto-add id="" for you

Changes to ~/.atom/config.cson:

"*":
  core:
    customFileTypes:

      # Add this to the bottom of the customFileTypes area.
      # Note: Indentation is important!
      "text.xml": [
        "index.cnxml"
      ]


  # And then this to the bottom of the file
  # 1. Make sure "linter-autocomplete-jing" only occurs once in this file!
  # 1. make sure it is indented by 2 spaces just like it is in this example.

  "linter-autocomplete-jing":
    displaySchemaWarnings: true
    rules: [
      {
        priority: 1
        test:
          pathRegex: ".cnxml$"
        outcome:
          schemaProps: [
            {
              lang: "rng"
              path: "~/Downloads/cnxml-validation/cnxml/xml/cnxml/schema/rng/0.7/cnxml-jing.rng"
            }
          ]
      }
    ]

License

This software is subject to the provisions of the GNU Affero General Public License Version 3.0 (AGPL). See license.txt for details. Copyright (c) 2016 Rice University

Change Log

2.1.0

  • Remove external pathlib dependency
  • Drop support for Python <= 2.7
  • Use versioneer for project versioning
  • Correct license in setup.py
  • Add instructions to validate with the atom.io editor

2.0.0

  • Add a commandline interface for collxml validation
  • Rename main cli function to make room for another entrypoint
  • Make the metadata section required in collxml
  • Add collxml validation function

1.1.0

  • Use a namedtuple for validation error line data.

1.0.0

  • Initial release.
Release History

Release History

This version
History Node

2.1.0

History Node

2.0.0

History Node

1.1.0

History Node

1.0.0

History Node

0.0.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
cnxml-2.1.0-py3-none-any.whl (698.4 kB) Copy SHA256 Checksum SHA256 py3 Wheel Jul 12, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting