#######
serafin
#######
**serafin** is a python library that allows to selectively serialize different
kinds of python object into something that can be dumped to JSON or YAML.
.. note::
The project follows the semantic versioning scheme: Until 1.0 the minor
* The *patch* versions only include bugfixes and changes that do not
modify the existing interface. You can safely update a patch version
without worrying it will break your code.
* The *minor* versions will contain changes to the interface. With a
single version update your code will most likely work or might require
small adjustments. The more minor versions you update at once the
bigger the chance that something will brake.
* The *major* versions are reserved for significant refactorings and
architecture changes. This should not happen very often so the major
version should not change much.
.. note::
The CircleCI builds can be found
`here <https://circleci.com/gh/novopl/serafin>`_
.. readme_inclusion_marker
Installation
============
.. code-block:: shell
$ pip install serafin
Contributing
============
Cloning and setting up the development repo
-------------------------------------------
.. code-block:: shell
$ git clone git@github.com:novopl/serafin.git
$ cd serafin
$ virtualenv env
$ source ./env/bin/activate
$ pip install .
$ pip install -r ops/devrequirements.txt
$ peltak git add-hoooks
Running tests
.............
**Config**: The types of tests are defined in ``pelconf.py`` and the
pytest configuration is defined in ``ops/tools/pytest.ini``.
.. code-block:: shell
$ peltak test
Linting
.......
**Config**: The list of locations to lint is defined in ``pelconf.py`` and the
linters configuration is defined in ``ops/tools/{pylint,pep8}.ini``.
.. code-block:: shell
$ peltak lint
Generating docs
...............
**Config**: The list of documented files and general configuration is in
``pelconf.py`` and the Sphinx configuration is defined in ``docs/conf.py``.
.. code-block:: shell
$ peltak docs
Metadata
Release files for serafin 0.12.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| serafin-0.12.2.tar.gz | 15.4 kB | Without provenance | Details for serafin-0.12.2.tar.gz |
Release files / serafin-0.12.2.tar.gz
| Download URL | serafin-0.12.2.tar.gz |
|---|---|
| Size | 15.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7c1d6fee8d1d7d6f688569eed2a3f8536279847502b3fc2129302e5fbecc8232
|
|
BLAKE2b-256 checksum How to use checksums |
28e6009d5c5aba9266f01ca8646b80ee9355fec7031e2643112afab970df2bd6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Python-urllib/3.6
|
Security for serafin 0.12.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.