https://github.com/bbc/rd-apmm-python-lib-mediajson
A JSON serialiser and parser for python that support some extensions convenient for our media grain formats
https://github.com/bbc/rd-apmm-python-lib-mediajson
rd-project rd-section-apmm
Last synced: about 2 months ago
JSON representation
A JSON serialiser and parser for python that support some extensions convenient for our media grain formats
- Host: GitHub
- URL: https://github.com/bbc/rd-apmm-python-lib-mediajson
- Owner: bbc
- License: other
- Created: 2018-06-15T10:15:22.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-02-20T11:34:26.000Z (over 1 year ago)
- Last Synced: 2024-04-08T21:02:53.602Z (about 1 year ago)
- Topics: rd-project, rd-section-apmm
- Language: Makefile
- Size: 170 KB
- Stars: 2
- Watchers: 13
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# mediajson
Type-aware json serialiser and deserialiser.
## Introduction
This library provides a custom JSON serialiser and deserialiser based on the ones in the standard python library but capable of
understanding a wider range of python types including the `mediatimestamps.timestamp` type and the `uuid.UUID` type, and
`fractions.Fraction` types.
## Installation
### Requirements
* A working Python 3.10+ installation
* The tool [Docker](https://docs.docker.com/engine/install/) is needed to run the tests, but not required to use the library.
### Steps
```bash
# Install from pip
$ pip install mediatimestamp
# Install directly from source repo
$ git clone [email protected]:bbc/rd-apmm-python-lib-mediajson.git
$ cd rd-apmm-python-lib-mediajson
$ make install
```
## Usage
```python
import mediajson
import mediatimestamp
# Encode some json from a mediatimestamp.Timestamp object
print(mediajson.dumps(mediatimestamp.Timestamp.get_time()))
```
## Documentation
The API is well documented in the docstrings of the module mediajson, to view:
```bash
make docs
```
This command will render documentation as HTML in the `/docs` directory. A rendered version of this documentation is available [here](https://bbc.github.io/rd-apmm-python-lib-mediajson/mediajson/mediajson.html).
## Development
### Commontooling
This repository uses a library of makefiles, templates, and other tools for development tooling and CI workflows. To discover operations that may be run against this repo, run the following in the top level of the repo:
```bash
$ make
```
### Testing
To run the unittests for this package in a docker container follow these steps:
```bash
$ git clone [email protected]:bbc/rd-apmm-python-lib-mediajson.git
$ cd rd-apmm-python-lib-mediajson
$ make test
```
### Continuous Integration
This repository includes [GitHub Actions workflows](./.github/workflows/) for CI. The shared workflows are centrally managed and should not be modified.
## Versioning
We use [Semantic Versioning](https://semver.org/) for this repository
## Contributing
The code in this repository was previously released as part of the
nmos-common library (). For
contributing work please see the file [CONTRIBUTING.md](./CONTRIBUTING.md) in this repository.
Please ensure you have run the test suite before submitting a Pull Request, and include a version bump in line with our [Versioning](#versioning) policy.
## Authors
* James Weaver
* Philip deNier
* Sam Mesterton-Gibbons
* James Sandford
For further information, contact
## License
See [LICENSE.md](LICENSE.md)