change setup configurations - Githubissues

nmdl-mizo / interface_master

A python package building CSL or approximate CSL interfaces of any two lattices and computing cell of non-identical displacement (CNID).

MIT License

12 stars 4 forks source link

change setup configurations #11

Closed kiyou closed 2 years ago

kiyou commented 2 years ago

Summary

This PR will

simplify setup.py
add setup.cfg and __version__.py
remove requirements.txt

Purpose

Currently, the version of interfacemaster cannot be checked by interfacemaster.__version__ since it is not defined.
Version info is hard to be extracted and reused if it is only written in setuptools.setup(version="X.X.X").
Using requirements.txt for package installation is deprecated.

Change after merging

After merging this PR:

Version information can be obtained by interfacemaster.__version__ and can be used for several purpose (sphinx documentation etc.).
When publishing a new version, a variable VERSION in interfacemaster/__version__.py must be updated.
To update package information (dependencies, authors, etc.), edit setup.cfg rather than setup.py
Some functionality using requirements.txt must be updated.