socon 0.1.1

A high-level Python framework that enables you develop a generic, robust and reliable framework for your different projects.

Socon is a high-level Python framework that helps you develop a generic and robust framework for your different projects. Let us forget about writing hundred of scripts with thousands of configurations, this framework will help your organize your work and will speed your development.

Why Socon ?

I believe we have all ended-up in a situation where we have had multiple projects that need to share the same scripts or components. Some projects may need a specific configuration or a specific function to be executed. Also, we often spend a great amount of time writing a script that is not generic enough to be used by all of our different projects.

Socon has been designed to simplify all that. Socon works with commands. Socon will let you define common commands that can be shared across projects. Each project can either write their own commands, or override common commands to change their behaviors by adding or removing functionalities.

The framework also provide features like managers and hooks. These features will allow you to increase the functionalities of your framework while maintaining genericity accross your different projects.

Documentation

The full documentation is in the “docs” directory on GitHub or online at https://socon.readthedocs.io/en/latest/

If you are just getting started, We recommend that you read the documentation in this order:

• Read docs/intro/install.txt for instructions on how to install Socon.

• Walk through each tutorial in numerical order: docs/intro/tutorials

• Jump to the docs/how-to for specific problems and use-cases.

• Checkout the docs/ref for more details about API’s and functionalities.

Check docs/README for instructions on building an HTML version of the docs.

Contribution

Anyone can contribute to Socon’s development. Checkout our documentation on how to get involved: https://socon.readthedocs.io/en/latest/internals/contributing.html

This is a one man show for now, send help!

License

Copyright Stephane Capponi and others, 2023 Distributed under the terms of the BSD-3-Clause license, socon is free and open source software.

Socon also reused codes from third-paty. You can find the licenses of these third-paty in the licenses folder. Each files that has been reused and modified contains an SPDX section to specify the license used and the Copyright. If you want more information about our licence and why we reused code from third-paty, check the docs/intro/overview.txt