Name things once

https://www.youtube.com/watch?v=1__lNTlj1_w
saltstack · Apr 14, 2021 · a2cc433 · a2cc433
1 parent 699c1b3
commit a2cc433
Show file tree

Hide file tree

Showing 66 changed files with 492 additions and 459 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -43,7 +43,7 @@ repos:
       - id: unimport
         name: Remove unused imports
         args: [--remove]
-        exclude: ^(docs/.*\.py|src/saltfactories/factories/(cli|daemons)/__init__\.py)$
+        exclude: ^(docs/.*\.py|src/saltfactories/(cli|daemons)/__init__\.py)$
 
   - repo: https://github.com/asottile/reorder_python_imports
     rev: v2.4.0

diff --git a/.pylint-spelling-words b/.pylint-spelling-words
@@ -31,8 +31,7 @@ containerfactory
 cp
 css
 cwd
-daemonfactory
-daemonfactoryimpl
+daemonimpl
 darwin
 datatypes
 datetime
@@ -101,7 +100,6 @@ png
 popen
 pragma
 prepend
-processfactory
 processresult
 proxied
 psutil
@@ -119,19 +117,14 @@ ret
 returncode
 rst
 rtype
-saltapifactory
-saltcloudfactory
+saltapi
+saltcloud
 saltenv
 saltfactories
-saltfactory
 saltmaster
-saltmasterfactory
 saltminion
-saltminionfactory
 saltproxyminion
-saltproxyminionfactory
 saltsyndic
-saltsyndicfactory
 shellresult
 sigterm
 sitecustomise
@@ -149,8 +142,7 @@ stdout
 str
 subprocess
 subprocesses
-subprocessfactorybase
-subprocessfactoryimpl
+subprocessimpl
 sunos
 syndic
 sys

diff --git a/changelog/50.improvement.rst b/changelog/50.improvement.rst
@@ -0,0 +1 @@
+* `Name things once <https://www.youtube.com/watch?v=1__lNTlj1_w>`_.
diff --git a/docs/ref/saltfactories/factories/base.rst → docs/ref/saltfactories/bases.rst b/docs/ref/saltfactories/factories/base.rst → docs/ref/saltfactories/bases.rst
@@ -1,4 +1,7 @@
-.. automodule:: saltfactories.factories.base
+Base Classes
+============
+
+.. automodule:: saltfactories.bases
    :members:
    :show-inheritance:
    :inherited-members:

diff --git a/docs/ref/saltfactories/cli/call.rst b/docs/ref/saltfactories/cli/call.rst
@@ -0,0 +1,9 @@
+=============
+``salt-call``
+=============
+
+.. automodule:: saltfactories.cli.call
+   :members:
+   :show-inheritance:
+   :inherited-members:
+   :no-undoc-members:
diff --git a/docs/ref/saltfactories/cli/cloud.rst b/docs/ref/saltfactories/cli/cloud.rst
@@ -0,0 +1,9 @@
+==============
+``salt-cloud``
+==============
+
+.. automodule:: saltfactories.cli.cloud
+   :members:
+   :show-inheritance:
+   :inherited-members:
+   :no-undoc-members:
diff --git a/docs/ref/saltfactories/factories/cli/cp.rst → docs/ref/saltfactories/cli/cp.rst b/docs/ref/saltfactories/factories/cli/cp.rst → docs/ref/saltfactories/cli/cp.rst
@@ -1,4 +1,8 @@
-.. automodule:: saltfactories.factories.cli.cp
+===========
+``salt-cp``
+===========
+
+.. automodule:: saltfactories.cli.cp
    :members:
    :show-inheritance:
    :inherited-members:

diff --git a/docs/ref/saltfactories/factories/cli/key.rst → docs/ref/saltfactories/cli/key.rst b/docs/ref/saltfactories/factories/cli/key.rst → docs/ref/saltfactories/cli/key.rst
@@ -1,4 +1,8 @@
-.. automodule:: saltfactories.factories.cli.key
+============
+``salt-key``
+============
+
+.. automodule:: saltfactories.cli.key
    :members:
    :show-inheritance:
    :inherited-members:

diff --git a/docs/ref/saltfactories/factories/cli/run.rst → docs/ref/saltfactories/cli/run.rst b/docs/ref/saltfactories/factories/cli/run.rst → docs/ref/saltfactories/cli/run.rst
@@ -1,4 +1,8 @@
-.. automodule:: saltfactories.factories.cli.run
+============
+``salt-run``
+============
+
+.. automodule:: saltfactories.cli.run
    :members:
    :show-inheritance:
    :inherited-members:

diff --git a/.../ref/saltfactories/factories/cli/salt.rst → docs/ref/saltfactories/cli/salt.rst b/.../ref/saltfactories/factories/cli/salt.rst → docs/ref/saltfactories/cli/salt.rst
@@ -1,4 +1,8 @@
-.. automodule:: saltfactories.factories.cli.salt
+========
+``salt``
+========
+
+.. automodule:: saltfactories.cli.salt
    :members:
    :show-inheritance:
    :inherited-members:

diff --git a/docs/ref/saltfactories/factories/cli/spm.rst → docs/ref/saltfactories/cli/spm.rst b/docs/ref/saltfactories/factories/cli/spm.rst → docs/ref/saltfactories/cli/spm.rst
@@ -1,4 +1,8 @@
-.. automodule:: saltfactories.factories.cli.spm
+=======
+``spm``
+=======
+
+.. automodule:: saltfactories.cli.spm
    :members:
    :show-inheritance:
    :inherited-members:

diff --git a/docs/ref/saltfactories/factories/cli/ssh.rst → docs/ref/saltfactories/cli/ssh.rst b/docs/ref/saltfactories/factories/cli/ssh.rst → docs/ref/saltfactories/cli/ssh.rst
@@ -1,4 +1,8 @@
-.. automodule:: saltfactories.factories.cli.ssh
+============
+``salt-ssh``
+============
+
+.. automodule:: saltfactories.cli.ssh
    :members:
    :show-inheritance:
    :inherited-members:

diff --git a/...ef/saltfactories/factories/cli/client.rst → docs/ref/saltfactories/client.rst b/...ef/saltfactories/factories/cli/client.rst → docs/ref/saltfactories/client.rst
@@ -1,4 +1,8 @@
-.. automodule:: saltfactories.factories.cli.client
+============
+Local Client
+============
+
+.. automodule:: saltfactories.client
    :members:
    :show-inheritance:
    :inherited-members:

diff --git a/docs/ref/saltfactories/daemons/api.rst b/docs/ref/saltfactories/daemons/api.rst
@@ -0,0 +1,8 @@
+============
+``salt-api``
+============
+.. automodule:: saltfactories.daemons.api
+   :members:
+   :show-inheritance:
+   :inherited-members:
+   :no-undoc-members:
diff --git a/docs/ref/saltfactories/daemons/container.rst b/docs/ref/saltfactories/daemons/container.rst
@@ -0,0 +1,9 @@
+==========
+Containers
+==========
+
+.. automodule:: saltfactories.daemons.container
+   :members:
+   :show-inheritance:
+   :inherited-members:
+   :no-undoc-members:
diff --git a/docs/ref/saltfactories/daemons/master.rst b/docs/ref/saltfactories/daemons/master.rst
@@ -0,0 +1,9 @@
+===============
+``salt-master``
+===============
+
+.. automodule:: saltfactories.daemons.master
+   :members:
+   :show-inheritance:
+   :inherited-members:
+   :no-undoc-members:
diff --git a/docs/ref/saltfactories/daemons/minion.rst b/docs/ref/saltfactories/daemons/minion.rst
@@ -0,0 +1,9 @@
+===============
+``salt-minion``
+===============
+
+.. automodule:: saltfactories.daemons.minion
+   :members:
+   :show-inheritance:
+   :inherited-members:
+   :no-undoc-members:
diff --git a/docs/ref/saltfactories/daemons/proxy.rst b/docs/ref/saltfactories/daemons/proxy.rst
@@ -0,0 +1,9 @@
+==============
+``salt-proxy``
+==============
+
+.. automodule:: saltfactories.daemons.proxy
+   :members:
+   :show-inheritance:
+   :inherited-members:
+   :no-undoc-members:
diff --git a/.../saltfactories/factories/daemons/sshd.rst → docs/ref/saltfactories/daemons/sshd.rst b/.../saltfactories/factories/daemons/sshd.rst → docs/ref/saltfactories/daemons/sshd.rst
@@ -1,4 +1,7 @@
-.. automodule:: saltfactories.factories.daemons.sshd
+========
+``sshd``
+========
+.. automodule:: saltfactories.daemons.sshd
    :members:
    :show-inheritance:
    :inherited-members:

diff --git a/docs/ref/saltfactories/factories/cli/call.rst b/docs/ref/saltfactories/factories/cli/call.rst
diff --git a/docs/ref/saltfactories/factories/cli/cloud.rst b/docs/ref/saltfactories/factories/cli/cloud.rst
diff --git a/docs/ref/saltfactories/factories/daemons/api.rst b/docs/ref/saltfactories/factories/daemons/api.rst
diff --git a/docs/ref/saltfactories/factories/daemons/container.rst b/docs/ref/saltfactories/factories/daemons/container.rst
diff --git a/docs/ref/saltfactories/factories/daemons/master.rst b/docs/ref/saltfactories/factories/daemons/master.rst
diff --git a/docs/ref/saltfactories/factories/daemons/minion.rst b/docs/ref/saltfactories/factories/daemons/minion.rst
diff --git a/docs/ref/saltfactories/factories/daemons/proxy.rst b/docs/ref/saltfactories/factories/daemons/proxy.rst
diff --git a/docs/ref/saltfactories/factories/index.rst b/docs/ref/saltfactories/factories/index.rst
diff --git a/docs/ref/saltfactories/factories/manager.rst b/docs/ref/saltfactories/factories/manager.rst
diff --git a/docs/ref/saltfactories/index.rst b/docs/ref/saltfactories/index.rst
@@ -7,6 +7,41 @@ Salt Factories Package
 
    cli
    plugins/index
-   factories/index
    utils/index
    exceptions
+
+Factories
+=========
+
+.. toctree::
+
+   bases
+   manager
+
+Daemons
+-------
+
+.. toctree::
+
+   daemons/master
+   daemons/minion
+   daemons/proxy
+   daemons/api
+   daemons/sshd
+   daemons/container
+
+
+CLI
+---
+
+.. toctree::
+
+   cli/key
+   cli/salt
+   cli/call
+   cli/run
+   cli/cp
+   cli/cloud
+   cli/spm
+   cli/ssh
+   client
diff --git a/docs/ref/saltfactories/manager.rst b/docs/ref/saltfactories/manager.rst
@@ -0,0 +1,9 @@
+======================
+Salt Factories Manager
+======================
+
+.. automodule:: saltfactories.manager
+   :members:
+   :show-inheritance:
+   :inherited-members:
+   :no-undoc-members:
diff --git a/setup.cfg b/setup.cfg
@@ -57,9 +57,9 @@ extras_require =
 
 [options.entry_points]
 console_scripts =
-  salt-factories = saltfactories.cli:main
+  salt-factories = saltfactories.__main__:main
 pytest11=
-  salt-factories = saltfactories.plugin
+  salt-factories = saltfactories.plugins
   salt-factories-factories = saltfactories.plugins.factories
   salt-factories-markers = saltfactories.plugins.markers
   salt-factories-sysinfo = saltfactories.plugins.sysinfo

diff --git a/src/saltfactories/cli.py → src/saltfactories/__main__.py b/src/saltfactories/cli.py → src/saltfactories/__main__.py