Release on PyPi about aiida-export-migration-tests HOT 8 CLOSED

My main first question is if this package should depend on aiida, as this creates a circular dependency. Probably a dependency on AiiDA is not needed here, and instead AiiDA can optionally depend on this package?

Also, note that if you don't put a MANIFEST file, the non-python files (like .aiida) will not be part of the package (you can test this by doing a pip install rather than pip install -e and then check what is installed

from aiida-export-migration-tests.

My main first question is if this package should depend on aiida, as this creates a circular dependency. Probably a dependency on AiiDA is not needed here, and instead AiiDA can optionally depend on this package?

Agree.

Also, note that if you don't put a MANIFEST file, the non-python files (like .aiida) will not be part of the package (you can test this by doing a pip install rather than pip install -e and then check what is installed

Ah - I will look into this. Thanks.

from aiida-export-migration-tests.

@CasperWA Thanks for creating the repo + the detailed README!

My 2c:

• As for the name, I propose aiida-export-migration-tests, both for the repo and for the pypi project.

• AiiDA 0.6.0.1 was never released on PyPi.

  That's confusing https://pypi.org/project/aiida-core/0.6.0.1/, perhaps better just remove this.

• The links to wf.py etc. don't work for me.
  Instead of using absolute links, I think for files in the same repository it's fine to just use relative links

from aiida-export-migration-tests.

• As for the name, I propose aiida-export-migration-tests, both for the repo and for the pypi project.

Sure. It still brings home the message, I think.

• AiiDA 0.6.0.1 was never released on PyPi.

  That's confusing https://pypi.org/project/aiida-core/0.6.0.1/, perhaps better just remove this.

Ah, right - because you made a "new" 0.6.0 version. Well, the point is that AiiDA wasn't on PyPi historically before 0.8.0 (or something). I'll find out the earliest version on PyPi and update the README with the important keyword historically. I think it's an important reason to list.

• The links to wf.py etc. don't work for me.

This is because it is still a Private repo and you need a token, which I removed from the original URL.

Instead of using absolute links, I think for files in the same repository it's fine to just use relative links

I'll look into it. But I would rather use absolute links so they still work, even if one should change the api in the future.

I'll apply the change suggestions from both @ltalirz and @giovannipizzi and move it from private to public, finally checking that all still works.

from aiida-export-migration-tests.

I would rather use absolute links so they still work, even if one should change the api in the future.

If github changes API (or the repository moves), absolute links can break while relative links should still be fine.

from aiida-export-migration-tests.

If github changes API (or the repository moves), absolute links can break while relative links should still be fine.

Noted. I will use relative links based on this argument.

from aiida-export-migration-tests.

As a note for the future - it is not enough to create a valid MANIFEST.in file. One must also include the include_package_data=True in the setup function in setup.py.

This on stack overflow further explains the difference between what is included and how to include it for binary and source distributions (bdist and sdist).
In short, having both MANIFEST.in and the include_package_data=True key will include all for both kinds of distributions.
Furthermore, .* folders will not be installed, but one will still be able to find them in the source distribution; the created gzipped tarball.

from aiida-export-migration-tests.

This has now been released as aiida-export-migration-tests v0.1.0 on PyPi, link

from aiida-export-migration-tests.