| martin f. krafft | 46c0652 | 2013-07-03 20:03:22 +0200 | [diff] [blame] | 1 | ============================================================= |
| 2 | reclass — recursive external node classification |
| 3 | ============================================================= |
| 4 | reclass is © 2007–2013 martin f. krafft <madduck@madduck.net> |
| 5 | and available under the terms of the Artistic Licence 2.0 |
| 6 | ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' |
| 7 | |
| 8 | Installation |
| 9 | ~~~~~~~~~~~~ |
| 10 | If you just want to run reclass from source, e.g. because you are going to be |
| 11 | making and testing changes, install it in "development mode": |
| 12 | |
| 13 | python setup.py develop |
| 14 | |
| martin f. krafft | 3094327 | 2013-07-04 08:32:00 +0200 | [diff] [blame] | 15 | Now the reclass script, as well as the adapters, will be available in |
| 16 | /usr/local/bin, and you can also invoke them directly from the source tree. |
| 17 | |
| martin f. krafft | 46c0652 | 2013-07-03 20:03:22 +0200 | [diff] [blame] | 18 | To uninstall: |
| 19 | |
| 20 | python setup.py develop --uninstall |
| 21 | |
| 22 | Discussing reclass |
| 23 | ~~~~~~~~~~~~~~~~~~ |
| 24 | If you want to talk about reclass, the best way right now is to use the |
| 25 | salt-users mailing list (please put 'reclass' into the subject), or to find me |
| 26 | on IRC, either 'madduck' in the #salt/freenode channel, or in #reclass/oftc. |
| 27 | |
| 28 | Contributing to reclass |
| 29 | ~~~~~~~~~~~~~~~~~~~~~~~ |
| 30 | Conttributions to reclass are very welcome. Since I prefer to keep a somewhat |
| 31 | clean history, I will not just merge pull request. |
| 32 | |
| 33 | You can submit pull requests, of course, and I'll rebase them onto HEAD before |
| 34 | merging. Or send your patches using git-format-patch and git-send-e-mail to |
| 35 | reclass@pobox.madduck.net. |
| 36 | |
| 37 | I have added rudimentary unit tests, and it would be nice if you could submit |
| 38 | your changes with appropriate changes to the tests. To run tests, invoke |
| martin f. krafft | a5c998e | 2013-07-05 08:50:10 +0200 | [diff] [blame] | 39 | |
| martin f. krafft | 96a6aff | 2013-08-07 16:32:56 +0200 | [diff] [blame] | 40 | $ make tests |
| martin f. krafft | a5c998e | 2013-07-05 08:50:10 +0200 | [diff] [blame] | 41 | |
| martin f. krafft | 96a6aff | 2013-08-07 16:32:56 +0200 | [diff] [blame] | 42 | in the top-level checkout directory. The tests are rather inconsistent, some |
| 43 | using mock objects, and only the datatypes-related code is covered. If you are |
| 44 | a testing expert, I could certainly use some help here to improve the |
| 45 | consistency of the existing tests, as well as their coverage. |
| martin f. krafft | a5c998e | 2013-07-05 08:50:10 +0200 | [diff] [blame] | 46 | |
| 47 | Also, there is a Makefile giving access to PyLint and coverage.py (running |
| 48 | tests). If you run that, you can see there is a lot of work to be done |
| 49 | cleaning up the code. If this is the sort of stuff you want to do — by all |
| 50 | means — be my guest! ;) |
| martin f. krafft | 46c0652 | 2013-07-03 20:03:22 +0200 | [diff] [blame] | 51 | |
| 52 | If you have larger ideas, I'll be looking forward to discuss them with you. |
| 53 | |
| martin f. krafft | 96a6aff | 2013-08-07 16:32:56 +0200 | [diff] [blame] | 54 | -- martin f. krafft <madduck@madduck.net> Wed, 07 Aug 2013 16:21:04 +0200 |