pyds-cli

Version 0.6.4

This release includes several updates to the CLI configuration and test setup, as well as a version bump.

New Features

• The global git configuration has been moved from the test script to the CI workflow, and direct git command dependencies have been removed from the test scripts. This should improve the reliability and maintainability of the test setup. (b22f168) (Eric Ma)
• The CLI configuration has been updated to use GitHub Tester credentials by default. This should make it easier to use the CLI with GitHub testing. (1564e65) (Eric Ma)

Bug Fixes

• The version of the pyds-cli package in the pixi.lock file has been updated to 0.6.3 for compatibility. The SHA256 hash for the new version has also been updated. (f7bce31) (Eric Ma)
• The installation instructions in the README.md file have been updated to use the pixi install command. (7b59f66) (Eric Ma)

Deprecations

• None in this release.

Version 0.6.3

This release includes improvements to the project initialization process and updates to the release notes.

New Features

• Default branch is now set to 'main' during git initialization. The initial commit after project setup is also automated. Additionally, '.pixi' has been added to the .gitignore template. (1320d97) (Eric Ma)
• Release notes for version 0.6.2 have been added. (fc77b05) (github-actions)

Bug Fixes

No bug fixes were included in this release.

Deprecations

No deprecations were included in this release.

Version 0.6.2

This release includes updates to the project setup and dependency management, as well as a version bump.

New Features

• The pixi lockfile has been updated to ensure consistent dependency versions (68ca800, Eric Ma)
• The environment.yml file has been removed and pixi-kernel and ipython dependencies have been added to pyproject.toml to streamline dependency management (05d9399, Eric Ma)

Bug Fixes

No bug fixes were included in this release.

Deprecations

No deprecations were included in this release.

Note: The commit c315883 is a version bump and does not contain any new features or bug fixes. The commit 0dc3c14 is the addition of release notes for the previous version and does not contain any new features or bug fixes.

Version 0.6.1

This release includes several updates and improvements to the CUDA dependencies, error messages, and CI/CD system.

New Features

• Updated CUDA dependencies to use jaxlib with CUDA 12 and added system requirements for CUDA 12 on Linux 64-bit platform (0a2a1e3b, Eric Ma)
• Improved error message for missing .pixi directory and suggested running pixi install to create environment (29cbc5c9, Eric Ma)
• Updated pyproject.toml dependencies for ruamel.yaml and mkdocstrings (491059a3, Eric Ma)
• Introduced fixes to CI/CD system (eab8f5ff, Eric Ma)

Bug Fixes

• Removed the CUDA feature from pyproject.toml as it is no longer needed (eb8d154c, Eric Ma)
• Updated requires-python version in pyproject.toml, removed llamabot dependency from devtools, added devtools to default dependencies, imported sh.rm in tests/cli/conftest.py, and used rm to clean up temporary directory in tests (8a96bb13, Eric Ma)

Deprecations

• None in this release

Version 0.6.0

This release includes several improvements and new features to enhance the development experience.

New Features

• Pixi environment setup and adjustments: Introduced Pixi environment setup for better dependency management and testing across different setups. This includes adding a new pixi command in the CLI toolset and updating the pyproject.toml file to define Pixi environment configurations. (129cbd7) (Eric Ma)
• Automatic Pixi installation on ImportError: Added automatic Pixi installation when it is not found, ensuring seamless availability for users without manual intervention. (27fc2d2) (Eric Ma)
• Editable installation of pyds-cli in Pixi environment: Allowed for easier development and testing of the pyds-cli package within its own Pixi-managed environment. (48b4b45) (Eric Ma)
• Pre-commit dependency added: Included pre-commit in the pyproject.toml file to automatically run checks before commits are made, enhancing the development workflow. (00bdac3) (Eric Ma)
• Added cuda feature: Introduced a new CUDA feature to support GPU-accelerated computations. (01de9b5) (Eric Ma)
• Removed dependency on homebrew: Simplified the environment setup by removing the dependency on Homebrew. (85ee785) (Eric Ma)

Bug Fixes

• Improved error handling for missing Pixi dependency: Updated the error handling mechanism when the Pixi dependency is not found, providing users with a clear error message and a link to the installation instructions. (77bebf7) (Eric Ma)
• Replaced curl command with subprocess.run for Pixi installation: Ensured compatibility with environments where the sh module might not be available or preferred, and improved the portability and security of the installation script. (fab6122) (Eric Ma)
• Fixed missing blank lines and added extra ones for consistency: Applied minor style fixes to various Python files in the project to ensure consistency across the codebase according to PEP 8 guidelines. (830d5fdd) (Eric Ma)

Deprecations

• Removed conda command integration: Simplified the CLI interface by removing the conda command and its integration from the CLI application. (5ecc31bc) (Eric Ma)
• Removed llamabot from template: Removed the llamabot package from the template as it is no longer required. (8abd082) (Eric Ma)
• Removed cli tooling: Removed the CLI tooling as it is no longer needed in the project. (03a0d0e) (Eric Ma)
• Removed unused CLI commands and updated project templates: Refactored the CLI interface by removing unused commands and updating project templates to reflect the changes. (0b5872b) (Eric Ma)
• Removed unused docs command and cfgv dependency: Simplified the CLI application by removing unused components and dependencies, potentially reducing the maintenance overhead and improving the installation time for users. (68ac4c0) (Eric Ma)

Version 0.5.1

This release includes improvements to the project initialization process, with the addition of a .env file creation feature. This enhancement helps manage environment variables and paths for new Python data science projects.

New Features

• A .env file is now automatically generated during project initialization, which is crucial for managing environment variables and paths that should not be exposed publicly. (a3613e2, Eric Ma)
• A test case has been added to verify the presence of a .env file in the initialized project directory, ensuring that projects are correctly setting up environment variables. (f56e7b2, Eric Ma)

Bug Fixes

No bug fixes were included in this release.

Deprecations

No deprecations were included in this release.

Version 0.5.0

This release includes improvements to the GitHub Actions workflow for publishing, an updated FAQ section in the documentation, and adjustments to package discovery settings.

New Features

• Manual trigger option and concurrency control added to the GitHub Actions workflow for publishing (5453e67) (Eric Ma)
• New FAQ section introduced in the documentation (b196a48) (Eric Ma)

Bug Fixes

• Package discovery settings adjusted to include all modules within the package (f093891) (Eric Ma)

Deprecations

• No deprecations in this release.

Note: The commit 14f42d0a4429c5f56d874624582cd9c619233045 by github-actions is related to version bumping and does not introduce new features, bug fixes, or deprecations. The commit 81b877ca0a4bf2727f32e87e600eea2d5e5e4e24 by Eric Ma is a merge commit and does not contain any code changes. The commit b3ffabd732e48853cb844eff705e5eb57419e7c6 by Eric Ma is also a merge commit and does not contain any code changes. The commit f33f284bc3ce25f22ce0c9e4cb0e21762eac2298 by github-actions is related to adding release notes and does not introduce new features, bug fixes, or deprecations.

Version 0.4.4

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.

Version 0.4.3

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)

Version 0.4.2

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

Version 0.4.1

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.

Version 0.4.0

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

Version 0.3.9

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-action@v2 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)

Version 0.3.8

This new version includes several updates to the testing environment, pre-commit hooks, and GitHub Actions workflow. It also introduces a change to the setuptools configuration in the pyproject.toml.j2 template.

New Features

• The pytest fixture scope in the cli tests has been changed from "session" to "function", ensuring a more isolated testing environment (23ad0d0) (Eric Ma)
• The versions of pre-commit hooks have been updated to their latest versions, and the darglint hook has been replaced with pydoclint for better documentation linting (23ad0d0) (Eric Ma)
• The pytest fixture scope in the conftest.py file has been changed from "function" to "session", potentially improving the performance of the test suite (23ad0d0) (Eric Ma)
• The conda tests for rebuild and update now expect an exit code of 1 instead of 0, reflecting the assumption that these tests are always executed from within a conda environment, not the base environment (23ad0d0) (Eric Ma)
• The trigger events for the GitHub Actions workflow have been modified to include both pull requests and pushes to the main branch, and the version of the checkout action has been updated from v2 to v4 (52b7520) (Eric Ma)
• The setuptools configuration in the pyproject.toml.j2 template has been updated. The 'packages' field under 'tool.setuptools' has been replaced with a 'where' field under 'tool.setuptools.packages.find', allowing for more flexible package discovery (4fc10ff) (Eric Ma)

Bug Fixes

• None in this release.

Deprecations

• None in this release.

Version 0.3.7

This new version includes several improvements to the GitHub Actions workflow, code readability, and the release process. The GitHub Actions checkout step has been upgraded to version 4, with fetch-depth and fetch-tags options enabled. Code readability has been enhanced in several files, with long strings split into multiple lines and import statements rearranged. The release process now includes the generation of release notes using the llamabot tool.

New Features

• The GitHub Actions checkout step has been upgraded to version 4, with fetch-depth and fetch-tags options enabled to ensure all tags and history are fetched during the checkout process (bbaad2 and 4a0184) (Eric Ma)
• Release notes generation using the llamabot tool has been added to the PyPI package release workflow. The release notes are then added to the GitHub release body, automating the process of generating and adding release notes to each new release (a6685b) (Eric Ma)

Bug Fixes

• No bug fixes in this release.

Deprecations

• The typer command has been removed from the docs.yaml.j2 workflow file. The command was previously used to generate documentation, but is no longer necessary (43b773) (Eric Ma)