Socon documentation

Everything you need to know about Socon.

First steps

If you are new to Socon, this is the place to start!

• From scratch: Overview | Installation

• Tutorial: Part 1: Create your first command | Part 2: Change command behavior across projects | Part 3: Create your first manager | Part 4: Create your first plugin

How the documentation is organized

Socon’s developer try to put as many documentation as necessary to help you start with your framework. Here is a high-level overview on how it is organized:

• Tutorials: This will walk you through a set of tutorials to create your first container with different projects and commands. You will also learn how to create your own manager and hooks to increase the possibility of your framework. Last but not least, you will learn how to create your own plugin in order to share your work with others.

• How-to guides guide you through the steps involved in addressing key problems and use-cases.

• Reference guides contain technical reference for APIs and other aspects of Socon’s framework.

The development process

Learn about the various components and tools to help you in the development of Socon:

• Settings: Overview | Full settings list

• Registry: Projects and Plugins explained

• Commands: Reference | Adding custom commands

• Manager: Reference | Adding custom managers and hooks

• socon and manage.py: The command line utility

• Utility: General utility | Terminal | Logging

• Exceptions: Overview

The Socon open-source project

Get more information about the Socon project and how you can contribute and make it better.

• Community: Get involved | Socon on GitHub

• Process: The release process | Releases | Deprecations