Filip Pytloun | faab44c | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 1 | |
Ales Komarek | 77274ec | 2017-09-07 09:24:30 +0200 | [diff] [blame] | 2 | ============== |
OlgaGusarenko | 0e8d2b6 | 2018-07-31 00:55:15 +0300 | [diff] [blame] | 3 | Usage |
Ales Komarek | 77274ec | 2017-09-07 09:24:30 +0200 | [diff] [blame] | 4 | ============== |
Filip Pytloun | faab44c | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 5 | |
OlgaGusarenko | 0e8d2b6 | 2018-07-31 00:55:15 +0300 | [diff] [blame] | 6 | Python is a widely used general-purpose, high-level programming language. |
| 7 | Its design philosophy emphasizes code readability, and its syntax allows |
| 8 | programmers to express concepts in fewer lines of code than would be |
| 9 | possible in languages such as C++ or Java. The language provides constructs |
| 10 | intended to enable clear programs on both a small and large scale. |
Filip Pytloun | faab44c | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 11 | |
OlgaGusarenko | 0e8d2b6 | 2018-07-31 00:55:15 +0300 | [diff] [blame] | 12 | Python supports multiple programming paradigms, including object-oriented, |
| 13 | imperative and functional programming or procedural styles. It features a |
| 14 | dynamic type system and automatic memory management and has a large and |
| 15 | comprehensive standard library. |
Filip Pytloun | faab44c | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 16 | |
Filip Pytloun | faab44c | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 17 | Available metadata |
| 18 | ================== |
| 19 | |
OlgaGusarenko | 0e8d2b6 | 2018-07-31 00:55:15 +0300 | [diff] [blame] | 20 | * ``service.environment.environment`` |
| 21 | Basic Python environment |
Filip Pytloun | faab44c | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 22 | |
OlgaGusarenko | 0e8d2b6 | 2018-07-31 00:55:15 +0300 | [diff] [blame] | 23 | * ``service.environment.development`` |
| 24 | Python development environment |
Filip Pytloun | faab44c | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 25 | |
OlgaGusarenko | 0e8d2b6 | 2018-07-31 00:55:15 +0300 | [diff] [blame] | 26 | * ``python.environment.django`` |
| 27 | Python Django environment |
Filip Pytloun | faab44c | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 28 | |
| 29 | Sample pillars |
| 30 | ============== |
| 31 | |
OlgaGusarenko | 0e8d2b6 | 2018-07-31 00:55:15 +0300 | [diff] [blame] | 32 | Simple Python environment: |
Filip Pytloun | faab44c | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 33 | |
| 34 | .. code-block:: yaml |
| 35 | |
| 36 | python: |
| 37 | environment: |
| 38 | enabled: true |
| 39 | |
OlgaGusarenko | 0e8d2b6 | 2018-07-31 00:55:15 +0300 | [diff] [blame] | 40 | Development Python environment: |
Filip Pytloun | faab44c | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 41 | |
| 42 | .. code-block:: yaml |
| 43 | |
| 44 | python: |
| 45 | environment: |
| 46 | enabled: true |
| 47 | module: |
| 48 | development: true |
| 49 | |
OlgaGusarenko | 0e8d2b6 | 2018-07-31 00:55:15 +0300 | [diff] [blame] | 50 | Python django environment: |
Filip Pytloun | faab44c | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 51 | |
| 52 | .. code-block:: yaml |
| 53 | |
| 54 | python: |
| 55 | environment: |
| 56 | enabled: true |
| 57 | module: |
| 58 | django: true |
| 59 | |
OlgaGusarenko | 0e8d2b6 | 2018-07-31 00:55:15 +0300 | [diff] [blame] | 60 | Using offline mirrors: |
Richard Felkl | a80eb55 | 2017-09-15 10:16:17 +0200 | [diff] [blame] | 61 | |
| 62 | .. code-block:: yaml |
| 63 | |
| 64 | python: |
| 65 | environment: |
| 66 | enabled: true |
| 67 | user: |
Richard Felkl | 73896c2 | 2017-10-25 13:21:36 +0200 | [diff] [blame] | 68 | root: |
Richard Felkl | a80eb55 | 2017-09-15 10:16:17 +0200 | [diff] [blame] | 69 | pypi_user: user |
| 70 | pypi_password: password |
| 71 | pypi_mirror: |
Richard Felkl | 737a3cb | 2017-10-26 15:16:31 +0200 | [diff] [blame] | 72 | protocol: http |
| 73 | host: pypi.local |
Richard Felkl | a80eb55 | 2017-09-15 10:16:17 +0200 | [diff] [blame] | 74 | port: 8084 |
| 75 | upstream_fallback: true |
| 76 | user: user |
| 77 | password: password |
| 78 | |
Filip Pytloun | faab44c | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 79 | Read more |
| 80 | ========= |
| 81 | |
| 82 | * https://www.python.org/ |
Filip Pytloun | 5dd9a16 | 2017-02-02 13:02:03 +0100 | [diff] [blame] | 83 | |
| 84 | Documentation and Bugs |
| 85 | ====================== |
| 86 | |
OlgaGusarenko | 0e8d2b6 | 2018-07-31 00:55:15 +0300 | [diff] [blame] | 87 | * http://salt-formulas.readthedocs.io/ |
| 88 | Learn how to install and update salt-formulas |
Filip Pytloun | 5dd9a16 | 2017-02-02 13:02:03 +0100 | [diff] [blame] | 89 | |
OlgaGusarenko | 0e8d2b6 | 2018-07-31 00:55:15 +0300 | [diff] [blame] | 90 | * 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 Pytloun | 5dd9a16 | 2017-02-02 13:02:03 +0100 | [diff] [blame] | 94 | |
OlgaGusarenko | 0e8d2b6 | 2018-07-31 00:55:15 +0300 | [diff] [blame] | 95 | * 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 Pytloun | 5dd9a16 | 2017-02-02 13:02:03 +0100 | [diff] [blame] | 98 | |
OlgaGusarenko | 0e8d2b6 | 2018-07-31 00:55:15 +0300 | [diff] [blame] | 99 | * https://launchpad.net/~salt-formulas-users |
| 100 | Join the salt-formulas-users team and subscribe to mailing list if required |
Filip Pytloun | 5dd9a16 | 2017-02-02 13:02:03 +0100 | [diff] [blame] | 101 | |
OlgaGusarenko | 0e8d2b6 | 2018-07-31 00:55:15 +0300 | [diff] [blame] | 102 | * 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 Pytloun | 5dd9a16 | 2017-02-02 13:02:03 +0100 | [diff] [blame] | 105 | |
OlgaGusarenko | 0e8d2b6 | 2018-07-31 00:55:15 +0300 | [diff] [blame] | 106 | * #salt-formulas @ irc.freenode.net |
| 107 | Use this IRC channel in case of any questions or feedback which is always |
| 108 | welcome |
Filip Pytloun | 5dd9a16 | 2017-02-02 13:02:03 +0100 | [diff] [blame] | 109 | |