Skip to content
This repository has been archived by the owner on May 25, 2024. It is now read-only.

Commit

Permalink
Update version to 0.5.3 and add new features to README.
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 330535698
  • Loading branch information
gunjanbaid authored and copybara-github committed Sep 8, 2020
1 parent a355b0a commit d5c751e
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 8 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,16 @@ bazel test -c opt $BAZEL_FLAGS nucleus/...

## Version

This is Nucleus 0.5.2. Nucleus follows [semantic
This is Nucleus 0.5.3. Nucleus follows [semantic
versioning](https://semver.org/).

New in 0.5.3:

* Fixes memory leaks in message_module.cc.
* Updates setup.py to install .egg-info directory for pip 20.2+ compatibility.
* Pins TensorFlow to 2.0.0 for protobuf version compatibility.
* Pins setuptools to 49.6.0 to avoid breaking changes of setuptools 50.

New in 0.5.2:

* Upgrades htslib dependency from 1.9 to 1.10.2.
Expand Down
31 changes: 26 additions & 5 deletions docs/source/nucleus/pip_package/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,34 @@ Instead, we directly implement the four commands run by pip install
* setup.py clean

## Functions overview
Name | Description
-----|------------
[`find_destination`](#find_destination)`(is_user)` | Returns the directory we are supposed to install into.
[`main`](#main)`()` |
[`touch`](#touch)`(fname)` |

| Name | Description |
| -------------------------------------------------- | --------------------- |
| [`copy_egg_info`](#copy_egg_info)`(dest_dir)` | Copies the .egg-info |
: : directory to the :
: : specified location. :
| [`find_destination`](#find_destination)`(is_user)` | Returns the directory |
: : we are supposed to :
: : install into. :
| [`main`](#main)`()` | |
| [`touch`](#touch)`(fname)` | |

## Functions

<a name="copy_egg_info"></a>

### `copy_egg_info(dest_dir)`

```
Copies the .egg-info directory to the specified location.
Args:
dest_dir: str. The destination directory.
Returns:
0 on success, 1 on failure.
```

<a name="find_destination"></a>
### `find_destination(is_user)`
```
Expand Down
2 changes: 1 addition & 1 deletion nucleus/pip_package/build_pip_package.sh
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ set -x

# When changing NUCLEUS_VERSION, be sure to also change it in
# egg_files/PKG-INFO.
NUCLEUS_VERSION="0.5.2"
NUCLEUS_VERSION="0.5.3"
PACKAGE_NAME="google_nucleus-${NUCLEUS_VERSION}"
PYTHON_VERSION="3.5"

Expand Down
2 changes: 1 addition & 1 deletion nucleus/pip_package/egg_files/PKG-INFO
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: google-nucleus
Version: 0.5.2
Version: 0.5.3
Summary: A library for reading and writing genomics data.
Home-page: https://github.com/google/nucleus
Author: The Genomics team in Google Brain
Expand Down

0 comments on commit d5c751e

Please sign in to comment.