Merge pull request #1 from alexandrainst/feat/v0.0.x

Feat/v0.0.x

.github/workflows/ci.yaml

@@ -1,9 +1,6 @@
 name: CI
 
 on:
-  push:
-    branches:
-      - main
   pull_request:
     branches:
       - main

CHANGELOG.md

@@ -6,21 +6,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 
-## [Unreleased]
+## [v0.0.1] - 2022-08-29
 ### Added
-- [New features that were added]
-
-### Changed
-- [Existing features that were fixed]
-
-### Deprecated
-- [Existing features that were deprecated and will be removed soon]
-
-### Removed
-- [Existing features that were removed]
-
-### Fixed
-- [Bugs that were fixed]
-
-### Security
-- [Security vulnerabilities that were patched]
+- First release, which includes evaluation of sentiment models from the Hugging Face
+  Hub. This can be run with the CLI using the `evaluate` command, or via a script using
+  the `Evaluator` class.

README.md

@@ -10,7 +10,7 @@ ______________________________________________________________________
 [![Documentation](https://img.shields.io/badge/docs-passing-green)](https://alexandrainst.github.io/aiai/aiai.html)
 [![License](https://img.shields.io/github/license/alexandrainst/aiai)](https://github.com/alexandrainst/aiai/blob/main/LICENSE)
 [![LastCommit](https://img.shields.io/github/last-commit/alexandrainst/aiai)](https://github.com/alexandrainst/aiai/commits/main)
-[![Code Coverage](https://img.shields.io/badge/Coverage-0%25-red.svg)](https://github.com/alexandrainst/aiai/tree/main/tests)
+[![Code Coverage](https://img.shields.io/badge/Coverage-100%25-brightgreen.svg)](https://github.com/alexandrainst/aiai/tree/main/tests)
 
 
 ## Installation

makefile

@@ -67,20 +67,17 @@ view-docs:
 		esac; \
 		"$${openCmd}" docs/aiai.html
 
-publish-major:
+bump-major:
 	@poetry run python -m src.scripts.versioning --major
-	@$(MAKE) publish
-	@echo "Published major version!"
+	@echo "Bumped major version!"
 
-publish-minor:
+bump-minor:
 	@poetry run python -m src.scripts.versioning --minor
-	@$(MAKE) publish
-	@echo "Published minor version!"
+	@echo "Bumped minor version!"
 
-publish-patch:
+bump-patch:
 	@poetry run python -m src.scripts.versioning --patch
-	@$(MAKE) publish
-	@echo "Published patch version!"
+	@echo "Bumped patch version!"
 
 publish:
 	@if [ ${PYPI_API_TOKEN} = "" ]; then \
@@ -89,6 +86,13 @@ publish:
 		echo "Publishing to PyPI..."; \
 		poetry publish --build --username "__token__" --password ${PYPI_API_TOKEN}; \
 	fi
+	@echo "Published!"
+
+publish-major: bump-major publish
+
+publish-minor: bump-minor publish
+
+publish-patch: bump-patch publish
 
 test:
 	@poetry run pytest && readme-cov

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "aiai"
-version = "0.0.0"
+version = "0.0.1"
 description = "Alexandra Institute Artificial Intelligence, a Python package for Danish data science."
 authors = [
     "Dan Saattrup Nielsen <[email protected]>",

tests/test_subpackages.py

@@ -0,0 +1,7 @@
+"""Unit tests for the imported subpackages."""
+
+
+def test_evaluator_import():
+    from aiai_eval import Evaluator
+
+    assert hasattr(Evaluator, "evaluate")