[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#928633: marked as done (elpa-elpy: please provide docs in html format)



Your message dated Thu, 30 May 2019 04:03:39 +0000
with message-id <E1hWCHz-000GDx-CK@fasolo.debian.org>
and subject line Bug#928633: fixed in elpy 1.28.0-2
has caused the Debian Bug report #928633,
regarding elpa-elpy: please provide docs in html format
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact owner@bugs.debian.org
immediately.)


-- 
928633: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=928633
Debian Bug Tracking System
Contact owner@bugs.debian.org with problems
--- Begin Message ---
Package: elpa-elpy
Version: 1.28.0-1
Severity: normal

Dear Maintainer,

I've been struggling with getting elpy to work on Debian stable.

For right now, some comments and suggestions about README.Debian.

1) There's a typo in your code:

    (setq python-shell-interpreter "python"
              python-shell-interpreter-args "-i")
              elpy-rpc-python-command "python")

It should be:

    (setq python-shell-interpreter "python"
              python-shell-interpreter-args "-i"
              elpy-rpc-python-command "python")

2) You should mention that elpy isn't loaded by default, and indicate
how to load it. Historically, Debian packages autoload modes once
installed, and personally I find that more convenient. But I
understand if you don't load it to preserce compatibility with
upstream EPLA.

The elpy manual mentions in
https://elpy.readthedocs.io/en/latest/introduction.html that elpy
should be enabled with

    (package-initialize)
    (elpy-enable)

Just the second line works for me here. I'm not sure what the first
part does. Some sort of global enable, apparently.

3) I suggest mentioning the upstream manual in README.Debian. Namely,
https://elpy.readthedocs.io/en/latest/

4) And if I were writing the README.Debian, I'd also mention that C-c
C-c runs the buffer, and that you need C-c C-z to open up a Python
interpreter buffer. This would help people to get going quickly,
instead of flailing around trying to figure out what to do.

These commands are both in
https://elpy.readthedocs.io/en/latest/ide.html

    C-c C-y r (elpy-shell-send-region-or-buffer)
    [...]
    Also bound to C-c C-c.

and

    C-c C-z (elpy-shell-switch-to-shell)

There are a ton of commands in that manual, and it's really
confusing. But you really only need a couple to get going. That manual
really needs a quickstart page.

Do you happen to know if it is possible to configure emacs to open a
Python buffer in elpy mode by default and skip the C-c C-z?

5) I'm also running into the error message mentioned in
https://github.com/jorgenschaefer/elpy/issues/1521

Should I report it here? Or just upstream? I added a comment to that
thread.

6) Your bug report template should include the output of
elpy-config. I've included mine at the bottom. I'm not sure what is going on with

    Elpy..............: Not found (Python), 1.28.0 (Emacs Lisp)

though. What's the difference between those two cases?

7) I suggest adding Python 2 packages to the package
dependencies/recommends/suggests too. Like for Jedi. People are still
using Python 2, and are likely to be doing so for awhile.

Regards, Faheem Mitha

-- System Information:
Debian Release: 9.8
  APT prefers stable-updates
  APT policy: (500, 'stable-updates'), (500, 'stable'), (50, 'unstable'), (1, 'experimental')
Architecture: amd64 (x86_64)
Foreign Architectures: i386

Kernel: Linux 4.9.0-8-amd64 (SMP w/6 CPU cores)
Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8), LANGUAGE=en_US:en (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)

Versions of packages elpa-elpy depends on:
ii  elpa-company                0.9.9-2
ii  elpa-find-file-in-project   5.7.3-1
ii  elpa-highlight-indentation  0.7.0-1
ii  elpa-pyvenv                 1.20-1
ii  elpa-s                      1.12.0-2
ii  elpa-yasnippet              0.11.0-2
ii  emacsen-common              2.0.8
ii  flake8                      3.2.1-1
ii  python3                     3.5.3-1
ii  python3-flake8              3.2.1-1

Versions of packages elpa-elpy recommends:
ii  emacs         46.1
ii  python3-jedi  0.10.0~git1+f05c071-1

Versions of packages elpa-elpy suggests:
pn  black                    <none>
ii  python3-autopep8         1.4.3-1
ii  python3-jupyter-console  5.0.0-1
ii  python3-pip              9.0.1-2
pn  yapf3                    <none>

-- debconf-show failed

############################################
Output of M-x elpy-config
############################################
Elpy Configuration

Virtualenv........: None
RPC Python........: 2.7.13 (/usr/bin/python)
Interactive Python: python (/usr/bin/python)
Emacs.............: 25.1.1
Elpy..............: Not found (Python), 1.28.0 (Emacs Lisp)
Jedi..............: 0.12.0
Rope..............: 0.10.3
Autopep8..........: 0.9.1
Yapf..............: Not found
Black.............: Not found
Syntax checker....: flake8 (/usr/bin/flake8)

You have not activated a virtual env. While Elpy supports this, it is
often a good idea to work inside a virtual env. You can use M-x
pyvenv-activate or M-x pyvenv-workon to activate a virtual env.

The directory ~/.local/bin/ is not in your PATH. As there is no active
virtualenv, installing Python packages locally will place executables
in that directory, so Emacs won't find them. If you are missing some
commands, do add this directory to your PATH -- and then do
`elpy-rpc-restart'.

The Python interpreter could not find the elpy module. Make sure the
module is installed.

[run] easy_install --user elpy

The yapf package is not available. Commands using this will not work.

[run] easy_install --user yapf

The black package is not available. Commands using this will not work.

[run] easy_install --user black

Options

Square brackets indicate buttons; type RET or click mouse-1 on a
button to invoke its action.  Invoke [+] to expand a group, and [-] to
collapse an expanded group.  Invoke the [Group], [Face], and [Option]
buttons below to edit that item in another window.

[+]-- [Group] Elpy
[+]-- [Group] Python
[+]-- [Group] Virtual Environments (Pyvenv)
[+]-- [Group] Completion (Company)
[+]-- [Group] Call Signatures (ElDoc)
[+]-- [Group] Inline Errors (Flymake)
[+]-- [Group] Snippets (YASnippet)
[+]-- [Group] Directory Grep (rgrep)
[+]-- [Group] Search as You Type (ido)
[+]-- [Group] Django extension
[+]-- [Group] Autodoc extension

--- End Message ---
--- Begin Message ---
Source: elpy
Source-Version: 1.28.0-2

We believe that the bug you reported is fixed in the latest version of
elpy, which is due to be installed in the Debian FTP archive.

A summary of the changes between this version and the previous one is
attached.

Thank you for reporting the bug, which will now be closed.  If you
have further comments please address them to 928633@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.

Debian distribution maintenance software
pp.
Nicholas D Steeves <nsteeves@gmail.com> (supplier of updated elpy package)

(This message was generated automatically at their request; if you
believe that there is a problem with it please contact the archive
administrators by mailing ftpmaster@ftp-master.debian.org)


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Format: 1.8
Date: Wed, 29 May 2019 18:05:30 -0400
Source: elpy
Binary: elpa-elpy
Architecture: source all
Version: 1.28.0-2
Distribution: unstable
Urgency: medium
Maintainer: Debian Emacsen team <debian-emacsen@lists.debian.org>
Changed-By: Nicholas D Steeves <nsteeves@gmail.com>
Description:
 elpa-elpy  - Emacs Python Development Environment
Closes: 926326 927084 927085 928633
Changes:
 elpy (1.28.0-2) unstable; urgency=medium
 .
   * debian/rules: Disable DH_VERBOSE.
   * Use sphinx to generate documentation in html format, and use
     debian/docs to install it.
     (Closes: #928633)
   * Add libjs-sphinxdoc to Recommends.  This package's html doc search page
     fails gracefully with "Please activate JavaScript to enable the search
     functionality" if a user chooses not to install libjs-sphinxdoc.
   * debian/README.Debian: Make explicit how Debian's Elpy package does
     not ship with support for Python 2. (Closes: #927084)
   * debian/control: Clarify comment explaining why the Python 2 package
     python-autopep8 is a build dependency.
   * Add 0002-Add-a-quickstart-section-to-the-documentation-1598.patch
     (Closes: #927085)
   * Add 0004-Enable-elpy-mode-in-python-buffer-when-enabling-Elpy.patch,
     and its prerequisite 0003-Make-sure-we-cannot-load-Elpy-twice.patch.
     Also add 0005-Fix-typo.patch, which is a fixup for the 0003-* patch.
     See DEP-3 headers of patches for more information. (Closes: #926326)
Checksums-Sha1:
 163822c2762ea4bc128440f519612ee7c74a4336 2422 elpy_1.28.0-2.dsc
 c73d5c5d0f82c27f4de65f3ab7b8d9a311917a9d 119564 elpy_1.28.0.orig.tar.xz
 0d780cd7a652f60489de856fb80b3e68bd6c0816 9592 elpy_1.28.0-2.debian.tar.xz
 c64f0e7e2060a5bb08093bf38aea5c24ce19efd4 152192 elpa-elpy_1.28.0-2_all.deb
 45546a2ef9928733af8e5bcf3cf72633647bb4e4 10321 elpy_1.28.0-2_amd64.buildinfo
Checksums-Sha256:
 af9e43ac2cb89e082352de014b5cd6bc26b8456ce74b3735e19fde8f6786a49c 2422 elpy_1.28.0-2.dsc
 1f01e2ef843c1dd849c6a585e537b46fcafe33904bb3281c84f23880e81151ba 119564 elpy_1.28.0.orig.tar.xz
 b9d148e4cfc2839b2a6583097f0ef834f21f3b87bc17621738df0b473a872d43 9592 elpy_1.28.0-2.debian.tar.xz
 7bdd12bf9ea14137e184f69277038bdcfa51d4405df305a3f8ee3f9ce8727190 152192 elpa-elpy_1.28.0-2_all.deb
 d0f5e760c92acf645bf750bd76fcdda0221b84ed7a26c8831f9dae1bbf5c4f16 10321 elpy_1.28.0-2_amd64.buildinfo
Files:
 acd2a144e9c7c196606ca940dab64471 2422 devel optional elpy_1.28.0-2.dsc
 0f467d7af4ebac6ddc1b78dea3d6864a 119564 devel optional elpy_1.28.0.orig.tar.xz
 716f9107740f5960335fc5017dc00bc4 9592 devel optional elpy_1.28.0-2.debian.tar.xz
 82850729dba414858f96500f9bcb2790 152192 devel optional elpa-elpy_1.28.0-2_all.deb
 d4eb4c35efc2befa4a026dc29f3ce14b 10321 devel optional elpy_1.28.0-2_amd64.buildinfo

-----BEGIN PGP SIGNATURE-----

iQIzBAEBCAAdFiEEwv5L0nHBObhsUz5GHpU+J9QxHlgFAlzvU+4ACgkQHpU+J9Qx
Hli7URAAm0Ivn8AXk+iddthfUqqsaPyJrS3XRu0u2THReyQ7mf9I4TjTnCRTRyBC
GlIbwHHvjwGIEpYYXGyWtM3aMvLWsN7dLb/v8+x9wjnvWGjSCjQIIhPg69rHPWdE
fVfEzD1cQyfBXbWCXbll7A05RCyJNennreKpVAbCATPV/gSFc2BLjPlfKDekVKI9
83VVBDBG+YZPSdYdgUC1OKRFJ3KRORMzaAKhWguSmgEyVCzkmlpW0jlf8372f4qk
pp0rwG6KyxiG08xBYnenSnk4rc3gmV1AnmVacWyGDLN0AAAWzv7ST6jjMQra3axm
4ktGfF6T3Iw/oTyRLhy4HMfwbmegkvX1tJ1o+/AUWnRMvaBw6EZmgaaStSJvguxT
A1UkMP7trOz9daEpEbsy1zy4NP66/Aq2QdNd5b1sH5MWg1MXXsmaxBRD1b+eLMHS
/E5BeVj4U4Y8SY5HSp+slOHJVUvHyrBGJ3C6uW/GUzfyZXfIK6evBCezHN2uj5vb
J8d1z1+DvcF+x5aW9qLzzbQqlXbaAShLD/TCblRM5bO1OdHXfdx1Ic4wV1Zxd/h1
FZQFqXb4TibKXAuF9lumFGwcXfV7ODic2fq6rbH+uOeOHWEWiABAqkl8JJJ0vGZ5
qE/zsDuov9QOnc1W2akiFweNp2eTn4kcaS47dQPu3B9xAvIQMFE=
=HYMP
-----END PGP SIGNATURE-----

--- End Message ---

Reply to: