|
1 |
| -# steenzout.primogen |
| 1 | +# ansiblebit.lib |
2 | 2 |
|
3 |
| -[](https://travis-ci.org/steenzout/python-primogen) |
4 |
| -[](https://landscape.io/github/steenzout/python-primogen/master) |
5 |
| -[](https://coveralls.io/r/steenzout/python-primogen) |
6 |
| -[](https://requires.io/github/steenzout/python-primogen/requirements/?branch=master) |
| 3 | +[](https://travis-ci.org/ansiblebit/python-lib) |
| 4 | +[](https://landscape.io/github/ansiblebit/python-lib/master) |
| 5 | +[](https://coveralls.io/r/ansiblebit/python-lib) |
| 6 | +[](https://requires.io/github/ansiblebit/python-lib/requirements/?branch=master) |
7 | 7 |
|
8 |
| -This repository's goal is to be a starting point for Python projects. |
9 |
| - |
10 |
| -It uses: |
11 |
| - |
12 |
| -- [git](http://git-scm.com) for version control |
13 |
| -- [pip](http://www.pip-installer.org/en/latest/) to manage Python packages |
14 |
| -- [tox](http://tox.readthedocs.org/en/latest/) for automation and setup development environments |
15 |
| -- [Sphinx](http://sphinx-doc.org) for documentation |
16 |
| - |
17 |
| - |
18 |
| -company |
19 |
| -------- |
20 |
| - |
21 |
| -This is the directory which will hold your files. |
22 |
| - |
23 |
| -Rename "company" with your company's name or product. |
24 |
| - |
25 |
| -In this empty project the company package is a namespace package, |
26 |
| -meaning it was defined in another repository. |
27 |
| - |
28 |
| -You may not need to do this but it's here to make an example of how to define namespace packages, |
29 |
| -what to add on the __init__.py file and in the setup.py file. |
30 |
| - |
31 |
| - |
32 |
| -docs |
33 |
| ----- |
34 |
| - |
35 |
| -Directory where you'll store the [Sphinx](http://sphinx-doc.org) configuration files and |
36 |
| -where the documentation will be generated. |
37 |
| - |
38 |
| - |
39 |
| -.gitignore |
40 |
| ----------- |
41 |
| - |
42 |
| -File where you specify which files [Git](http://en.wikipedia.org/wiki/Git_(software)) should ignore. |
43 |
| - |
44 |
| -A generic file has been provided. |
45 |
| - |
46 |
| -You can use [gitignore.io](http://www.gitignore.io) to |
47 |
| -produce other files that will better suit your development environment. |
48 |
| - |
49 |
| -For more information, you can check "[git-scm.com : gitignore](http://git-scm.com/docs/gitignore)". |
50 |
| - |
51 |
| - |
52 |
| -LICENSE |
53 |
| -------- |
54 |
| - |
55 |
| -The Apache 2 license. |
56 |
| - |
57 |
| -Feel free to replace for another license that will be more suitable to the purpose of your project. |
58 |
| - |
59 |
| - |
60 |
| -pytest.ini |
61 |
| ----------- |
62 |
| - |
63 |
| -The [pytest](https://pytest.org/latest/index.html) configuration file. |
64 |
| - |
65 |
| -You can read |
66 |
| -"[pytest : Changing standard (Python) test discovery](https://pytest.org/latest/example/pythoncollection.html)" |
67 |
| -for more information on how to use this file to customize [pytest](https://pytest.org/latest/index.html)'s behavior. |
68 |
| - |
69 |
| - |
70 |
| -README.md |
71 |
| ---------- |
72 |
| - |
73 |
| -This file. |
74 |
| - |
75 |
| -Check "[here](http://daringfireball.net/projects/markdown/syntax)" for help |
76 |
| -with [Markdown](http://daringfireball.net/projects/markdown/) syntax. |
77 |
| - |
78 |
| - |
79 |
| -requirements.txt |
80 |
| ----------------- |
81 |
| - |
82 |
| -On this file you specify the list of packages the project depends. |
83 |
| - |
84 |
| -Read "[pip : Requirement Files](http://www.pip-installer.org/en/latest/user_guide.html#requirements-files)" |
85 |
| -to understand how you can properly use this file to define your project's dependencies. |
86 |
| - |
87 |
| - |
88 |
| -setup.py |
89 |
| --------- |
90 |
| - |
91 |
| -The setup script whre you'll describe the project / product, authors, maintainers and |
92 |
| -information on how to distribute it. |
93 |
| - |
94 |
| -Read "[Python : 2. Writing the Setup Script](http://docs.python.org/2/distutils/setupscript.html)", |
95 |
| -for more information. |
96 |
| - |
97 |
| - |
98 |
| -tests |
99 |
| ------ |
100 |
| - |
101 |
| -The directory where you should add your unit tests. |
102 |
| - |
103 |
| - |
104 |
| -test-requirements.txt |
105 |
| ---------------------- |
106 |
| - |
107 |
| -On this file you specify the list of packages the project needs to run its tests. |
108 |
| - |
109 |
| -An example of the possible contents of this file has been provided. |
110 |
| - |
111 |
| -Read "[pip : Requirement Files](http://www.pip-installer.org/en/latest/user_guide.html#requirements-files)" |
112 |
| -to understand how you can properly use this file to define your project's test dependencies. |
113 |
| - |
114 |
| - |
115 |
| -tox.ini |
116 |
| -------- |
117 |
| - |
118 |
| -The [tox](http://tox.readthedocs.org/en/latest/) configuration file. |
119 |
| - |
120 |
| -It contains basic information about your project and test environments. |
121 |
| - |
122 |
| -I recommend [installling tox](http://tox.readthedocs.org/en/latest/install.html) and |
123 |
| -use it to run your tests and generate the documentation. |
124 |
| - |
125 |
| -``` |
126 |
| -# run the tests |
127 |
| -$ tox |
128 |
| -
|
129 |
| -# generate the documentation |
130 |
| -$ tox -e docs |
131 |
| -``` |
| 8 | +Python library to support Ansible roles. |
0 commit comments