Toolkit for chromosome segmentation and manipulation in microscopy images, designed for advanced genetic analysis.
It provides:
Guide
pip install -r requirements.txt
python -m unittest discover tests
pytest --html=test-reports/report.html
Generate distribution: python setup.py sdist bdist_wheel
Publish in PyPI: twine upload dist/*
A conventional commit typically follows the following structure:
Type: Indicates the nature of the commit. Common types include feat
(for new features), fix
(for bug fixes), docs
(for documentation changes), style
(for code style changes that do not affect behavior), refactor
(for code refactoring), test
(for adding or modifying tests), among others.
Scope (optional): Can be used to specify the part of the code being changed by the commit.
Description: A concise and clear description of what was changed in the commit.
Here are some examples of commit messages following the Conventional Commits standard:
feat: Add support for OAuth authentication
fix: Fix logic error in tax calculation
docs: Update documentation for endpoint /api/users
style: Adjust indentation in views.py file
refactor: Extract email validation function to util.py
test: Add unit tests for login function
There are tools that help implement and maintain the Conventional Commits standard, such as commitizen
and git-cz
, which guide developers in creating commit messages in the correct format.
Following these guidelines not only improves team collaboration but also facilitates the maintenance and evolution of software projects over time.
Before commits and pushes
pre-commit run --all-files
sphinx-apidoc -o docs/source/ ../chromotools
make html
https://peps.python.org/pep-0008/
Description: Toolkit for chromosome segmentation, designed for advanced genetic analysis.
Author: contato@daftar.digital
Published: Sat, 06 Jul 2024 20:26:26 GMT
Link: 0.1
Website: https://daftar.digital
Documentation: https://daftar.digital/doc
Source code: https://github.com/daftar/chromotools
Contributing: https://daftar/chromotools/dev/index.html
Bug reports: https://github.com/daftar/chromotools/issues