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
  5. Send a pull request

Releasing a New Version

  1. Run the testes! nosetests

  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.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.6.tar.gz (12.6 kB view details)

Uploaded Source

Built Distribution

cobalt-0.1.6-py2-none-any.whl (16.1 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for cobalt-0.1.6.tar.gz
Algorithm Hash digest
SHA256 f1310df27e9d8a97550df10ab17c61546c13e019ef037a529dbabed1318e805f
MD5 f33daffb554d52ce73192af606a298ab
BLAKE2b-256 73399ba6e087e712383cb6ed393d211b8c592c2f35988d45b971dc5aff203819

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cobalt-0.1.6-py2-none-any.whl
Algorithm Hash digest
SHA256 47a8f3db3e0c6bb1e9e724796603e2e1c5cec61db2e3725c7655a42994560d57
MD5 89773d57481e4583c04520439ecab180
BLAKE2b-256 3a768dbe072fc39085bfd2a4be6782c555a148759d959c7c97fa12f2530e2451

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