Repository Structure Standardization
Summary
Audit and refactor a scientific Python package to conform to organizational standards (configuration files, module naming, CI/CD workflows, metadata) and verify correct installation and functionality in its new location. This skill ensures reproducibility and maintainability when relocating codebases across GitHub organizations.
When to use
A scientific Python package is being moved to a new GitHub organization with different structural conventions (e.g., from a personal lab account to a community-led organization like metabolomics-cloud or scverse). You need to verify that the relocated package installs cleanly and executes core functionality without errors in its new environment.
When NOT to use
- The package is a single-file script or does not follow setuptools conventions — structured refactoring may not be necessary.
- The target organization has no published structural standards — standardization requires a clear target specification.
- The package has external dependencies that are incompatible with the target organization's Python or dependency versions.
Inputs
- Python package source code (setup.py, pyproject.toml, requirements.txt)
- CI/CD workflow definitions (.github/workflows)
- README and documentation files
- Unit and integration test suites
- Representative input datasets for functional validation
Outputs
- Migrated repository under target GitHub organization
- Updated configuration files (setup.py, pyproject.toml, .github workflows)
- Installation and functional test reports
- Migration report documenting conformance changes
How to apply
Begin by cloning the current repository and auditing its structure, dependencies, and configuration files (setup.py, pyproject.toml, requirements.txt, .github workflows) against the target organization's standards. Next, adapt package metadata, module naming, documentation structure, and CI/CD workflows to conform to the new organization's conventions. Create a new repository under the target organization with the migrated codebase and updated configuration. Run installation tests in a clean virtual environment using pip install to verify the package builds without errors. Execute core functionality tests (e.g., loading representative input files and running main analysis workflows) on actual or representative data to confirm runtime correctness. Finally, validate that all unit and integration tests pass and generate a migration report documenting conformance changes and verification results.
Related tools
- Python setuptools (Defines package metadata, dependencies, and installation configuration in setup.py or pyproject.toml)
- pip (Tests package installation in a clean environment to verify build correctness)
- GitHub Actions (CI/CD workflows (.github/workflows) updated to conform to organization standards) — https://github.com/metabolomics-cloud/mummichog
- pytest or unittest (Validates that all tests pass after migration)
Examples
python3 -m mummichog.main -i tests/ineurons_ttest_1127.tsv -j testneuron -a tests/empCpds_with_annotations.json -d .
Evaluation signals
- Package installs without errors in a fresh virtual environment using
pip install.
- All unit and integration tests pass in the new repository location.
- Core workflows execute successfully on representative metabolomics data (e.g., feature table input, functional prediction output).
- Configuration files (setup.py, pyproject.toml, .github workflows) match target organization conventions.
- Migration report documents all structural and metadata changes with no undocumented deviations.
Limitations
- Documentation does not specify which metabolomics-cloud organization standards were used as the migration target — standards vary by organization.
- Package builds may succeed but runtime failures can occur if dependencies have unspecified version requirements or platform-specific incompatibilities.
- The README does not detail how to handle compound identifier translation modules that may need lookup or cross-referencing during model migration.
Evidence
- [other] Audit and adaptation workflow: "Clone the current Mummichog 3 repository and audit its structure, dependencies, and configuration files (setup.py, pyproject.toml, requirements.txt, .github workflows) against metabolomics-cloud"
- [readme] Migration target and rationale: "Project is moved to new organization https://github.com/metabolomics-cloud, to follow examples of https://scverse.org/"
- [other] Installation verification: "Run installation tests in a clean environment using pip install to verify the package builds without errors."
- [other] Functional validation on representative data: "Execute core Mummichog functionality (e.g., loading feature tables and running functional prediction workflows) to confirm runtime correctness on representative metabolomics data."
- [other] Test verification and reporting: "Validate that all tests pass and generate a migration report documenting conformance changes and verification results."
1---2name: repository-structure-standardization3description: Use when a scientific Python package is being moved to a new GitHub organization with different structural conventions (e.g., from a personal lab account to a community-led organization like metabolomics-cloud or scverse).4license: CC-BY-4.05---67# Repository Structure Standardization89## Summary1011Audit and refactor a scientific Python package to conform to organizational standards (configuration files, module naming, CI/CD workflows, metadata) and verify correct installation and functionality in its new location. This skill ensures reproducibility and maintainability when relocating codebases across GitHub organizations.1213## When to use1415A scientific Python package is being moved to a new GitHub organization with different structural conventions (e.g., from a personal lab account to a community-led organization like metabolomics-cloud or scverse). You need to verify that the relocated package installs cleanly and executes core functionality without errors in its new environment.1617## When NOT to use1819- The package is a single-file script or does not follow setuptools conventions — structured refactoring may not be necessary.20- The target organization has no published structural standards — standardization requires a clear target specification.21- The package has external dependencies that are incompatible with the target organization's Python or dependency versions.2223## Inputs2425- Python package source code (setup.py, pyproject.toml, requirements.txt)26- CI/CD workflow definitions (.github/workflows)27- README and documentation files28- Unit and integration test suites29- Representative input datasets for functional validation3031## Outputs3233- Migrated repository under target GitHub organization34- Updated configuration files (setup.py, pyproject.toml, .github workflows)35- Installation and functional test reports36- Migration report documenting conformance changes3738## How to apply3940Begin by cloning the current repository and auditing its structure, dependencies, and configuration files (setup.py, pyproject.toml, requirements.txt, .github workflows) against the target organization's standards. Next, adapt package metadata, module naming, documentation structure, and CI/CD workflows to conform to the new organization's conventions. Create a new repository under the target organization with the migrated codebase and updated configuration. Run installation tests in a clean virtual environment using `pip install` to verify the package builds without errors. Execute core functionality tests (e.g., loading representative input files and running main analysis workflows) on actual or representative data to confirm runtime correctness. Finally, validate that all unit and integration tests pass and generate a migration report documenting conformance changes and verification results.4142## Related tools4344- **Python setuptools** (Defines package metadata, dependencies, and installation configuration in setup.py or pyproject.toml)45- **pip** (Tests package installation in a clean environment to verify build correctness)46- **GitHub Actions** (CI/CD workflows (.github/workflows) updated to conform to organization standards) — https://github.com/metabolomics-cloud/mummichog47- **pytest or unittest** (Validates that all tests pass after migration)4849## Examples5051```52python3 -m mummichog.main -i tests/ineurons_ttest_1127.tsv -j testneuron -a tests/empCpds_with_annotations.json -d .53```5455## Evaluation signals5657- Package installs without errors in a fresh virtual environment using `pip install`.58- All unit and integration tests pass in the new repository location.59- Core workflows execute successfully on representative metabolomics data (e.g., feature table input, functional prediction output).60- Configuration files (setup.py, pyproject.toml, .github workflows) match target organization conventions.61- Migration report documents all structural and metadata changes with no undocumented deviations.6263## Limitations6465- Documentation does not specify which metabolomics-cloud organization standards were used as the migration target — standards vary by organization.66- Package builds may succeed but runtime failures can occur if dependencies have unspecified version requirements or platform-specific incompatibilities.67- The README does not detail how to handle compound identifier translation modules that may need lookup or cross-referencing during model migration.6869## Evidence7071- [other] Audit and adaptation workflow: "Clone the current Mummichog 3 repository and audit its structure, dependencies, and configuration files (setup.py, pyproject.toml, requirements.txt, .github workflows) against metabolomics-cloud"72- [readme] Migration target and rationale: "Project is moved to new organization https://github.com/metabolomics-cloud, to follow examples of https://scverse.org/"73- [other] Installation verification: "Run installation tests in a clean environment using pip install to verify the package builds without errors."74- [other] Functional validation on representative data: "Execute core Mummichog functionality (e.g., loading feature tables and running functional prediction workflows) to confirm runtime correctness on representative metabolomics data."75- [other] Test verification and reporting: "Validate that all tests pass and generate a migration report documenting conformance changes and verification results."
HolobiomicsLab