Packaging

[mscheinert]

Prepare SIMSAR as Python Package (see https://packaging.python.org/tutorials/packaging-projects/)

#16 is some preparation step to this.

Some aspects to take into account for next steps:

• use "simsar" as package name throughout the whole project
• the module/library should be named simsar, too
• should be accessible (within python) like:

  import simsar
  
  simsar.mkREADME()      # Run the major function

  or by running the executable mkReadme simsar-readme (rename?)
• installation via classical distutils
• installation via pip
• optional: available via *conda
• simsar.mkREADME() should accept optional arguments to circumvent interactive user input (should also be supported by the mkReadme simsar-readme executable)

Also interesting for further reading:

• https://www.infoworld.com/article/3267976/12-pythons-for-every-programming-need.html
• https://wiki.python.org/moin/Distutils/DiscussionOverview

[lmicallef]

The script has been packaged and published on test.pypi (this is an environment used for testing purposes). When package is finalised we can move the package to the 'real' environment pypi.org

Currently, this package is available on:
https://test.pypi.org/project/tsimsar/

Install the package:
pip install -i https://test.pypi.org/simple/ tsimsar

Import and call the package:
import tsimsar
tsimsar.make_readme()

(The above code has to be stored in a configuration to be able to create the readme script.)

@mscheinert, this is available for testing, please send me feedback so that I can fix/modify as required.