Skip to main content

A lightweight library for working with Akoma Ntoso Act documents

Project description

Cobalt

image

image

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

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.io.

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-05-03/10"
>>> act.frbr_uri.year
'1980'
>>> act.frbr_uri.date
'1980-05-03'
>>> act.frbr_uri.number
'10'
>>> act.frbr_uri.doctype
'act'
>>> 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 with python -m unittest
  2. Update the version by changing the __version__ variable in cobalt/__init__.py
  3. Commit your changes and push to the master branch on GitHub
  4. Create a release in GitHub and it will automatically be pushed to PyPi

License

Cobalt is licensed under the LPGL 3.0 license.

Copyright 2015-2020 AfricanLII.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see https://www.gnu.org/licenses/.

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

Uploaded Source

Built Distribution

cobalt-9.0.1-py3-none-any.whl (73.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cobalt-9.0.1.tar.gz
  • Upload date:
  • Size: 83.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for cobalt-9.0.1.tar.gz
Algorithm Hash digest
SHA256 3a1581f611d9dace7dee35f288e5f3891066a9dd1f5f0881532289fc37f89ea5
MD5 73d3cf7df011043be950481afb470003
BLAKE2b-256 95e08ba0deca45a1b9985d9dab0be36d55687f438ea8eea3f0a23e00bae3853d

See more details on using hashes here.

Provenance

The following attestation bundles were made for cobalt-9.0.1.tar.gz:

Publisher: publish.yml on laws-africa/cobalt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cobalt-9.0.1-py3-none-any.whl.

File metadata

  • Download URL: cobalt-9.0.1-py3-none-any.whl
  • Upload date:
  • Size: 73.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for cobalt-9.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8339d0edcc470381ce0fc62daa8bd419f7cc731ffd83fcf57a7c6cf0b526e640
MD5 ce2d1bdddabecb28dfd785f2259a4713
BLAKE2b-256 1583d5be80b572064329066b8738e91f6b8dd42712007ae0c13e5e8911cdb1b0

See more details on using hashes here.

Provenance

The following attestation bundles were made for cobalt-9.0.1-py3-none-any.whl:

Publisher: publish.yml on laws-africa/cobalt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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