From b7754a37af64301881877927eabe99e83f2bfa15 Mon Sep 17 00:00:00 2001 From: Leonard Binet Date: Sat, 20 Jun 2020 23:33:02 +0200 Subject: [PATCH 1/2] README --- CONTRIBUTING.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ README.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 74 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9f95691 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,46 @@ +# Contributing to Pandagg +We want to make contributing to this project as easy and transparent as +possible. + +## Our Development Process +We use github to host code, to track issues and feature requests, as well as accept pull requests. + + +## Pull Requests +We actively welcome your pull requests. + +1. Fork the repo and create your branch from `master`. +2. If you've added code that should be tested, add tests. +3. If you've changed APIs, update the documentation. +4. Ensure the test suite passes. +5. Make sure your code lints. + +## Any contributions you make will be under the MIT Software License +In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. +Feel free to contact the maintainers if that's a concern. + +## Issues +We use GitHub issues to track public bugs. Please ensure your description is +clear and has sufficient instructions to be able to reproduce the issue. + +## Report bugs using Github's [issues](https://github.com/alkemics/pandagg/issues) +We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/alkemics/pandagg/issues/new); it's that easy! + +## Write bug reports with detail, background, and sample code + +**Great Bug Reports** tend to have: + +- A quick summary and/or background +- Steps to reproduce + - Be specific! + - Give sample code if you can. +- What you expected would happen +- What actually happens +- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) + + +## License +By contributing, you agree that your contributions will be licensed under its MIT License. + +## References +This document was adapted from the open-source contribution guidelines of [briandk's gist](https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62) diff --git a/README.md b/README.md index e69de29..9ec6d1f 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,28 @@ +[![PyPI Latest Release](https://img.shields.io/pypi/v/lighttree.svg)](https://pypi.org/project/lighttree/) +![Python package](https://github.com/leonardbinet/lighttree/workflows/Python%20package/badge.svg) + + +## What is it? + +**lighttree** is a Python package providing a simple interface to manipulate data having a tree structure. + + +## Features + +- multiple tree update methods +- ascii display +- interactive tree with autocompletion feature (for ipython usage) + +## Documentation + +Full documentation available (work in progress) [here on read-the-docs](https://lighttree.readthedocs.io/en/latest/). + + +## Installation +``` +pip install lighttree +``` + +## Contributing + +All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome. From e03d65effffd13df2fe285b356711fa33a6cded1 Mon Sep 17 00:00:00 2001 From: Leonard Binet Date: Sat, 20 Jun 2020 23:33:50 +0200 Subject: [PATCH 2/2] v0.0.7 --- README.md | 1 + setup.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9ec6d1f..a08eea3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ [![PyPI Latest Release](https://img.shields.io/pypi/v/lighttree.svg)](https://pypi.org/project/lighttree/) +[![License](https://img.shields.io/pypi/l/lighttree.svg)](https://github.com/leonardbinet/lighttree/blob/master/LICENSE) ![Python package](https://github.com/leonardbinet/lighttree/workflows/Python%20package/badge.svg) diff --git a/setup.py b/setup.py index 0135dd0..4be05b0 100644 --- a/setup.py +++ b/setup.py @@ -3,7 +3,7 @@ from setuptools import setup -__version__ = "0.0.6" +__version__ = "0.0.7" setup(