From 806a3f7498ebbc007fa86361b3ae5d319876027c Mon Sep 17 00:00:00 2001 From: trevorb1 Date: Tue, 24 Oct 2023 11:59:47 -0700 Subject: [PATCH 1/3] add contributing guidelines link --- README.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index bf6c6b35..e482e173 100644 --- a/README.rst +++ b/README.rst @@ -53,5 +53,7 @@ Contributing New ideas and bugs `should be submitted `_ to the repository issue tracker. Please do contribute by discussing and developing these -ideas further. To contribute directly to the documentation of code development, please see -the contribution guidelines document. +ideas further. + +To contribute directly to the code and documentation development, please see +the `contribution guidelines `_. From f9eca92484a3bdb294100833996dc9eda0a76441 Mon Sep 17 00:00:00 2001 From: trevorb1 Date: Thu, 2 Nov 2023 18:01:41 -0700 Subject: [PATCH 2/3] update readme --- README.rst | 39 ++++++++++++++++++++++++++++----------- 1 file changed, 28 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index e482e173..5d0da2b4 100644 --- a/README.rst +++ b/README.rst @@ -2,28 +2,45 @@ otoole: OSeMOSYS tools for energy work ================================================== -.. image:: https://coveralls.io/repos/github/OSeMOSYS/otoole/badge.svg?branch=master&kill_cache=1 - :target: https://coveralls.io/github/OSeMOSYS/otoole?branch=master +.. image:: https://joss.theoj.org/papers/e93a191ae795b171beff782a68fdc467/status.svg + :target: https://joss.theoj.org/papers/e93a191ae795b171beff782a68fdc467 + :alt: JOSS status -.. image:: https://readthedocs.org/projects/otoole/badge/?version=latest - :target: https://otoole.readthedocs.io/en/latest/?badge=latest - :alt: Documentation Status +.. image:: https://img.shields.io/pypi/v/otoole.svg + :target: https://pypi.org/project/otoole/ + :alt: PyPI .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black + :alt: Code Style -.. image:: https://joss.theoj.org/papers/e93a191ae795b171beff782a68fdc467/status.svg - :target: https://joss.theoj.org/papers/e93a191ae795b171beff782a68fdc467 - :alt: JOSS status +.. image:: https://img.shields.io/badge/python-3.9|3.10|3.11-blue.svg + :target: https://crate.io/packages/otoole/ + :alt: Python Version + +.. image:: https://img.shields.io/badge/License-MIT-yellow.svg + :target: https://opensource.org/licenses/MIT + :alt: License + + +.. image:: https://coveralls.io/repos/github/OSeMOSYS/otoole/badge.svg?branch=master&kill_cache=1 + :target: https://coveralls.io/github/OSeMOSYS/otoole?branch=master + :alt: Code Coverage + +.. image:: https://github.com/OSeMOSYS/otoole/actions/workflows/python.yaml/badge.svg?branch=master + :target: https://github.com/OSeMOSYS/otoole/actions/workflows/python.yaml + :alt: GitHub CI -A Python toolkit to support use of OSeMOSYS +.. image:: https://readthedocs.org/projects/otoole/badge/?version=latest + :target: https://otoole.readthedocs.io/en/latest/?badge=latest + :alt: Documentation Status Description =========== OSeMOSYS tools for energy work, or otoole, is a Python package -which provides a command-line interface for users of OSeMOSYS. The aim of the -package is to provide commonly used pre- and post-processing steps for OSeMOSYS. +to support the users of OSeMOSYS. The aim of the package is to provide commonly +used pre- and post-processing steps for OSeMOSYS. **otoole** aims to support different ways of storing input data and results, including csv files and Excel workbooks, as well as different implementations From f3eb56b61446affdee4e898a6487b26cf5d00cbc Mon Sep 17 00:00:00 2001 From: trevorb1 Date: Thu, 2 Nov 2023 18:35:22 -0700 Subject: [PATCH 3/3] badge formatting --- README.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 5d0da2b4..df348434 100644 --- a/README.rst +++ b/README.rst @@ -14,14 +14,15 @@ otoole: OSeMOSYS tools for energy work :target: https://github.com/psf/black :alt: Code Style -.. image:: https://img.shields.io/badge/python-3.9|3.10|3.11-blue.svg +.. image:: https://img.shields.io/badge/python-3.9_|_3.10_|_3.11-blue.svg :target: https://crate.io/packages/otoole/ :alt: Python Version -.. image:: https://img.shields.io/badge/License-MIT-yellow.svg +.. image:: https://img.shields.io/badge/License-MIT-green.svg :target: https://opensource.org/licenses/MIT :alt: License +| .. image:: https://coveralls.io/repos/github/OSeMOSYS/otoole/badge.svg?branch=master&kill_cache=1 :target: https://coveralls.io/github/OSeMOSYS/otoole?branch=master