Merge pull request #127 from DataONEorg/feature-118-citation-package

Feature-118: Citation Package Part 1

Author: doulikecookiedough

CONTRIBUTING.md

@@ -1,16 +1,16 @@
 # Contributing to HashStore
 
-:tada: First off, thanks for contributing! :tada:
+**🎉 First off, thanks for contributing! 🎉**
 
-- [Types of contributions](#types-of-contributions)
-- [Pull Requests](#pull-requests)
-- [Development Workflow](#development-workflow)
-- [Release process](#release-process)
-- [Testing](#testing)
-- [Code style](#code-style)
-- [Contributor license agreement](#contributor-license-agreement)
+- [✨ Types of Contributions](#types-of-contributions)
+- [🌳 Pull Requests](#pull-requests)
+- [🔀 Development Workflow](#development-workflow)
+- [🚀 Release Process](#release-process)
+- [🔬 Testing](#testing)
+- [🎨 Code Style](#code-style)
+- [📄 Contributor License Agreement](#contributor-license-agreement)
 
-## Types of contributions
+## ✨ Types of Contributions
 
 We welcome all types of contributions, including bug fixes, feature enhancements,
 bug reports, documentation, graphics, and many others.  You might consider contributing by:
@@ -29,7 +29,7 @@ made to increase the value of HashStore to the community.  We strive to
 incorporate code, documentation, and other useful contributions quickly and
 efficiently while maintaining a high-quality software product.
 
-## Pull Requests
+## 🌳 Pull Requests
 We use the pull-request model for contributions. See [GitHub's help on pull-requests](https://help.github.com/articles/about-pull-requests/).
 
 In short:
@@ -43,7 +43,7 @@ In short:
 - our team may request changes before we will approve the Pull Request, or we will make them for you
 - once the code is reviewed, our team will merge in your changes to `develop` for the next planned release
 
-## Development Workflow
+## 🔀 Development Workflow
 
 Development is managed through the git repository at https://github.com/DataONEorg/hashstore.  The repository is organized into several branches, each with a specific purpose.  
 
@@ -104,7 +104,7 @@ gitGraph
     merge develop id: "11" tag: "v1.1.0"
 ```
 
-## Release process
+## 🚀 Release Process
 
 1. Our release process starts with integration testing in a `develop` branch. Once all
 changes that are desired in a release are merged into the `develop` branch, we run
@@ -115,7 +115,7 @@ reflect the new release and the `develop` branch can be fast-forwarded to sync w
 start work on the next release.
 3. Releases can be downloaded from the [GitHub releases page](https://github.com/DataONEorg/hashstore/releases).
 
-## Testing
+## 🔬 Testing
 
 **Unit and integration tests**. HashStore has a full suite of `pytest` tests in the `tests` subdirectory.
 Any new code developed should include a robust set of tests for each public
@@ -127,15 +127,15 @@ or merging to `develop`.
 Tests are automatically run via GitHub Actions. Check the root `README.md` file
 for this GitHub Actions status badge and make sure it says "Passing":
 
-## Code style
+## 🎨 Code Style
 
 Code should be written to professional standards to enable clean, well-documented,
 readable, and maintainable software.  While there has been significant variability
 in the coding styles applied historically, new contributions should strive for
 clean code formatting.  We generally follow PEP8 guidelines for Python code formatting,
 typically enforced through the `black` code formatting package.
 
-## Contributor license agreement
+## 📄 Contributor License Agreement
 
 In order to clarify the intellectual property license
 granted with Contributions from any person or entity, you agree to

README.md

@@ -1,6 +1,6 @@
 ## HashStore: hash-based object storage for DataONE data packages
 
-- **Author**: Dou Mok, Matthew Brooke, Jing Tao, Matthew B. Jones
+- **Author**: Dou Mok, Matthew Brooke, Jing Tao, Jeanette Clarke, Ian Nesbitt, Matthew B. Jones
 - **License**: [Apache 2](http://opensource.org/licenses/Apache-2.0)
 - [Package source code on GitHub](https://github.com/DataONEorg/hashstore)
 - [**Submit Bugs and feature requests**](https://github.com/DataONEorg/hashstore/issues)

poetry.lock

@@ -1,20 +1,35 @@
 [tool.poetry]
 name = "hashstore"
-version = "1.1.0"
-description = "HashStore, a hash-based object store for data packages."
+version = "1.0.0"
+description = "HashStore, an object storage system using content identifiers."
 authors = ["Dou Mok <[email protected]>", "Matt Jones <[email protected]>"]
 readme = "README.md"
+keywords = ["filesystem", "object storage", "hashstore", "storage"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: Apache Software License",
+  "Natural Language :: English",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: System :: Filesystems"
+]
 
 [tool.poetry.dependencies]
-python = "^3.9"
-pathlib = "^1.0.1"
-pyyaml = "^6.0"
+python = ">=3.9"
+pathlib = ">=1.0.1"
+pyyaml = ">=6.0"
 
 [tool.poetry.group.dev.dependencies]
-pytest = "^7.2.0"
-black = "^22.10.0"
-pylint = "^2.17.4"
-pg8000 = "^1.29.8"
+pytest = ">=7.2.0"
+black = ">=22.10.0"
+pylint = ">=2.17.4"
+pg8000 = ">=1.29.8"
 
 [tool.poetry.scripts]
 hashstore = "hashstore.hashstoreclient:main"

pyproject.toml

@@ -1,18 +1,19 @@
-"""HashStore is a hash-based object store for data packages. It uses 
-cryptographic hash functions to name files consistently.
-HashStore creates a directory where objects and metadata are 
-stored using a hash value as the name.
+"""HashStore is an object storage file system that provides persistent file-based
+storage using content identifiers/hashes to de-duplicate data.
 
 HashStore is mainly focused on storing DataONE data package contents
 on a shared file system for simple and fast access by data management
 processes that function across a cluster environment. Some properties:
 
 - Data objects are immutable and never change
-- Data objects are named using the SHA-256, base64-encoded hash of their contents
+- Data objects are named using the base64-encoded hash of their contents
     (thus, a content-identifier)
-- Metadata objects are stored with the formatId, a null character and its contents
-- Metadata objects are named using the SHA-256 + formatId, base64-encoded hash of
-    their persistent identifier (PID)
+- Metadata documents for a given identifier are stored in a directory structure
+    based on the base64-encoded hash of the identifier
+- Metadata objects are named using the base64-encoded hash of the given identifier
+    + its respective format_id/namespace
+- The relationships between data objects and metadata are managed with a reference
+    system.
 """
 
 from hashstore.hashstore import HashStore, HashStoreFactory, ObjectMetadata