Skip to content

Commit

Permalink
Update README.md and filehashstore class docstring for accuracy
Browse files Browse the repository at this point in the history
  • Loading branch information
doulikecookiedough committed Jun 24, 2024
1 parent d63aea8 commit 18cb8bf
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
- Contact us: support@dataone.org
- [DataONE discussions](https://github.com/DataONEorg/dataone/discussions)

HashStore is a server-side python package implementing a content-based identifier file system for storing and accessing data and metadata for DataONE services. The package is used in DataONE system components that need direct, filesystem-based access to data objects, their system metadata, and extended metadata about the objects. This package is a core component of the [DataONE federation](https://dataone.org), and supports large-scale object storage for a variety of repositories, including the [KNB Data Repository](http://knb.ecoinformatics.org), the [NSF Arctic Data Center](https://arcticdata.io/catalog/), the [DataONE search service](https://search.dataone.org), and other repositories.
HashStore is a server-side python package providing persistent file-based storage using content hashes to de-duplicate data for storing and accessing data and metadata for DataONE services. The package is used in DataONE system components that need direct, filesystem-based access to data objects, their system metadata, and extended metadata about the objects. This package is a core component of the [DataONE federation](https://dataone.org), and supports large-scale object storage for a variety of repositories, including the [KNB Data Repository](http://knb.ecoinformatics.org), the [NSF Arctic Data Center](https://arcticdata.io/catalog/), the [DataONE search service](https://search.dataone.org), and other repositories.

DataONE in general, and HashStore in particular, are open source, community projects. We [welcome contributions](https://github.com/DataONEorg/hashstore/blob/main/CONTRIBUTING.md) in many forms, including code, graphics, documentation, bug reports, testing, etc. Use the [DataONE discussions](https://github.com/DataONEorg/dataone/discussions) to discuss these contributions with us.

Expand All @@ -18,7 +18,7 @@ Documentation is a work in progress, and can be found on the [Metacat repository

## HashStore Overview

HashStore is a content-addressable file management system that utilizes the content identifier of an object to address files. The system stores objects, references (refs) and metadata in its respective directories and provides an API for interacting with the store. HashStore storage classes (like `FileHashStore`) must implement the HashStore interface to ensure the expected usage of HashStore.
HashStore is an object storage system that stores data objects based on the their content identifiers. The system stores objects, references (refs) and metadata in its respective directories and provides a content identifier-based API for interacting with the HashStore. HashStore storage classes (like `FileHashStore`) must implement the HashStore interface to ensure the expected usage of HashStore.

###### Public API Methods
- store_object
Expand Down
7 changes: 4 additions & 3 deletions src/hashstore/filehashstore.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,10 @@


class FileHashStore(HashStore):
"""FileHashStore is a content-addressable file manager based on Derrick
Gilland's 'hashfs' library. It supports the storage of objects on disk using
a content identifier to address files.
"""FileHashStore is an object storage system that was extended from Derrick Gilland's
'hashfs' library. It supports the storage of objects on disk using a content identifier
to address files (data objects are de-duplicated) and provides a content identifier-based
API to interact with a HashStore.
FileHashStore initializes using a given properties dictionary containing the
required keys (see Args). Upon initialization, FileHashStore verifies the provided
Expand Down

0 comments on commit 18cb8bf

Please sign in to comment.