search

qiskit-community / qiskit-metal

Quantum Hardware Design. Open-source project for engineers and scientists to design superconducting quantum devices with ease.
https://qiskit-community.github.io/qiskit-metal/
Apache License 2.0
270 stars 201 forks source link

Add MANIFEST.in #895

Closed wshanks closed 1 year ago

wshanks commented 1 year ago

What are the issues this pull addresses (issue numbers / links)?

894

Did you add tests to cover your changes (yes/no)?

No code was changed

Did you update the documentation accordingly (yes/no)?

N/A

Did you read the CONTRIBUTING document (yes/no)?

Yes

Summary

This adds a MANIFEST.in file so that some top-level text files make it into the source distribution.

Details and comments

requirements.txt and README.md are needed in order to install the package from the source distribution because they are accessed by setup.py. LICENSE.txt is also included because it is best practice to include the license when distributing source code.

Closes #894

wshanks commented 1 year ago

It might be good to update the release.yml. Invoking python setup.py is deprecated (python -m build is more favored now). I see other qiskit projects still do it as well though.