Skip to content

Commit 23b0bbf

Browse files
committed
Clean up repo root and unused internal tooling (#1037)
Cleans up some unused non-framework code in the internal_tools folder and scripts. --------- Signed-off-by: Peter St. John <pstjohn@nvidia.com>
1 parent 658c538 commit 23b0bbf

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

ci/Pypi_publish.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
This is an overview of how to release bionemo sub-packages.
22

3+
<<<<<<< HEAD
34
01. The code should be in a sub-directory of `bionemo-framework/sub-packages`. The package should be named bionemo-\<package_name>. For an example of the directory structure, see https://github.com/NVIDIA/bionemo-framework/tree/main/sub-packages/bionemo-scdl.
45
The directory should contain:
56
- a `pyproject.toml` file with the dependencies
@@ -18,5 +19,26 @@ This is an overview of how to release bionemo sub-packages.
1819
08. In a clean python environment, download the package from test-pypi:
1920
`pip install --index-url https://test.pypi.org/simple/ --no-deps package-name`
2021
09. Run the code/notebooks from step 3.
22+
=======
23+
24+
1. The code should be in a sub-directory of `bionemo-framework/sub-packages`. The package should be named bionemo-<package_name>. For an example of the directory structure, see https://github.com/NVIDIA/bionemo-framework/tree/main/sub-packages/bionemo-scdl.
25+
The directory should contain:
26+
- a `pyproject.toml` file with the dependencies
27+
- a `README.md`
28+
- a `LICENSE` file
29+
- a `VERSION` file
30+
- the source code should be in src/bionemo/package-name.
31+
- the test should be in tests/bionemo/package-name. The test directory structure should be the same as the source code directory structure.
32+
2. Create some tests that can be run in a notebook within the package or as a small python script that verifies that the package is correctly installed. These can be re-purposed for QA test plan.
33+
3. In the VERSION file in the root of the sub-package, set the package version. Currently, the sub-package versions are independent of the overall BioNeMo version. An ideal approach is to specify the bionemo sub-package versions. That the package depends on. This may create issues. For example, an issue could arise if the latest version of your sub-package depends on the newest bionemo-core, but the latest pushed version of bionemo-core does not have these changes. It may be necessary to update bionemo-core then, but before updating another package, it should be tested and its authors should be consulted.
34+
4. Make sure that the directory dist doesn’t exist or is empty.
35+
5. Run `python -m build .`
36+
6. Create a test-pypi and pypi account if you don’t have one at: https://test.pypi.org/ and https://pypi.org/
37+
7. Upload to test-pypi with:
38+
`twine upload --repository-url https://test.pypi.org/legacy/ dist/* --non-interactive -u $TWINE_USERNAME -p $TWINE_PASSWORD`
39+
8. In a clean python environment, download the package from test-pypi:
40+
`pip install --index-url https://test.pypi.org/simple/ --no-deps package-name`
41+
9. Run the code/notebooks from step 3.
42+
>>>>>>> 18da256e (Clean up repo root and unused internal tooling (#1037))
2143
10. If everything looks good, upload it to the actual pypi repository: `twine upload dist/* --non-interactive -u $TWINE_USERNAME -p $TWINE_PASSWORD --verbose`
2244
11. Run steps 7 and 8 with pypi instead of test-pypi.

0 commit comments

Comments
 (0)