Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up sdist and build instructions #90

Merged
merged 3 commits into from
Jul 18, 2024
Merged

Clean up sdist and build instructions #90

merged 3 commits into from
Jul 18, 2024

Conversation

rly
Copy link
Contributor

@rly rly commented Jul 17, 2024

The build instructions in pyproject.toml were confusing. In addition, the sdist did not include all the files that document the package, such as the changelog and requirements files.

Before:

❯ tar -xzvf ndx_pose-0.2.0.tar.gz 
x ndx_pose-0.2.0/docs/Makefile
x ndx_pose-0.2.0/docs/README.md
x ndx_pose-0.2.0/docs/make.bat
x ndx_pose-0.2.0/docs/source/conf.py
x ndx_pose-0.2.0/docs/source/conf_doc_autogen.py
x ndx_pose-0.2.0/docs/source/credits.rst
x ndx_pose-0.2.0/docs/source/description.rst
x ndx_pose-0.2.0/docs/source/format.rst
x ndx_pose-0.2.0/docs/source/index.rst
x ndx_pose-0.2.0/docs/source/release_notes.rst
x ndx_pose-0.2.0/docs/source/_static/theme_overrides.css
x ndx_pose-0.2.0/spec/ndx-pose.extensions.yaml
x ndx_pose-0.2.0/spec/ndx-pose.namespace.yaml
x ndx_pose-0.2.0/src/pynwb/README.md
x ndx_pose-0.2.0/src/pynwb/ndx_pose/__init__.py
x ndx_pose-0.2.0/src/pynwb/ndx_pose/pose.py
x ndx_pose-0.2.0/src/pynwb/ndx_pose/io/__init__.py
x ndx_pose-0.2.0/src/pynwb/ndx_pose/io/pose.py
x ndx_pose-0.2.0/src/pynwb/ndx_pose/testing/mock/__init__.py
x ndx_pose-0.2.0/src/pynwb/ndx_pose/testing/mock/pose.py
x ndx_pose-0.2.0/src/pynwb/tests/__init__.py
x ndx_pose-0.2.0/src/pynwb/tests/test_example_usage.py
x ndx_pose-0.2.0/src/pynwb/tests/back_compat/generate_data_0.1.1.py
x ndx_pose-0.2.0/src/pynwb/tests/back_compat/test_read.py
x ndx_pose-0.2.0/src/pynwb/tests/integration/hdf5/__init__.py
x ndx_pose-0.2.0/src/pynwb/tests/integration/hdf5/test_pose.py
x ndx_pose-0.2.0/src/pynwb/tests/unit/__init__.py
x ndx_pose-0.2.0/src/pynwb/tests/unit/test_pose.py
x ndx_pose-0.2.0/.gitignore
x ndx_pose-0.2.0/LICENSE.txt
x ndx_pose-0.2.0/README.md
x ndx_pose-0.2.0/pyproject.toml
x ndx_pose-0.2.0/PKG-INFO

After:

❯ tar -xzvf ndx_pose-0.2.0.tar.gz 
x ndx_pose-0.2.0/CHANGELOG.md
x ndx_pose-0.2.0/requirements-dev.txt
x ndx_pose-0.2.0/requirements-min.txt
x ndx_pose-0.2.0/docs/Makefile
x ndx_pose-0.2.0/docs/README.md
x ndx_pose-0.2.0/docs/make.bat
x ndx_pose-0.2.0/docs/source/conf.py
x ndx_pose-0.2.0/docs/source/conf_doc_autogen.py
x ndx_pose-0.2.0/docs/source/credits.rst
x ndx_pose-0.2.0/docs/source/description.rst
x ndx_pose-0.2.0/docs/source/format.rst
x ndx_pose-0.2.0/docs/source/index.rst
x ndx_pose-0.2.0/docs/source/release_notes.rst
x ndx_pose-0.2.0/docs/source/_static/theme_overrides.css
x ndx_pose-0.2.0/spec/ndx-pose.extensions.yaml
x ndx_pose-0.2.0/spec/ndx-pose.namespace.yaml
x ndx_pose-0.2.0/src/matnwb/README.md
x ndx_pose-0.2.0/src/pynwb/README.md
x ndx_pose-0.2.0/src/pynwb/ndx_pose/__init__.py
x ndx_pose-0.2.0/src/pynwb/ndx_pose/pose.py
x ndx_pose-0.2.0/src/pynwb/ndx_pose/io/__init__.py
x ndx_pose-0.2.0/src/pynwb/ndx_pose/io/pose.py
x ndx_pose-0.2.0/src/pynwb/ndx_pose/testing/mock/__init__.py
x ndx_pose-0.2.0/src/pynwb/ndx_pose/testing/mock/pose.py
x ndx_pose-0.2.0/src/pynwb/tests/__init__.py
x ndx_pose-0.2.0/src/pynwb/tests/test_example_usage.py
x ndx_pose-0.2.0/src/pynwb/tests/back_compat/generate_data_0.1.1.py
x ndx_pose-0.2.0/src/pynwb/tests/back_compat/test_read.py
x ndx_pose-0.2.0/src/pynwb/tests/integration/hdf5/__init__.py
x ndx_pose-0.2.0/src/pynwb/tests/integration/hdf5/test_pose.py
x ndx_pose-0.2.0/src/pynwb/tests/unit/__init__.py
x ndx_pose-0.2.0/src/pynwb/tests/unit/test_pose.py
x ndx_pose-0.2.0/src/spec/create_extension_spec.py
x ndx_pose-0.2.0/.gitignore
x ndx_pose-0.2.0/LICENSE.txt
x ndx_pose-0.2.0/README.md
x ndx_pose-0.2.0/pyproject.toml
x ndx_pose-0.2.0/PKG-INFO

This PR cleans up pyproject.toml to include those the missing files, remove the global build configuration which is not recommended by hatch, and adds some comments.

Thanks @h-mayorquin

@rly rly merged commit 72b9b0e into main Jul 18, 2024
12 checks passed
@rly rly deleted the sdist branch July 18, 2024 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants