Metadata-Version: 1.1
Name: pyempt
Version: 1.0.23
Summary: Python emacs syntax checking
Home-page: https://github.com/emin63/pyempt
Author: Emin Martinian
Author-email: emin.martinian@gmail.com
License: BSD
Description: Introduction
        ============
        
        The pyempt package is a python emacs package for type checking and other
        syntax analysis. It is basically a simple wrapper around other python
        syntax checkers to simplify the process of calling pylint, pep8, etc.
        from something like emacs flymake.
        
        In principle, you could do all of this with a a few `simple
        scripts <http://stackoverflow.com/questions/1259873/how-can-i-use-emacs-flymake-mode-for-python-with-pyflakes-and-pylint-checking-co>`__.
        It's nice being able to ``pip install`` something that works and
        collaborate on improvements, however, and that is what pyempt is for.
        
        Installation
        ============
        
        To install pyempt, first do something like ``pip install pyempt`` or
        ``sudo pip install pyempt``. Then add something like the following to
        your ``~/.emacs`` file to run pyempt.
        
        ::
        
            (when (load "flymake" t)
              (defun flymake-pyempt-init ()
                (let* ((temp-file (flymake-init-create-temp-buffer-copy
                           'flymake-create-temp-inplace))
                   (local-file (file-relative-name
                        temp-file
                        (file-name-directory buffer-file-name))))
                  (list "pyempt"  (list local-file))))
               (add-to-list 'flymake-allowed-file-name-masks
                         '("\\.py\\'" flymake-pyempt-init)))
        
            (add-to-list 'flymake-allowed-file-name-masks
              '("\\.py\\'" flymake-pyempt-init))
        
            ;; Uncomment following line if you want flymake to start on file load
            ;;(add-hook 'find-file-hook 'flymake-find-file-hook)
        
        After you restart emacs or reload your init file, flymake should
        automatically start and call pyempt.
        
        Troubleshooting
        ===============
        
        If you have problems, the first thing to do is to try and run pyempt
        manually via something like
        
        ::
        
            pyempt <FILE_TO_CHECK>
        
        You can turn on logging via
        
        ::
        
            pyempt <FILE_TO_CHECK> --log_level 0
        
        You can get further help on the command line program via
        
        ::
        
            pyempt --help
        
        Forking
        =======
        
        If you want to fork pyempt, you may find the following useful:
        
        1. The ``README.md`` file is the main file. Generate the rst version via
           something like ``pandoc README.md -t rst > README.rst``
        2. Upload to pypi via something like
           ``rm -f dist/* && python3 setup.py sdist && twine upload dist/*``
        
Keywords: continuous integration emacs development
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
