Pyds-cli

This release includes a new feature to streamline the initial setup process for new projects created with the pyds template.

New Features

- A README.md template has been added within the project template directory, which includes basic project information placeholders and a quick start guide for setting up a development environment using mamba and conda, followed by installing the project in editable mode. (ee9b6166, Eric Ma)

Bug Fixes

No bug fixes were included in this release.

Deprecations

No deprecations were included in this release.

Note: The commit `1bd2ec7c1027ca91546d4d5b115e1c9fda2a6eec` by `github-actions` only bumped the version number and did not introduce any new features, bug fixes, or deprecations. The commit `5888b77252d479013d2642d08fe2c48aa17eb020` by `github-actions` added release notes for version 0.4.3 and did not introduce any new features, bug fixes, or deprecations. Therefore, they are not included in the release notes for version 0.4.4.

This release includes several improvements to the pre-commit configuration, updates to various hook versions, and a new feature for project templates.

New Features

- Pre-commit hooks are now installed before running in the release workflow, ensuring code style and other checks are applied automatically before a release is made (da8236d) (Eric Ma)
- Added a pre-commit configuration for project templates, improving code quality and consistency in generated projects (79ddb4ae) (Eric Ma)
- Disabled line length rule for markdown files, allowing for more flexibility in formatting (1d460a6) (Eric Ma)

Bug Fixes

- Ensured pre-commit runs twice on failure in the GitHub Actions workflow, improving the robustness of the CI process (bd82cb2) (Eric Ma)
- Corrected the project name variable in the template, ensuring consistency across the template configuration (0ec8186) (Eric Ma)
- Fixed an issue with the `__project_snakecase` variable in `cookiecutter.json` to handle hyphens correctly (08beffb) (Eric Ma)

Deprecations

- Replaced darglint with pydoclint for docstring linting in the pre-commit configuration (23a38b3) (Eric Ma)

Additionally, various hook versions have been updated to their latest versions to ensure compatibility and leverage improvements:

- Pre-commit hooks: v4.6.0
- Nbstripout: v0.7.1
- Interrogate: v1.7.0
- Pydoclint: v0.4.1
- Ruff-pre-commit: v0.3.5

(2cd5474) (Eric Ma)

Please note that the version of pydoclint has been updated to v0.3.8 in the pre-commit configuration. (23a38b3) (Eric Ma)

Finally, the pre-commit hooks are now properly installed in the CI environment before running, preventing potential issues related to missing or misconfigured hooks. (3552315) (Eric Ma)

This release includes several improvements to the presentation template, build process, and GitHub Actions workflow.

New Features

- Updated presentation options in the talk template, changing the transition effect to 'slide' and adding a 'nord' highlight theme for code blocks (6e6fe7f, Eric Ma)
- Added a markdownlint configuration file to enforce style and conventions within talk templates (65fad6d, Eric Ma)

Bug Fixes

- Corrected the syntax for accessing `GHPAGES_TOKEN` secret in the GitHub Actions workflow for publishing (1adeed5, Eric Ma)
- Streamlined the slide build and deployment process by replacing direct reveal-md commands with `make build` in GitHub Actions and simplifying the `Makefile` (78fbf50, Eric Ma)
- Fixed a missing newline at the end of the v0.4.1 release notes document for better compatibility with UNIX text processing tools and standards (538c395, Eric Ma)

Deprecations

- None in this release

This release includes improvements to the package's completeness by recursively including all files within the `pyds` directory.

New Features

- All files within the `pyds` directory are now recursively included, improving the package's completeness. (51d5cb7) (Eric Ma)

Bug Fixes

No bug fixes were included in this release.

Deprecations

No deprecations were included in this release.

Note: The commit `f97ab3ff2dedd91b5747614c7babe8984596e536` by `github-actions` only bumped the version number, so it is not included in the release notes. The commit `851a62b8773499b68a5cdb65942138b9d9a4dd84` by `github-actions` added the release notes for version 0.4.0, so it is also not included in the release notes for version 0.4.1.

This release includes several improvements to the project, including streamlining the release process, enhancing test coverage, and updating the project template.

New Features

- Automated release notes generation and commit using `llamabot` (08e24ed, Eric Ma)
- Added tests for talk initialization and removed deprecated project init test (e580139, Eric Ma)
- Enhanced project initialization and update tests (503193c, Eric Ma)
- Removed talk\_name parameter from init function (b8e659c, Eric Ma)
- Removed conda activation from test workflow (852939a, Eric Ma)
- Added affiliation field and updated title placeholder in talk template (95a353e, Eric Ma)
- Added 'sh' library to project dependencies (2e24c17, Eric Ma)
- Replaced run() with sh.which in discover\_conda\_executable (19bffb5, Eric Ma)
- Updated micromamba version to latest in pr-tests.yaml workflow (83855ac, Eric Ma)
- Added micromamba support in discover\_conda\_executable (bbc336a, Eric Ma)
- Added clean target to PHONY in Makefile (09867ec, Eric Ma)
- Upgraded micromamba version to 1.8.1 (21e4ac6, Eric Ma)
- Enhanced cookiecutter.json and renamed files in talk template (afb32a1, Eric Ma)
- Streamlined CLI commands and improved project initialization (c6084ec, Eric Ma)
- Simplified project initialization process using cookiecutter (8c71c86, Eric Ma)
- Removed mamba from dependencies (69807ad, Eric Ma)
- Added cookiecutter to project dependencies (e580010, Eric Ma)
- Simplified environment variable function names (62736b6, Eric Ma)
- Removed mamba from dependencies (9971110, Eric Ma)
- Updated variable names and added new variables in cookiecutter.json (3660324, Eric Ma)
- Updated variable naming convention in project templates (f0a6737, Eric Ma)
- Renamed project template files in pyds (de86484, Eric Ma)
- Added project template configuration and updated file paths (21fbd09, Eric Ma)
- Replaced miniconda with micromamba in PR tests workflow (542facb, Eric Ma)
- Replaced miniconda setup with micromamba in GitHub workflows (460c3cb, Eric Ma)
- Added project and talk template directory paths (f1db6e7, Eric Ma)
- Specified Python version in GitHub workflow (9183364, Eric Ma)
- Removed black from pre-commit hooks (558fe0a, Eric Ma)
- Restructured project templates and removed unused files (a4a2921, Eric Ma)
- Updated template directory path and cleanup unused code (baf1112, Eric Ma)
- Added 'talk' command to pyds CLI (6d08cc6, Eric Ma)
- Added talk initialization command (f070660, Eric Ma)
- Added cookiecutter to dependencies (b040201, Eric Ma)
- Added talk template to pyds-cli (a858a04, Eric Ma)
- Added Makefile for talk presentations (e4f60c9, Eric Ma)
- Added GitHub Actions workflow and .gitignore for talk slides (bb0abb2, Eric Ma)
- Relocated template files to 'repo' subdirectory (e10f349, Eric Ma)

Bug Fixes

- Removed redundant activation of base environment in conda update command (dc660dc, Eric Ma)
- Added coverage omission for test files (b31d191, Eric Ma)
- Added coverage configuration to omit patterns (95565d4, Eric Ma)

Deprecations

- None in this release

This new version introduces an optional feature for automatic generation of release notes and improves the quality of the code that is released to PyPI by ensuring that it passes all pre-commit checks. It also simplifies the testing workflow by removing an unnecessary step.

New Features

- Added an optional feature for automatic generation of release notes. This feature uses the llamabot tool and the pre-commit tool to ensure that all generated files adhere to the file quality standards. (503a4da) (Eric Ma)
- Updated the PyPI release workflow to include pre-commit. This change ensures that all files pass the pre-commit checks before a release is made. (d58f176) (Eric Ma)

Bug Fixes

- No bug fixes in this release.

Deprecations

- Removed the step for uploading code coverage in the GitHub Actions workflow file pr-tests.yaml. This step was previously using the codecov/codecov-actionv2 action. (eda5ef8) (Eric Ma)

Other Changes

- Bumped version from 0.3.8 to 0.3.9. (475dbe) (github-actions)
- Specified exact string to look for when bumping versions. (b799733) (Eric Ma)