Skip to main content

A lightweight library for working with Akoma Ntoso Act documents

Project description

https://badge.fury.io/py/cobalt.svg https://travis-ci.org/Code4SA/cobalt.svg

Cobalt is a lightweight Python library for working with Akoma Ntoso Act documents. It makes it easy to work with Akoma Ntoso metadata, FRBR URIs and generate Tables of Contents for a document.

It is lightweight because most operations are done on the XML document directly without intermediate objects. You still need to understand how Akoma Ntoso works.

Read the full documentation at cobalt.readthedocs.org.

Quickstart

Install using:

$ pip install cobalt

Use it like this:

>>> from cobalt import Act
>>> act = Act()
>>> act.title = "Act 10 of 1980"
>>> act.frbr_uri = "/za/act/1980/10"
>>> act.year
'1980'
>>> act.number
'10'
>>> print act.to_xml()
[ lots of xml ]

Contributing

  1. Clone the repo

  2. Install development dependencies:

    pip install -e .[dev]
  3. Make your changes

  4. Run tests:

    nosetests && flake8 cobalt
  5. Send a pull request

Releasing a New Version

  1. Run the tests!

  2. Update VERSION appropriately

  3. Update the Change Log section in README.rst

  4. Commit and push to github

  5. Release to PyPI:

    python setup.py sdist bdist_wheel upload

Change Log

0.1.10

  • Convert EOL elements to BR when changing XML to HTML

0.1.9

  • Support dates before 1900. Contributed by rkunal.

0.1.8

  • lifecycle and identification meta elements now have a configurable source attribute

0.1.7

  • TOCElement items now include a best-effort title

0.1.6

  • Use HTML5 semantic elements section and article when generating HTML for acts

0.1.5

  • FIX use schedule FRBRalias as heading

0.1.4

  • Transforming XML to HTML now includes all attributes as data- attributes

0.1.3

  • Refactor TOC helpers into own file

  • Fix .format in FrbrUri

0.1.1

  • first release

Project details


Download files

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

Source Distribution

cobalt-0.1.10.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

cobalt-0.1.10-py2-none-any.whl (16.8 kB view details)

Uploaded Python 2

File details

Details for the file cobalt-0.1.10.tar.gz.

File metadata

  • Download URL: cobalt-0.1.10.tar.gz
  • Upload date:
  • Size: 13.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for cobalt-0.1.10.tar.gz
Algorithm Hash digest
SHA256 10b87dd347d6182c057d3f5014825a16549b55b500b8d4965f270a080a0edfc7
MD5 7bc0c26b53373bd0317e4fdd05f76802
BLAKE2b-256 2acdab9dd92ec3688094db5f2619e01e7dba1d80a2af4f32a46f7a4b78d096d4

See more details on using hashes here.

File details

Details for the file cobalt-0.1.10-py2-none-any.whl.

File metadata

File hashes

Hashes for cobalt-0.1.10-py2-none-any.whl
Algorithm Hash digest
SHA256 81ef69f575cdcf61ccafb5344696b42baf68a3ef6b84df140ab749b451a3761d
MD5 24dedf6b360e85ac2c83dc90345e351c
BLAKE2b-256 937b674d486d5daeb82ce7d82781773b62c4c414fa9b8fc1848565489e5cbd68

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page