File: README.rst

package info (click to toggle)
doit 0.31.1-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 1,504 kB
  • sloc: python: 10,835; makefile: 168; ansic: 14; sh: 4
file content (218 lines) | stat: -rw-r--r-- 5,084 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
================
README
================

.. display some badges

.. image:: https://img.shields.io/pypi/v/doit.svg
        :target: https://pypi.python.org/pypi/doit

.. image:: https://travis-ci.org/pydoit/doit.png?branch=master
    :target: https://travis-ci.org/pydoit/doit

.. image:: https://ci.appveyor.com/api/projects/status/f7f97iywo8y7fe4d/branch/master?svg=true
    :target: https://ci.appveyor.com/project/schettino72/doit/branch/master

.. image:: https://coveralls.io/repos/pydoit/doit/badge.png?branch=master
  :target: https://coveralls.io/r/pydoit/doit?branch=master


.. image:: https://badges.gitter.im/Join%20Chat.svg
  :alt: Join the chat at https://gitter.im/pydoit/doit
  :target: https://gitter.im/pydoit/doit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

.. image:: https://opencollective.com/doit/backers/badge.svg
  :target: `backers`_

.. image:: https://opencollective.com/doit/sponsors/badge.svg
  :target: `sponsors`_


doit - automation tool
======================

*doit* comes from the idea of bringing the power of build-tools to
execute any kind of task


Project Details
===============

 - Website & docs - http://pydoit.org
 - Project management on github - https://github.com/pydoit/doit
 - Discussion group - https://groups.google.com/forum/#!forum/python-doit
 - News/twitter - https://twitter.com/py_doit
 - Plugins, extensions and projects based on doit - https://github.com/pydoit/doit/wiki/powered-by-doit

license
=======

The MIT License
Copyright (c) 2008-2018 Eduardo Naufel Schettino

see LICENSE file


developers / contributors
==========================

see AUTHORS file


install
=======

*doit* is tested on python 3.4 to 3.6.

The last version supporting python 2 is version 0.29.

::

 $ pip install doit


dependencies
=============

- cloudpickle
- pyinotify (linux)
- macfsevents (mac)

Tools required for development:

- git * VCS
- py.test * unit-tests
- coverage * code coverage
- sphinx * doc tool
- pyflakes * syntax checker
- doit-py * helper to run dev tasks


development setup
==================

The best way to setup an environment to develop *doit* itself is to
create a virtualenv...

::

  doit$ virtualenv dev
  (dev)doit$ dev/bin/activate

install ``doit`` as "editable", and add development dependencies
from `dev_requirements.txt`::

  (dev)doit$ pip install --editable .
  (dev)doit$ pip install --requirement dev_requirements.txt



tests
=======

Use py.test - http://pytest.org

::

  $ py.test



documentation
=============

``doc`` folder contains ReST documentation based on Sphinx.

::

 doc$ make html

They are the base for creating the website. The only difference is
that the website includes analytics tracking.
To create it (after installing *doit*)::

 $ doit website



spell checking
--------------

All documentation is spell checked using the task `spell`::

  $ doit spell

It is a bit annoying that code snippets and names always fails the check,
these words must be added into the file `doc/dictionary.txt`.

The spell checker currently uses `hunspell`, to install it on debian based
systems install the hunspell package: `apt-get install hunspell`.


profiling
---------

::

  python -m cProfile -o output.pstats `which doit` list

  gprof2dot -f pstats output.pstats | dot -Tpng -o output.png

contributing
==============

On github create pull requests using a named feature branch.




.. _backers

backers
-------


`Become a backer <https://opencollective.com/doit#backer>`_ and show your support to our open source project.

.. image:: https://opencollective.com/doit/backers.svg?width=890
  :target: https://opencollective.com/doit#backers



.. _sponsors

sponsors
--------

Support this project by `becoming a sponsor <https://opencollective.com/doit#sponsor>`_.
Your logo will show up here with a link to your website.

.. image:: https://opencollective.com/doit/sponsor/0/avatar
  :target: https://opencollective.com/doit/sponsor/0/website

.. image:: https://opencollective.com/doit/sponsor/1/avatar
  :target: https://opencollective.com/doit/sponsor/1/website

.. image:: https://opencollective.com/doit/sponsor/2/avatar
  :target: https://opencollective.com/doit/sponsor/2/website

.. image:: https://opencollective.com/doit/sponsor/3/avatar
  :target: https://opencollective.com/doit/sponsor/3/website

.. image:: https://opencollective.com/doit/sponsor/4/avatar
  :target: https://opencollective.com/doit/sponsor/4/website

.. image:: https://opencollective.com/doit/sponsor/5/avatar
  :target: https://opencollective.com/doit/sponsor/5/website

.. image:: https://opencollective.com/doit/sponsor/6/avatar
  :target: https://opencollective.com/doit/sponsor/6/website

.. image:: https://opencollective.com/doit/sponsor/7/avatar
  :target: https://opencollective.com/doit/sponsor/7/website

.. image:: https://opencollective.com/doit/sponsor/8/avatar
  :target: https://opencollective.com/doit/sponsor/8/website

.. image:: https://opencollective.com/doit/sponsor/9/avatar
  :target: https://opencollective.com/doit/sponsor/9/website