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

Uploaded Source

Built Distribution

cobalt-0.1.9-py2-none-any.whl (16.7 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for cobalt-0.1.9.tar.gz
Algorithm Hash digest
SHA256 6915064a8ea4b8d57e8e1fc80528b29810a45e94daf66492dafaf7296be63b7e
MD5 0a140810f4a6b00a6f142d784b82dd8c
BLAKE2b-256 5d7256dc3a8cb3c3a59313bec34badcf7e411ae0071f1d9228e20d33e0533adc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cobalt-0.1.9-py2-none-any.whl
Algorithm Hash digest
SHA256 2dfcebdcb5019ce354aae73a85f264cfd8920e3b892f0263337cde3651ef0003
MD5 4472868b1c8503010b4b80d9b4ea9a95
BLAKE2b-256 cfb89b764862a71d7deebcb76cf93329774ac555c5c6e613d977643f2021b9f5

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