Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Name things once #50

Merged
merged 1 commit into from
Apr 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
18 changes: 6 additions & 12 deletions .pylint-spelling-words
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@ containerfactory
cp
css
cwd
daemonfactory
daemonfactoryimpl
daemonimpl
darwin
datatypes
datetime
Expand Down Expand Up @@ -101,7 +100,7 @@ png
popen
pragma
prepend
processfactory
proc
processresult
proxied
psutil
Expand All @@ -119,19 +118,14 @@ ret
returncode
rst
rtype
saltapifactory
saltcloudfactory
saltapi
saltcloud
saltenv
saltfactories
saltfactory
saltmaster
saltmasterfactory
saltminion
saltminionfactory
saltproxyminion
saltproxyminionfactory
saltsyndic
saltsyndicfactory
shellresult
sigterm
sitecustomise
Expand All @@ -149,14 +143,14 @@ stdout
str
subprocess
subprocesses
subprocessfactorybase
subprocessfactoryimpl
subprocessimpl
sunos
syndic
sys
sysinfo
sysstats
systemd
systemdsaltdaemonimpl
tempfile
tempfiles
testname
Expand Down
1 change: 1 addition & 0 deletions changelog/50.breaking.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
`Name things once <https://www.youtube.com/watch?v=1__lNTlj1_w>`_.
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
.. automodule:: saltfactories.factories.base
Base Classes
============

.. automodule:: saltfactories.bases
:members:
:show-inheritance:
:inherited-members:
Expand Down
9 changes: 9 additions & 0 deletions docs/ref/saltfactories/cli/call.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
=============
``salt-call``
=============

.. automodule:: saltfactories.cli.call
:members:
:show-inheritance:
:inherited-members:
:no-undoc-members:
9 changes: 9 additions & 0 deletions docs/ref/saltfactories/cli/cloud.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
==============
``salt-cloud``
==============

.. automodule:: saltfactories.cli.cloud
:members:
:show-inheritance:
:inherited-members:
:no-undoc-members:
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. automodule:: saltfactories.factories.cli.cp
===========
``salt-cp``
===========

.. automodule:: saltfactories.cli.cp
:members:
:show-inheritance:
:inherited-members:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. automodule:: saltfactories.factories.cli.key
============
``salt-key``
============

.. automodule:: saltfactories.cli.key
:members:
:show-inheritance:
:inherited-members:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. automodule:: saltfactories.factories.cli.run
============
``salt-run``
============

.. automodule:: saltfactories.cli.run
:members:
:show-inheritance:
:inherited-members:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. automodule:: saltfactories.factories.cli.salt
========
``salt``
========

.. automodule:: saltfactories.cli.salt
:members:
:show-inheritance:
:inherited-members:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. automodule:: saltfactories.factories.cli.spm
=======
``spm``
=======

.. automodule:: saltfactories.cli.spm
:members:
:show-inheritance:
:inherited-members:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. automodule:: saltfactories.factories.cli.ssh
============
``salt-ssh``
============

.. automodule:: saltfactories.cli.ssh
:members:
:show-inheritance:
:inherited-members:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. automodule:: saltfactories.factories.cli.client
============
Local Client
============

.. automodule:: saltfactories.client
:members:
:show-inheritance:
:inherited-members:
Expand Down
8 changes: 8 additions & 0 deletions docs/ref/saltfactories/daemons/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
============
``salt-api``
============
.. automodule:: saltfactories.daemons.api
:members:
:show-inheritance:
:inherited-members:
:no-undoc-members:
9 changes: 9 additions & 0 deletions docs/ref/saltfactories/daemons/container.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
==========
Containers
==========

.. automodule:: saltfactories.daemons.container
:members:
:show-inheritance:
:inherited-members:
:no-undoc-members:
9 changes: 9 additions & 0 deletions docs/ref/saltfactories/daemons/master.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
===============
``salt-master``
===============

.. automodule:: saltfactories.daemons.master
:members:
:show-inheritance:
:inherited-members:
:no-undoc-members:
9 changes: 9 additions & 0 deletions docs/ref/saltfactories/daemons/minion.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
===============
``salt-minion``
===============

.. automodule:: saltfactories.daemons.minion
:members:
:show-inheritance:
:inherited-members:
:no-undoc-members:
9 changes: 9 additions & 0 deletions docs/ref/saltfactories/daemons/proxy.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
==============
``salt-proxy``
==============

.. automodule:: saltfactories.daemons.proxy
:members:
:show-inheritance:
:inherited-members:
:no-undoc-members:
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
.. automodule:: saltfactories.factories.daemons.sshd
========
``sshd``
========
.. automodule:: saltfactories.daemons.sshd
:members:
:show-inheritance:
:inherited-members:
Expand Down
5 changes: 0 additions & 5 deletions docs/ref/saltfactories/factories/cli/call.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/ref/saltfactories/factories/cli/cloud.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/ref/saltfactories/factories/daemons/api.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/ref/saltfactories/factories/daemons/container.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/ref/saltfactories/factories/daemons/master.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/ref/saltfactories/factories/daemons/minion.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/ref/saltfactories/factories/daemons/proxy.rst

This file was deleted.

39 changes: 0 additions & 39 deletions docs/ref/saltfactories/factories/index.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/ref/saltfactories/factories/manager.rst

This file was deleted.

37 changes: 36 additions & 1 deletion docs/ref/saltfactories/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
9 changes: 9 additions & 0 deletions docs/ref/saltfactories/manager.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
======================
Salt Factories Manager
======================

.. automodule:: saltfactories.manager
:members:
:show-inheritance:
:inherited-members:
:no-undoc-members:
4 changes: 2 additions & 2 deletions examples/echo-extension/tests/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ def salt_factories_config():

@pytest.fixture(scope="package")
def master(salt_factories):
return salt_factories.get_salt_master_daemon(random_string("master-"))
return salt_factories.salt_master_daemon(random_string("master-"))


@pytest.fixture(scope="package")
def minion(master):
return master.get_salt_minion_daemon(random_string("minion-"))
return master.salt_minion_daemon(random_string("minion-"))
4 changes: 2 additions & 2 deletions examples/echo-extension/tests/integration/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ def minion(minion):

@pytest.fixture
def salt_run_cli(master):
return master.get_salt_run_cli()
return master.salt_run_cli()


@pytest.fixture
Expand All @@ -25,4 +25,4 @@ def salt_cli(master):

@pytest.fixture
def salt_call_cli(minion):
return minion.get_salt_call_cli()
return minion.salt_call_cli()