Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces several significant updates to modernize the
pyensembl
project. Key changes include migrating the build system topyproject.toml
, improving the development workflow, and updating the codebase for compatibility with modern Python and NumPy versions. Additionally, the documentation has been expanded to include development and testing instructions.Build and Dependency Management:
setup.py
withpyproject.toml
for build system configuration, specifying dependencies, optional development dependencies, and package metadata. ([[1]](https://github.com/openvax/pyensembl/pull/317/files#diff-50c86b7ed8ac2cf95bd48334961bf0530cdc77b5a56f852c5c61b89d735fd711R1-R50)
,[[2]](https://github.com/openvax/pyensembl/pull/317/files#diff-60f61ab7a8d1910d86d9fda2261620314edcae5894d5aaa236b821c7256badd7L1-L74)
)Development Workflow Improvements:
pip install -e ".[dev]"
) and replaced the test execution command withpytest
for better coverage reporting. ([[1]](https://github.com/openvax/pyensembl/pull/317/files#diff-1db27d93186e46d3b441ece35801b244db8ee144ff1405ca27a163bfe878957fL31-R31)
,[[2]](https://github.com/openvax/pyensembl/pull/317/files#diff-1db27d93186e46d3b441ece35801b244db8ee144ff1405ca27a163bfe878957fL52-R50)
)test.sh
script in favor of directpytest
commands. ([test.shL1](https://github.com/openvax/pyensembl/pull/317/files#diff-3722d9ba8feb2d3feac8ce71a209a638d4b404e1c53f937188761181594023e2L1)
)Documentation Enhancements:
README.md
to include a new "Development and Testing" section with detailed instructions on installing the project in development mode, running tests, and generating coverage reports. ([README.mdR142-R195](https://github.com/openvax/pyensembl/pull/317/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R142-R195)
)README.md
by adding a proper title and header formatting. ([README.mdL7-R8](https://github.com/openvax/pyensembl/pull/317/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L7-R8)
)Codebase Modernization:
numpy.typeDict
to address its removal in recent NumPy versions. ([pyensembl/__init__.pyR13-R22](https://github.com/openvax/pyensembl/pull/317/files#diff-f73de41d4b9038f9a2c385bce083cc495653ba85a40666398cae6ab5e6892a20R13-R22)
)importlib.resources
for compatibility with Python 3.9+ and fallback support for older versions. ([[1]](https://github.com/openvax/pyensembl/pull/317/files#diff-c3dc15650bad87614d5861ce25700b34aeeb863ac948461a2cbdba096198534bL43-R46)
,[[2]](https://github.com/openvax/pyensembl/pull/317/files#diff-c3dc15650bad87614d5861ce25700b34aeeb863ac948461a2cbdba096198534bL52-R57)
)Notes
gtfparse @ git+https://github.com/nick-youngblut/gtfparse.git@pyarrow_update
in thepyproject.toml