https://github.com/smarie/python-kopylog

https://github.com/smarie/python-kopylog

log logbook munch phase python results stage store struct structure

Last synced: 12 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/smarie/python-kopylog
• Owner: smarie
• License: bsd-3-clause
• Created: 2019-09-03T11:01:02.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-04-26T14:32:03.000Z (about 6 years ago)
• Last Synced: 2024-12-25T07:22:05.904Z (over 1 year ago)
• Topics: log, logbook, munch, phase, python, results, stage, store, struct, structure
• Language: Python
• Size: 47.9 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# python-kopylog

*Your log companion for algorithms structuration*

[![Python versions](https://img.shields.io/pypi/pyversions/kopylog.svg)](https://pypi.python.org/pypi/kopylog/) [![Build Status](https://travis-ci.org/smarie/python-kopylog.svg?branch=master)](https://travis-ci.org/smarie/python-kopylog) [![Tests Status](https://smarie.github.io/python-kopylog/junit/junit-badge.svg?dummy=8484744)](https://smarie.github.io/python-kopylog/junit/report.html) [![codecov](https://codecov.io/gh/smarie/python-kopylog/branch/master/graph/badge.svg)](https://codecov.io/gh/smarie/python-kopylog)

[![Documentation](https://img.shields.io/badge/doc-latest-blue.svg)](https://smarie.github.io/python-kopylog/) [![PyPI](https://img.shields.io/pypi/v/kopylog.svg)](https://pypi.python.org/pypi/kopylog/) [![Downloads](https://pepy.tech/badge/kopylog)](https://pepy.tech/project/kopylog) [![Downloads per week](https://pepy.tech/badge/kopylog/week)](https://pepy.tech/project/kopylog) [![GitHub stars](https://img.shields.io/github/stars/smarie/python-kopylog.svg)](https://github.com/smarie/python-kopylog/stargazers)

**This is the readme for developers.** The documentation for users is available here: [https://smarie.github.io/python-kopylog/](https://smarie.github.io/python-kopylog/)

## 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-kopylog/issues](https://github.com/smarie/python-kopylog/issues)

## Requirements for builds

Install requirements for setup beforehand using 

```bash

pip install -r ci_tools/requirements-pip.txt

```

## Running the tests

This project uses `pytest`.

```bash

pytest -v kopylog/tests/

```

## 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: 

```bash

python setup.py egg_info bdist_wheel rotate -m.whl -k3

```

## 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:

```bash

mkdocs build -f docs/mkdocs.yml

```

## Generating the test reports

The following commands generate the html test report and the associated badge. 

```bash

pytest --junitxml=junit.xml -v kopylog/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:

```bash

twine upload dist/* -r pypitest

twine upload dist/*

```