Metadata-Version: 2.1
Name: setux
Version: 0.21.41.0
Summary: System deployment
Home-page: https://framagit.org/louis-riviere-xyz/setux
Author: Louis RIVIERE
Author-email: louis@riviere.xyz
License: MIT
Keywords: utility
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: POSIX :: Linux
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: System :: Installation/Setup
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Requires-Python: >3.6
License-File: LICENSE

########
 setux
########

**Setup Tux**

Install, Deploy, Admin

========
Abstract
========

This is a meta package including all the packages needed for setux to be functionnal.

-------------------------------------------------------------
setux `core <https://pypi.org/project/setux_core>`_
-------------------------------------------------------------

Abstract base classes for all other packages.

-------------------------------------------------------------
setux `distros <https://pypi.org/project/setux_distros>`_
-------------------------------------------------------------

core.distro.Distro implementations

Supported OSs (Debian, FreeBSD)

-------------------------------------------------------------
setux `targets <https://pypi.org/project/setux_targets>`_
-------------------------------------------------------------

core.target.Target implementations

Connection to the target machine (Local, SSH)
 
-------------------------------------------------------------
setux `managers <https://pypi.org/project/setux_managers>`_
-------------------------------------------------------------

core.manage.Manager implementations

Resources managers (Packages, Services)
 
-------------------------------------------------------------
setux `mappings <https://pypi.org/project/setux_mappings>`_
-------------------------------------------------------------

core.mapping.Mapping implementations

Mapping resources names (Packages, Service)
 
-------------------------------------------------------------
setux `modules <https://pypi.org/project/setux_modules>`_
-------------------------------------------------------------

core.module.Module implementations

User defined functionality 
 
-------------------------------------------------------------
setux `logger <https://pypi.org/project/setux_logger>`_
-------------------------------------------------------------

Logging 
 
===================
Additional packages
===================
 
-------------------------------------------------------------
setux `REPL <https://pypi.org/project/setux-repl>`_
-------------------------------------------------------------

Rudimentary Setux REPL / CLI

Note that setux is mainly intended to be used as a Python framework.
 
-------------------------------------------------------------
setux `PLUS <https://pypi.org/project/setux-plus>`_
-------------------------------------------------------------

Augmented Setux distribution

Additional implementations of core's abstract classes.


=====
Usage
=====

Python:

.. code-block:: python

   import setux

REPL:

.. code-block:: shell

    $ setux

CLI:

.. code-block:: shell

    $ setux command target

============
Installation
============

.. code-block:: shell

    $ pip install setux

Note : Additional Setux packages install Setux as a dependency.


