et-micc 0.9.44

A practical Python project skeleton generator.

Micc is a Python project manager: it helps you organize your Python project from simple single file modules to fully fledged Python packages containing modules, sub-modules, apps and binary extension modules written in Fortran or C++. Micc organizes your project in a way that is considered good practice by a large part of the Python community.

• Micc helps you create new projects. You can start small with a simple one-file package and add material as you go, such as:

  • Python sub-modules and sub-packages,

  • applications, also known as command line interfaces (CLIs).

  • binary extension modules written in C++ and Fortran. Boiler plate code is automatically added as to build these binary extension with having to go through al the details. This is, in fact, the foremost reason that got me started on this project: For High Performance Python it is essential to rewrite slow and time consuming parts of a Python script or module in a language that is made for High Performance Computing. As figuring out how that can be done, requires quite some effort, Micc was made to automate this part while maintaining the flexibility.

  • Micc adds typically files containing example code to show you how to add your own functionality.

• Micc can automatically extract documentation from the doc-strings of your files, and build html documentation that you can consult in your browser, or a .pdf documentation file.

• With a little extra effort the generated html documentation is automatically published to readthedocs.

• Micc helps you with version management and control.

• Micc helps you with testing your code.

• Micc helps you with publishing your code to e.g. PyPI, so that you colleagues can use your code by simply running pip install your_nifty_package.

For details see the Micc documentation.

Micc does not do all of this by itself. For many things it relies on other strong open source tools and it is therefor open source as well (MIT Licence). Here is a list of tools micc is using or cooperating with happily:

• poetry: dependency management, virtual environments.

• pyenv: management of different Python versions

• pipx: installation of CLIs in a system-wide way.

• cookiecutter for creating templates for all the things that can be added to your project.

• sphinx: building of documentation.

• git: version control.

• python-semanticversion: management of version string according to version specification Semver 2.0.

• pytest: testing your code.

• click: a pythonic and intuitive way of developing CLIs.

• F2py, which is part of Numpy, the standard for numerical computing in Python. F2py easily transforms modern Fortran code into performant binary extension modules.

• CMake and pybind11 as the glue between C++ code and performant binary extension modules.

Roadmap

These features are still on our wishlist:

• Contininous integtration (CI)