v1.0.0

Release Notes for Version v1.0.0

We are excited to announce the release of version v1.0.0 of our software. This release brings significant changes, including new features, documentation updates, and miscellaneous tasks. It's important to note that this version is not backward compatible with previous versions. We strongly recommend reviewing the changes and updates before upgrading.

Changes

🚀 Features

• Pythonic Server (#178): We have introduced a more Pythonic way to interact with the server, enhancing the user experience and making integration with other Python tools and libraries smoother. Thanks to @cauliyang for this significant improvement.

    client = Client(
        host=host,
        port=port,
        seq_dir=seq_dir,
        min_score=20,  
        min_identity=90,  
    )

    with Server(host, port, two_bit, can_stop=True, step_size=5) as server:
        # work() assume work() is your own function that takes time to prepare something
        server.wait_ready()  
        result1 = client.query("ATCG")  

For more details please go to https://pxblat.readthedocs.io/en/latest/index.html

📚 Documentation

• Installation Guide and Compatibility Matrix Update (#179): The installation guide has been updated to reflect the latest changes, and the compatibility matrix has been revised for clarity and accuracy. Kudos to @cauliyang for these updates.
• Enhanced Tutorial: The tutorial has been completely rewritten and now includes code examples to provide a more comprehensive and user-friendly guide.

Miscellaneous Tasks

• New Test Data: Additional test data files have enhanced the tutorial experience.
• Configuration Updates: The pre-commit configuration has been updated to exclude tutorial.md from blacken-docs, ensuring the tutorial remains accessible and easy to follow.
• Exclusions Update in pyproject.toml: The pyproject.toml file has been updated to exclude new tutorial data files, keeping the project configuration tidy and well-organized.

📦 Dependencies

• Updated Dependencies: Several dependencies have been updated to their latest versions:
  • pypa/cibuildwheel has been bumped from 2.12.3 to 2.16.2 (#177). Thanks to @dependabot for this update.
  • docker/setup-qemu-action has been bumped from version 2 to 3 (#176). This update was also provided by @dependabot.
  • virtualenv has been bumped from 20.24.5 to 20.24.6 in .github/workflows (#174), and actions/checkout has been updated from version 3 to 4 (#175). Both of these updates were made possible thanks to @dependabot.

Important Notice on Backward Compatibility

This release includes changes that are not backward compatible with previous versions. We strongly recommend you review all the changes detailed in this release note and update your codebase accordingly to make sure you're able to transition smoothly to this new version.

We appreciate your continued support and are here to assist with any questions or issues you may have during the upgrade process. Thank you for being a part of our community!