diff --git a/CHANGELOG.md b/CHANGELOG.md index b0d11d3..d5e5f1d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,14 @@ # Change Log All notable changes to this project will be documented in this file. -The format is based on [Keep a Changelog](http://keepachangelog.com/) +The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). +## 2.5.1 - 2022-03-04 + +### Changed +- updated pypi documentation + ## 2.5.0 - 2022-03-04 ### Fixed @@ -49,13 +54,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ## 2.3.2 - 2020-09-24 ### Fixed -- When rabbitmq restarts the extractor would not stop and restart, resulting +- When rabbitmq restarts the extractor would not stop and restart, resulting in the extractor no longer receiving any messages. #17 ### Added - Can specify url to use for extractor downloads, this is helpful for instances that have access to the internal URL for clowder, for example in docker/kubernetes. - + ### Removed - Removed ability to run multiple connectors in the same python process. If parallelism is needed, use multiple processes (or containers). @@ -141,7 +146,7 @@ install pyclowder. ### Fixed - Error decoding json body from Clowder when filename had special characters - [CATSPYC-18] (https://opensource.ncsa.illinois.edu/jira/browse/CATSPYC-18) + [CATSPYC-18] (https://opensource.ncsa.illinois.edu/jira/browse/CATSPYC-18) - RABBITMQ_QUEUE variable/flag was ignored when set and would connect to default queue. diff --git a/README.md b/README.md index a31e869..9e5a648 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ create new extractors. Install using pip (for most recent versions see: https://pypi.org/project/pyclowder/): ``` -pip install pyclowder==2.5.0 +pip install pyclowder==2.5.1 ``` Install pyClowder on your system by cloning this repo: diff --git a/description.rst b/description.rst index 53b754b..a820f9b 100644 --- a/description.rst +++ b/description.rst @@ -1,25 +1,39 @@ -This package provides standard functions for interacting with the -Clowder open source data management system. Clowder is designed -to allow researchers to build customized catalogs in the clouds -to help you manage research data. +This package provides standard functions for interacting with the Clowder +open source data management system. Clowder is designed to allow researchers +to build customized catalogs in the clouds to help you manage research data. + +One of the most interesting aspects of Clowder is the ability to extract +metadata from any file. This ability is created using extractors. To make it +easy to create these extractors in python we have created a module called +clowder. Besides wrapping often used api calls in convenient python calls, we +have also added some code to make it easy to create new extractors. Installation ------------ -The easiest way install pyclowder is using pip and pulling from PyPI. -Use the following command to install:: +Install using pip (for most recent versions see: https://pypi.org/project/pyclowder/): + +``` +pip install pyclowder==2.5.1 +``` - pip install pyclowder +Install pyClowder on your system by cloning this repo: -Because this system is still under rapid development, you may want to -install by cloning the repo using the following commands:: +``` +git clone https://github.com/clowder-framework/pyclowder.git +cd pyclowder +pip install -r requirements.txt +python setup.py install +``` - git clone https://opensource.ncsa.illinois.edu/bitbucket/scm/cats/pyclowder.git - cd pyclowder - pip install -r requirements.txt - python setup.py install +or directly from GitHub: -Or you can install directly from NCSA's Bitbucket:: +``` +pip install -r https://raw.githubusercontent.com/clowder-framework/pyclowder/master/requirements.txt git+https://github.com/clowder-framework/pyclowder.git +``` - pip install -r https://opensource.ncsa.illinois.edu/bitbucket/projects/CATS/repos/pyclowder/raw/requirements.txt git+https://opensource.ncsa.illinois.edu/bitbucket/scm/cats/pyclowder.git +Quickstart example +------------------ +See the [README](https://github.com/clowder-framework/pyclowder/tree/master/sample-extractors/wordcount#readme) +in `sample-extractors/wordcount`. Using Docker, no install is required. diff --git a/docs/source/conf.py b/docs/source/conf.py index 7a97120..e62c620 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ # The short X.Y version. version = u'2.5' # The full version, including alpha/beta/rc tags. -release = u'2.5.0' +release = u'2.5.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/sample-extractors/wordcount/requirements.txt b/sample-extractors/wordcount/requirements.txt index f079657..ef1b12f 100644 --- a/sample-extractors/wordcount/requirements.txt +++ b/sample-extractors/wordcount/requirements.txt @@ -1 +1 @@ -pyclowder==2.5.0 \ No newline at end of file +pyclowder==2.5.1 \ No newline at end of file diff --git a/setup.py b/setup.py index 898334f..a27c79d 100644 --- a/setup.py +++ b/setup.py @@ -8,7 +8,7 @@ setup( name='pyclowder', - version='2.5.0', + version='2.5.1', description='Python SDK for the Clowder Data Management System', long_description=long_description, diff --git a/version.sh b/version.sh index 107e62c..6f7fb01 100755 --- a/version.sh +++ b/version.sh @@ -1,11 +1,12 @@ #!/bin/bash -VERSION=${1:-2.5.0} +VERSION=${1:-2.5.1} MAJOR=${VERSION%.*} sed -i~ "s/## unreleased.*/## ${VERSION} - $(date +'%Y-%m-%d')/i" CHANGELOG.md sed -i~ "s/pyclowder==.*/pyclowder==${VERSION}/" README.md +sed -i~ "s/pyclowder==.*/pyclowder==${VERSION}/" description.rst sed -i~ "s/pyclowder==.*/pyclowder==${VERSION}/" sample-extractors/wordcount/requirements.txt sed -i~ -e "s/release = u'.*'/release = u'${VERSION}'/" -e "s/version = u'.*'/version = u'${MAJOR}'/" docs/source/conf.py sed -i~ "s/version='.*'/version='${VERSION}'/" setup.py