Unleashing Project Configuration and Organization!¶
omni-fig
is a lightweight package to help you organize your python projects to make everything clear and easy to understand to collaborators and prospective users, while also offering unparalleled features to accelerate development.
The general-purpose project structure is well suited for both small and large projects, and is designed to be easily extensible to fit your needs. Most importantly, with the powerful configuration system, you never have to worry about any boilerplate code to parse command line arguments, read config files again, or even import the desired project components ever again!
User Guide¶
There are two main parts of the user guide are the project organization and project configuration. The project organization chiefly concerns the expected file structure for omni-fig
to correctly recognize and load your project, and a variety of different ways you can run your scripts. Keep in mind that most of project structure suggested here is not strictly required, and can easily be adapted to your specific workflow.
The project configuration covers all the powerful features the configuration system of omni-fig
offers.
Citations¶
If you used omni-fig
in your work, please cite it using:
@misc{leeb2022omnifig,
title = {Omni-fig: Unleashing Project Configuration and Organization in Python},
author = {Leeb, Felix},
publisher = {GitHub},
year = {2022}
}