A thin wrapper of PyYaml to convert Python objects to YAML and back.
Project description
Convert Python objects to YAML and back.
This is the readme for developers. The documentation for users is available here: https://smarie.github.io/python-yamlable/
Want to contribute ?
Contributions are welcome ! Simply fork this project on github, commit your contributions, and create pull requests.
Here is a non-exhaustive list of interesting open topics: https://github.com/smarie/python-yamlable/issues
Running the tests
This project uses pytest.
pytest -v yamlable/tests/
You may need to install requirements for setup beforehand, using
pip install -r ci_tools/requirements-test.txt
Packaging
This project uses setuptools_scm to synchronise the version number. Therefore the following command should be used for development snapshots as well as official releases:
python setup.py egg_info bdist_wheel rotate -m.whl -k3
You need to generate code before packaging.
You also may need to install requirements for setup beforehand, using
pip install -r ci_tools/requirements-setup.txt
Generating the documentation page
This project uses mkdocs to generate its documentation page. Therefore building a local copy of the doc page may be done using:
mkdocs build
You may need to install requirements for doc beforehand, using
pip install -r ci_tools/requirements-doc.txt
Generating the test reports
The following commands generate the html test report and the associated badge.
pytest --junitxml=junit.xml -v yamlable/tests/
ant -f ci_tools/generate-junit-html.xml
python ci_tools/generate-junit-badge.py
PyPI Releasing memo
This project is now automatically deployed to PyPI when a tag is created. Anyway, for manual deployment we can use:
twine upload dist/* -r pypitest
twine upload dist/*
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.