blob: 0c3c591a6487ffb0b886494bb69e4e020acd14b0 [file] [log] [blame]
Filip Pytlounfaab44c2015-10-06 16:28:32 +02001
Ales Komarek77274ec2017-09-07 09:24:30 +02002==============
OlgaGusarenko0e8d2b62018-07-31 00:55:15 +03003Usage
Ales Komarek77274ec2017-09-07 09:24:30 +02004==============
Filip Pytlounfaab44c2015-10-06 16:28:32 +02005
OlgaGusarenko0e8d2b62018-07-31 00:55:15 +03006Python is a widely used general-purpose, high-level programming language.
7Its design philosophy emphasizes code readability, and its syntax allows
8programmers to express concepts in fewer lines of code than would be
9possible in languages such as C++ or Java. The language provides constructs
10intended to enable clear programs on both a small and large scale.
Filip Pytlounfaab44c2015-10-06 16:28:32 +020011
OlgaGusarenko0e8d2b62018-07-31 00:55:15 +030012Python supports multiple programming paradigms, including object-oriented,
13imperative and functional programming or procedural styles. It features a
14dynamic type system and automatic memory management and has a large and
15comprehensive standard library.
Filip Pytlounfaab44c2015-10-06 16:28:32 +020016
Filip Pytlounfaab44c2015-10-06 16:28:32 +020017Available metadata
18==================
19
OlgaGusarenko0e8d2b62018-07-31 00:55:15 +030020* ``service.environment.environment``
21 Basic Python environment
Filip Pytlounfaab44c2015-10-06 16:28:32 +020022
OlgaGusarenko0e8d2b62018-07-31 00:55:15 +030023* ``service.environment.development``
24 Python development environment
Filip Pytlounfaab44c2015-10-06 16:28:32 +020025
OlgaGusarenko0e8d2b62018-07-31 00:55:15 +030026* ``python.environment.django``
27 Python Django environment
Filip Pytlounfaab44c2015-10-06 16:28:32 +020028
29Sample pillars
30==============
31
OlgaGusarenko0e8d2b62018-07-31 00:55:15 +030032Simple Python environment:
Filip Pytlounfaab44c2015-10-06 16:28:32 +020033
34.. code-block:: yaml
35
36 python:
37 environment:
38 enabled: true
39
OlgaGusarenko0e8d2b62018-07-31 00:55:15 +030040Development Python environment:
Filip Pytlounfaab44c2015-10-06 16:28:32 +020041
42.. code-block:: yaml
43
44 python:
45 environment:
46 enabled: true
47 module:
48 development: true
49
OlgaGusarenko0e8d2b62018-07-31 00:55:15 +030050Python django environment:
Filip Pytlounfaab44c2015-10-06 16:28:32 +020051
52.. code-block:: yaml
53
54 python:
55 environment:
56 enabled: true
57 module:
58 django: true
59
OlgaGusarenko0e8d2b62018-07-31 00:55:15 +030060Using offline mirrors:
Richard Felkla80eb552017-09-15 10:16:17 +020061
62.. code-block:: yaml
63
64 python:
65 environment:
66 enabled: true
67 user:
Richard Felkl73896c22017-10-25 13:21:36 +020068 root:
Richard Felkla80eb552017-09-15 10:16:17 +020069 pypi_user: user
70 pypi_password: password
71 pypi_mirror:
Richard Felkl737a3cb2017-10-26 15:16:31 +020072 protocol: http
73 host: pypi.local
Richard Felkla80eb552017-09-15 10:16:17 +020074 port: 8084
75 upstream_fallback: true
76 user: user
77 password: password
78
Filip Pytlounfaab44c2015-10-06 16:28:32 +020079Read more
80=========
81
82* https://www.python.org/
Filip Pytloun5dd9a162017-02-02 13:02:03 +010083
84Documentation and Bugs
85======================
86
OlgaGusarenko0e8d2b62018-07-31 00:55:15 +030087* http://salt-formulas.readthedocs.io/
88 Learn how to install and update salt-formulas
Filip Pytloun5dd9a162017-02-02 13:02:03 +010089
OlgaGusarenko0e8d2b62018-07-31 00:55:15 +030090* https://github.com/salt-formulas/salt-formula-python/issues
91 In the unfortunate event that bugs are discovered, report the issue to the
92 appropriate issue tracker. Use the Github issue tracker for a specific salt
93 formula
Filip Pytloun5dd9a162017-02-02 13:02:03 +010094
OlgaGusarenko0e8d2b62018-07-31 00:55:15 +030095* https://launchpad.net/salt-formulas
96 For feature requests, bug reports, or blueprints affecting the entire
97 ecosystem, use the Launchpad salt-formulas project
Filip Pytloun5dd9a162017-02-02 13:02:03 +010098
OlgaGusarenko0e8d2b62018-07-31 00:55:15 +030099* https://launchpad.net/~salt-formulas-users
100 Join the salt-formulas-users team and subscribe to mailing list if required
Filip Pytloun5dd9a162017-02-02 13:02:03 +0100101
OlgaGusarenko0e8d2b62018-07-31 00:55:15 +0300102* https://github.com/salt-formulas/salt-formula-python
103 Develop the salt-formulas projects in the master branch and then submit pull
104 requests against a specific formula
Filip Pytloun5dd9a162017-02-02 13:02:03 +0100105
OlgaGusarenko0e8d2b62018-07-31 00:55:15 +0300106* #salt-formulas @ irc.freenode.net
107 Use this IRC channel in case of any questions or feedback which is always
108 welcome
Filip Pytloun5dd9a162017-02-02 13:02:03 +0100109