/site-lisp/packages/epy/README.org

https://github.com/fanhongtao/_emacs.d · Org · 90 lines · 68 code · 22 blank · 0 comment · 5 complexity · 818cf44f1cfd944d7310709c827353a1 MD5 · raw file

  1. * Welcome to the best collection of emacs extensions ever
  2. I'm collecting and customizing the perfect environment for python
  3. developement, using the most beautiful emacs customization to obtain a
  4. really modern and exciting (yet stable) way to edit text files.
  5. In the package are included also a lot of other packages and
  6. configurations, it's an upstart for clean emacs installations, these
  7. configuration however are very similar to emacs-starter-kit and I
  8. suggest you to give it a try, emacs-for-python is designed to work
  9. with it (instruction below).
  10. ** Features
  11. The package is splitted in various files, in this way it's very easy
  12. to include what you really need.
  13. *** Python Related
  14. - Ropemacs (Custom) : A refactoring library
  15. - Auto Completion with rope (Custom) : Tested to work well with Rope
  16. - Flymake + pyflakes (Custom): Highlight errors on the fly, improved
  17. from the standard version
  18. - Virtualenv : Original, In-development tool for using virtualenv in
  19. emacs.
  20. - Custom Yasnippet Snippets
  21. - Cython Mode: a mode for highlighting cython files
  22. *** Editing Packages
  23. - Open Next Line: C-o will open a line under the cursor (very
  24. similar to vim o)
  25. - Auto Completion: Wonderful package for auto complete anything in
  26. emacs
  27. - Yasnippet: Snippets on steroids
  28. - Parentheses pairing (Custom): Bug-free parentheses pairing using
  29. skeletons.
  30. - smart-operator: Automatically adds spaces around arithmetic operators.
  31. *** Configurations
  32. - ido activation
  33. - ibuffer instead of buffer menu
  34. - eshell configuration
  35. *** Keybindings
  36. - Copy-Cut-Paste from clipboard with Super-C Super-X Super-V
  37. - Calc Mode remapping to M-c
  38. - M-Tab remapped to C-Tab to avoid collisions with the desktop
  39. manager
  40. ** Installation
  41. Put the emacs-for-python directory in .emacs.d directory (or any
  42. other), the add this line in your .emacs, it will enable all the
  43. features of emacs-for-python package (editing configuration,
  44. keybindings, python stuff etc...)
  45. : (load-file "/path/to/emacs-for-python/epy-init.el")
  46. You may want to enable only some of the features provided by
  47. emacs-for-python, in this case just enable some of them:
  48. : (add-to-list 'load-path "path/to/emacs-for-python/") ;; tell where to load the various files
  49. : (require 'epy-setup) ;; It will setup other loads, it is required!
  50. : (require 'epy-python) ;; If you want the python facilities [optional]
  51. : (require 'epy-completion) ;; If you want the autocompletion settings [optional]
  52. : (require 'epy-editing) ;; For configurations related to editing [optional]
  53. : (require 'epy-bindings) ;; For my suggested keybindings [optional]
  54. For further information and usage suggestions check http://wiki.github.com/gabrielelanaro/emacs-for-python/workflow
  55. ** Installation with emacs-starter-kit
  56. I've built up a little fork of emacs starter kit that is greatly
  57. integrated with emacs-for-python, it seems the best solution to me!
  58. The repo is at this address: http://github.com/gabrielelanaro/emacs-starter-kit
  59. Remember that customization to emacs-starter-kit are done to a
  60. custom.el file, and so you can substitute your distribution of
  61. emacs-starter-kit and you have to copy just your customization file.
  62. ** License
  63. This is mostly a distribution with some little tweaks, with respect of
  64. the licenses, my tweaks are distributed according to the term of the
  65. GNU GPL license, described in the file COPYING.
  66. Generally each file has its own license and copyright notice (most, if
  67. not all of packages are GPL), the license of rope (GPL) is in
  68. rope-dist/COPYING.