From 820188456bf0e9361fb7a1bdfe8c68e22e8185d9 Mon Sep 17 00:00:00 2001 From: Nelson-Gon Date: Fri, 3 Jul 2020 09:55:23 +0800 Subject: [PATCH] Save name on PyPI --- README.md | 18 +++++++++-- README.rst | 91 ++++++++++++++++++++++++++++++++++++---------------- changelog.md | 4 +++ setup.py | 2 +- 4 files changed, 85 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 4c6e7cf..fbd3bf9 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,37 @@ ![Stage](https://www.repostatus.org/badges/latest/wip.svg) ![Test Install](https://github.com/Nelson-Gon/cytounet/workflows/Test%20Install/badge.svg) ![Travis Build](https://travis-ci.com/Nelson-Gon/cytounet.svg?branch=master) +[![PyPI version fury.io](https://badge.fury.io/cytounet.svg)](https://pypi.python.org/pypi/cytounet/) +[![PyPI license](https://img.shields.io/pypi/l/cytounet.svg)](https://pypi.python.org/pypi/cytounet/) +[![PyPI download Month](https://img.shields.io/pypi/dm/cytounet.svg)](https://pypi.python.org/pypi/cytounet/) +[![PyPI download week](https://img.shields.io/pypi/dw/cytounet.svg)](https://pypi.python.org/pypi/cytounet/) +[![PyPI download day](https://img.shields.io/pypi/dd/pyautocv.svg)](https://pypi.python.org/pypi/cytounet/) [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Nelson-Gon/cytounet/graphs/commit-activity) [![GitHub last commit](https://img.shields.io/github/last-commit/Nelson-Gon/cytounet.svg)](https://github.com/Nelson-Gon/cytounet/commits/master) [![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/) [![GitHub issues](https://img.shields.io/github/issues/Nelson-Gon/cytounet.svg)](https://GitHub.com/Nelson-Gon/cytounet/issues/) [![GitHub issues-closed](https://img.shields.io/github/issues-closed/Nelson-Gon/cytounet.svg)](https://GitHub.com/Nelson-Gon/cytounet/issues?q=is%3Aissue+is%3Aclosed) -[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Nelson-Gon/cytounet/blob/master/LICENSE) + --- **Installation** +From `PyPI`: + +``` + +pip install cytounet + +``` + -To install: +From source or to use without installing locally: ``` git clone https://github.com/Nelson-Gon/cytounet.git +# proceed with usual source build procedure ``` diff --git a/README.rst b/README.rst index 8ddb239..0ff1e8e 100644 --- a/README.rst +++ b/README.rst @@ -5,23 +5,48 @@ :alt: Stage -.. image:: https://github.com/Nelson-Gon/unet/workflows/Test%20Install/badge.svg - :target: https://github.com/Nelson-Gon/unet/workflows/Test%20Install/badge.svg +.. image:: https://github.com/Nelson-Gon/cytounet/workflows/Test%20Install/badge.svg + :target: https://github.com/Nelson-Gon/cytounet/workflows/Test%20Install/badge.svg :alt: Test Install -.. image:: https://travis-ci.com/Nelson-Gon/unet.svg?branch=master - :target: https://travis-ci.com/Nelson-Gon/unet.svg?branch=master +.. image:: https://travis-ci.com/Nelson-Gon/cytounet.svg?branch=master + :target: https://travis-ci.com/Nelson-Gon/cytounet.svg?branch=master :alt: Travis Build +.. image:: https://badge.fury.io/cytounet.svg + :target: https://pypi.python.org/pypi/cytounet/ + :alt: PyPI version fury.io + + +.. image:: https://img.shields.io/pypi/l/cytounet.svg + :target: https://pypi.python.org/pypi/cytounet/ + :alt: PyPI license + + +.. image:: https://img.shields.io/pypi/dm/cytounet.svg + :target: https://pypi.python.org/pypi/cytounet/ + :alt: PyPI download Month + + +.. image:: https://img.shields.io/pypi/dw/cytounet.svg + :target: https://pypi.python.org/pypi/cytounet/ + :alt: PyPI download week + + +.. image:: https://img.shields.io/pypi/dd/pyautocv.svg + :target: https://pypi.python.org/pypi/cytounet/ + :alt: PyPI download day + + .. image:: https://img.shields.io/badge/Maintained%3F-yes-green.svg - :target: https://GitHub.com/Nelson-Gon/unet/graphs/commit-activity + :target: https://GitHub.com/Nelson-Gon/cytounet/graphs/commit-activity :alt: Maintenance -.. image:: https://img.shields.io/github/last-commit/Nelson-Gon/unet.svg - :target: https://github.com/Nelson-Gon/unet/commits/master +.. image:: https://img.shields.io/github/last-commit/Nelson-Gon/cytounet.svg + :target: https://github.com/Nelson-Gon/cytounet/commits/master :alt: GitHub last commit @@ -30,51 +55,63 @@ :alt: made-with-python -.. image:: https://img.shields.io/github/issues/Nelson-Gon/unet.svg - :target: https://GitHub.com/Nelson-Gon/unet/issues/ +.. image:: https://img.shields.io/github/issues/Nelson-Gon/cytounet.svg + :target: https://GitHub.com/Nelson-Gon/cytounet/issues/ :alt: GitHub issues -.. image:: https://img.shields.io/github/issues-closed/Nelson-Gon/unet.svg - :target: https://GitHub.com/Nelson-Gon/unet/issues?q=is%3Aissue+is%3Aclosed +.. image:: https://img.shields.io/github/issues-closed/Nelson-Gon/cytounet.svg + :target: https://GitHub.com/Nelson-Gon/cytounet/issues?q=is%3Aissue+is%3Aclosed :alt: GitHub issues-closed -.. image:: https://img.shields.io/badge/license-MIT-blue.svg - :target: https://github.com/Nelson-Gon/pyautocv/blob/master/LICENSE - :alt: license - - ---- **Installation** -To install: +From ``PyPI``\ : + +.. code-block:: + + + pip install cytounet + +From source or to use without installing locally: .. code-block:: - git clone https://github.com/Nelson-Gon/unet.git + git clone https://github.com/Nelson-Gon/cytounet.git + # proceed with usual source build procedure Or: .. code-block:: python - pip install git+https://github.com/Nelson-Gon/unet.git + pip install git+https://github.com/Nelson-Gon/cytounet.git + +**Import** + +.. code-block:: python + + + from cytounet.model import * + from cytounet.data import * + from cytounet.augmentation import * -**Sample Usage** +**Detailed Sample Usage** Please see the following examples: * - Typical Pipeline available `here `_ + Typical Pipeline available `here `_ * - A biological example showing segmentation of DIC images of embryos available `here `_ + A biological example showing segmentation of DIC images of embryos available `here `_ For more examples or to add your own, please see the -examples `folder `_. +examples `folder `_. **Is it supported?** @@ -108,7 +145,7 @@ a pull request to add such support. **To raise an issue or question** -Please raise an issue `here `_ if you have any discussion, criticism, +Please raise an issue `here `_ if you have any discussion, criticism, or bug reports. @@ -120,11 +157,11 @@ Thank you very much. * - Mouse Embryos `Dataset obtained `_ from Broad Bioimage Benchmark Collection. + Mouse Embryos `Dataset obtained `_ from Broad Bioimage Benchmark Collection. `Source `_. * - Red Blood Cell `Images `_ provided by Anne + Red Blood Cell `Images `_ provided by Anne Carpenter and Roger Wiegand, available `here `_ **Credits** @@ -138,7 +175,7 @@ to distribute it separately. This decision was taken in part due to the relative inactivity of the original implementation which would have made it harder to collaborate. Please take a look at the list of changes from the original implementation -`here `_. +`here `_. * The Unet algorithm was introduced by Ronneberger et al. in their `paper `_. diff --git a/changelog.md b/changelog.md index 7450261..8489fc7 100644 --- a/changelog.md +++ b/changelog.md @@ -1,5 +1,9 @@ # cytounet's changelog. +* Release 0.1.0 + +--- + * Renamed repository to `cytounet` to reflect the havy focus on biological images. * Initiated support for validation via `validGenerator`. diff --git a/setup.py b/setup.py index 86bc428..da7466d 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ version="0.1.0", description='A Keras-Tensorflow based Unet for Cyto Image Segmentation', url="http://www.github.com/Nelson-Gon/cytounet", - download_url=None, + download_url="https://github.com/Nelson-Gon/cytounet/archive/v0.1.0.zip", author='Nelson Gonzabato', author_email='gonzabato@hotmail.com', license='MIT',