Python wrapper for CI Messages schemas
Project description
python-ci_messages
This is a thin wrapper around the CI Messages spec which provides a representation of the schemas defined in that project as a fedora-messaging message schema. This project defines a single schema class with a single entry point named 'ci_messages.CIMessageV1', so far as fedora-messaging is concerned. When the body schema for a particular message is requested, the class reads the appropriate schema file for the topic from disk, and returns that.
Installation and use
You can visit the python-ci_messages project page on Pagure, and clone with git clone https://pagure.io/fedora-qa/python-ci_messages.git
. Tarballs are released through PyPI.
Dependencies are listed in the file install.requires
. To install the module systemwide, run python setup.py install
.
In addition to the Python module dependencies, the module requires access to the CI Messages schemas as JSON files. By default it will attempt to read them from the directory /usr/share/ci/messages
. You can change this location by creating a file /etc/python-ci_messages.conf
or ~/.config/python-ci_messages.conf
with contents like this:
[main]
schemapath = /path/to/schema/location
You can produce the JSON files from a CI Messages git checkout by running make convert
, which will place them in a subdirectory named tmp
.
As long as the module is installed, it will be used automatically by any fedora-messaging consumer for messages which declare they follow this schema in their headers. For more information on fedora-messaging, see its documentation.
This module requires Python 3.6 or higher (as it uses f-strings).
Bugs, pull requests etc.
You can file issues and pull requests on Pagure. Pull requests must be signed off (use the -s
git argument). By signing off your pull request you are agreeing to the Developer's Certificate of Origin:
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
Licensing
python-ci_messages is available under the GPL, version 3 or any later version. A copy is included as COPYING.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ci_messages-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 39e5de6220db98b04ebeabd356859dca9527cc41d63d2fd1353b8889fc037205 |
|
MD5 | 525cb256a144caa0fd760861f3e7797b |
|
BLAKE2b-256 | f0dd6696b7953dd93e2f323ee1ee2046c5d3ec77d6c2e8da201ddb7df77a4fa4 |