From 2f9958ee409e45fde130155b0ddb92e57b9c8315 Mon Sep 17 00:00:00 2001 From: djbajic Date: Wed, 29 Jul 2020 17:25:58 +0200 Subject: [PATCH] Work on readme file --- CODE_OF_CONDUCT.md | 76 ++++++++++++++++++++++++++++++++++++++++++++++ README.md | 26 ++++++++++++++-- setup.py | 6 ++-- 3 files changed, 103 insertions(+), 5 deletions(-) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..99c1b29 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at ilija.dukovski@gmail.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/README.md b/README.md index af75d00..c861d93 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ -# COMETS Python Toolbox -Python interface for running COMETS simulations and analyzing the results + + +[![Current PyPI version](https://img.shields.io/pypi/v/cometspy.svg)(https://pypi.org/project/cometspy/) +[![Supported Python Versions](https://img.shields.io/pypi/pyversions/cometspy.svg)(https://pypi.org/project/cometspy/) +[![Join the chat at https://gitter.im/segrelab/comets](https://badges.gitter.im/segrelab/comets.png)](https://gitter.im/segrelab/comets?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[![GitHub release](https://img.shields.io/github/release/segrelab/cometspy/all.svg)](https://GitHub.com/segrelab/cometspy/releases/) + +# COMETSPy - The Python Interface for COMETS +COMETSPY is the Python interface for running [COMETS](https://GitHub.com/segrelab/comets) simulations. COMETS is built and maintained by the COMETSPy Core Team. + +# Documentation +Documentation on how to use COMETS with COMETSPy is found at [comets-manual.readthedocs.io](https://comets-manual.readthedocs.io/en/latest/). + +# Installation +Use pip to install COMETSPy from PyPI: + +```py +pip3 install cometspy +``` + +# Cite us + +# Contributing +Contributions are welcome and appreciated. Questions and discussions can be raised on [Gitter](https://gitter.im/segrelab/comets). Issues should be discussed in this forum before they are raised on GitHub. For other questions contact us on email comets@bu.edu. diff --git a/setup.py b/setup.py index 6c60d34..af6719d 100644 --- a/setup.py +++ b/setup.py @@ -3,13 +3,13 @@ setup( name='cometspy', packages=['cometspy'], - version='0.3.6', - license='MIT', + version='0.3.7', + license='GPL', description='The Python interface to COMETS', author='The COMETSPy Core Team', author_email='djordje.bajic@yale.edu', url='https://github.com/segrelab/cometspy', - download_url='https://github.com/segrelab/cometspy/archive/v0.3.6.tar.gz', # New releases here!! + download_url='https://github.com/segrelab/cometspy/archive/v0.3.7.tar.gz', # New releases here!! keywords=['metabolism', 'dynamic', 'flux', 'balance', 'analysis', 'spatial'], install_requires=[ # I get to this in a second