Re: [Distutils] docs/ vs doc/

2010-09-21 Thread Michael Foord
I prefer docs. It seems more natural.

Michael

On 21 September 2010 11:35, anatoly techtonik techto...@gmail.com wrote:

 Hi,

 I see that distutils2 promotes storing documentation in docs/
 directory while Python sources use Doc/
 I'd like to see this changed before distutils2 is released beta.

 In my projects checkouts there are 80 project that use doc/
 directories. Among these are:
 - subversion
 - hg
 - sphinx
 - trac
 - scons
 - twisted

 docs/ directory is used by 61 project, the most famous are:
 - xalan
 - fop
 - moinmoin
 - cmd2
 - googlecl


 There are some arguments for 'doc/':
 1. there is no plural for 'documentation'
 2. bin/ is a common name for storing executables, although there is
 plural for 'binary'
 3. we still use src/ instead of sources/

 Any thoughts/objections?
 --
 anatoly t.
 ___
 Distutils-SIG maillist  -  Distutils-SIG@python.org
 http://mail.python.org/mailman/listinfo/distutils-sig




-- 
http://www.voidspace.org.uk
___
Distutils-SIG maillist  -  Distutils-SIG@python.org
http://mail.python.org/mailman/listinfo/distutils-sig


Re: [Distutils] docs/ vs doc/

2010-09-21 Thread Attila Oláh
On Tue, Sep 21, 2010 at 12:38, Michael Foord fuzzy...@voidspace.org.uk wrote:
 I prefer docs. It seems more natural.

Me too. I think I got the habit of using docs instead of doc from
some Zope guys.

http://www.google.com/search?q=site:svn.zope.org+inurl:doc ~600 results
http://www.google.com/search?q=site:svn.zope.org+inurl:docs ~ 13000 results

Attila
___
Distutils-SIG maillist  -  Distutils-SIG@python.org
http://mail.python.org/mailman/listinfo/distutils-sig


Re: [Distutils] docs/ vs doc/

2010-09-21 Thread Georg Brandl
Am 21.09.2010 12:35, schrieb anatoly techtonik:
 Hi,
 
 I see that distutils2 promotes storing documentation in docs/
 directory while Python sources use Doc/
 I'd like to see this changed before distutils2 is released beta.
 
 In my projects checkouts there are 80 project that use doc/
 directories. Among these are:
 - subversion
 - hg
 - sphinx
 - trac
 - scons
 - twisted
 
 docs/ directory is used by 61 project, the most famous are:
 - xalan
 - fop
 - moinmoin
 - cmd2
 - googlecl
 
 
 There are some arguments for 'doc/':
 1. there is no plural for 'documentation'

FWIW, docs is probably short for the documents.

That said, I have no preference and as long as a solution works with both
doc/ and docs/ it's fine with me.

Georg

-- 
Thus spake the Lord: Thou shalt indent with four spaces. No more, no less.
Four shall be the number of spaces thou shalt indent, and the number of thy
indenting shall be four. Eight shalt thou not indent, nor either indent thou
two, excepting that thou then proceed to four. Tabs are right out.

___
Distutils-SIG maillist  -  Distutils-SIG@python.org
http://mail.python.org/mailman/listinfo/distutils-sig


Re: [Distutils] docs/ vs doc/

2010-09-21 Thread Ben Finney
anatoly techtonik techto...@gmail.com writes:

 There are some arguments for 'doc/':
 1. there is no plural for 'documentation'
 2. bin/ is a common name for storing executables, although there is
 plural for 'binary'
 3. we still use src/ instead of sources/

* ‘doc/’ is consistent with the standardised directory name on many
  operating systems (those that inspired, or are based on, the FHS)

I don't think a vote is appropriate (I think the choice should be made
on merit, not popularity), but if anyone's counting, I prefer ‘doc/’.

-- 
 \  “Progress might have been all right once, but it's gone on too |
  `\long.” —Ogden Nash |
_o__)  |
Ben Finney

___
Distutils-SIG maillist  -  Distutils-SIG@python.org
http://mail.python.org/mailman/listinfo/distutils-sig


Re: [Distutils] docs/ vs doc/

2010-09-21 Thread Barry Warsaw
On Sep 21, 2010, at 01:35 PM, anatoly techtonik wrote:

I see that distutils2 promotes storing documentation in docs/
directory while Python sources use Doc/
I'd like to see this changed before distutils2 is released beta.

What does promotes mean?  That only docs/ can be used?

In my projects checkouts there are 80 project that use doc/
directories. Among these are:
- subversion
- hg
- sphinx
- trac
- scons
- twisted

docs/ directory is used by 61 project, the most famous are:
- xalan
- fop
- moinmoin
- cmd2
- googlecl

So, almost evenly split. :)

I'm with Michael, I prefer docs/ and that's what I use for Mailman and all my
libraries.  It just *seems* righter. ;)

I still don't quite know in what way distutils2 promotes docs/ but I do think
both choices need to be easily supported.  Also for unittest2, since my docs/
directories just happen to also contain tests.

-Barry


signature.asc
Description: PGP signature
___
Distutils-SIG maillist  -  Distutils-SIG@python.org
http://mail.python.org/mailman/listinfo/distutils-sig


Re: [Distutils] docs/ vs doc/

2010-09-21 Thread Barry Warsaw
On Sep 21, 2010, at 05:20 PM, anatoly techtonik wrote:

On Tue, Sep 21, 2010 at 2:57 PM, Barry Warsaw ba...@python.org wrote:

I see that distutils2 promotes storing documentation in docs/
directory while Python sources use Doc/
I'd like to see this changed before distutils2 is released beta.

 What does promotes mean?  That only docs/ can be used?

upload_docs command will extract documentation from 'docs/' by
default. I wouldn't bring this question if it could also process
'doc/' in cases where 'docs/' are absent. You can specify upload
directory explicitly, but sometimes you'd really like it to just work.

Gotcha, thanks.

Yes it should definitely use doc/ if docs/ is missing.  However, upload_docs
never quite works out of the box for me anyway.  First, it insists on an
index.html file, which my Sphinx builds never seem to write, so I always have
to add a symlink.  Second, it doesn't seem to play nicely with the location
that my buildout-based builds puts the docs, so I always also have to use
--upload-dir.  Yes, it would be nice if both of these problems were fixed too.
Yes, I should report them as bugs (or just fix 'em ;).

-Barry


signature.asc
Description: PGP signature
___
Distutils-SIG maillist  -  Distutils-SIG@python.org
http://mail.python.org/mailman/listinfo/distutils-sig


Re: [Distutils] docs/ vs doc/

2010-09-21 Thread Fred Drake
On Tue, Sep 21, 2010 at 10:20 AM, anatoly techtonik techto...@gmail.com wrote:
 upload_docs command will extract documentation from 'docs/' by
 default. I wouldn't bring this question if it could also process
 'doc/' in cases where 'docs/' are absent. You can specify upload
 directory explicitly, but sometimes you'd really like it to just work.

Of course, we'd have to define what just work means here.  I'd be
fine having to always tell upload_docs where to look, provided I can
do that in the setup.cfg d2 uses.

That said, I don't *mind* if it looks for both docs/ and doc/, or even
care which it looks for first.


  -Fred

--
Fred L. Drake, Jr.    fdrake at acm.org
A storm broke loose in my mind.  --Albert Einstein
___
Distutils-SIG maillist  -  Distutils-SIG@python.org
http://mail.python.org/mailman/listinfo/distutils-sig


Re: [Distutils] [issue116] typo in command.bdist_enc.make_zipfile

2010-09-21 Thread P.J. Eby

At 03:10 AM 9/21/2010 +, Ted Tibbetts wrote:
Looks like there is a typo in the function `make_zipfile` in the 
file `command/bdist_enc`: the last line of the else clause of the if 
construct at the end of the function passes `file` as the third 
parameter to `visit`; it should be passing `files`, I think.


Symptoms include the exception `TypeError('instancemethod' object 
is not iterable)` when attempting to run `easy_install -n some_sdist.tar.gz`.


Applying the attached patch seems to resolve the issue; I'm still 
not entirely sure what it's telling me, but at least it's not 
spitting out a stack trace.


Hi Ted.  It appears you are using distribute, not 
setuptools.  Unfortunately, some Linux distributions are shipping 
distribute (a fork of setuptools) under the name setuptools, which 
creates user confusion.  If you are using your Linux distribution's 
installation of setuptools, please make sure to file this bug with 
your Linux distributor as well.


Distribute has many changes relative to setuptools, some of which 
have introduced new bugs.  It looks like this is the specific change 
that introduced the problem you're experiencing:


   http://bitbucket.org/tarek/distribute/changeset/512db2c962e4

In this case the problem is fairly minor, since it only affects dry 
runs that would probably fail later in the process anyway.


Unless you are using Distribute by choice for its additional 
features, you may wish to uninstall it and replace it with a stable 
version of setuptools.  (Unfortunately, if you are using your Linux 
distributor's installation of it, this may not be possible.)


___
Distutils-SIG maillist  -  Distutils-SIG@python.org
http://mail.python.org/mailman/listinfo/distutils-sig


[Distutils] [issue117] Unable to upload package without storing password in ~/.pypirc

2010-09-21 Thread Ted Tibbetts

New submission from Ted Tibbetts intui...@gmail.com:

I can't seem to upload a source distribution without storing my password in 
~/.pypirc.

If I have no ~/.pypirc, and I give a the command

``$ python setup.py sdist register upload``

and then give my login credentials, this happens at the end:

::

running register
Password: 
Registering terminable_thread to http://pypi.python.org/pypi
Server response (200): OK
running upload
Submitting dist/terminable_thread-0.7.tar.gz to http://pypi.python.org/pypi
Upload failed (401): Incorrect password

I get similar results if my ``~/.pypirc`` has a line in the ``[pypi]`` section 
containing just ``password:``, whether or not I omit the ``register`` command.

I was able to upload the distribution by putting my password in ``~/.pypirc``.

The ``upload`` command seems to be checking for the password independently from 
``register``; this runs contrary to the documentation_.

.. _documentation: http://docs.python.org/distutils/packageindex.html#pypirc

I'm running the bona fide (not ``distribute``) ``setuptools``, version 
``0.6c11``.  This assertion is based on

::

$ cat `which easy_install` | grep load
from pkg_resources import load_entry_point
   load_entry_point('setuptools==0.6c11', 'console_scripts', 
'easy_install')()

and the fact that I just deleted my old ``setuptools`` and installed by 
executing the current tarball from the ``setuptools`` PyPI page.

--
messages: 553
nosy: intuited
priority: bug
status: unread
title: Unable to upload package without storing password in ~/.pypirc

___
Setuptools tracker setupto...@bugs.python.org
http://bugs.python.org/setuptools/issue117
___
___
Distutils-SIG maillist  -  Distutils-SIG@python.org
http://mail.python.org/mailman/listinfo/distutils-sig


Re: [Distutils] [issue117] Unable to upload package without storing password in ~/.pypirc

2010-09-21 Thread Tarek Ziadé
This is not related to setuptools but to Distutils so you should file
an issue at bugs.python.org instead.

IIRC I have fixed this in 2.6. What is your Python version ?


On Wed, Sep 22, 2010 at 12:10 AM, Ted Tibbetts
setupto...@bugs.python.org wrote:

 New submission from Ted Tibbetts intui...@gmail.com:

 I can't seem to upload a source distribution without storing my password in 
 ~/.pypirc.

 If I have no ~/.pypirc, and I give a the command

    ``$ python setup.py sdist register upload``

 and then give my login credentials, this happens at the end:

 ::

    running register
    Password:
    Registering terminable_thread to http://pypi.python.org/pypi
    Server response (200): OK
    running upload
    Submitting dist/terminable_thread-0.7.tar.gz to http://pypi.python.org/pypi
    Upload failed (401): Incorrect password

 I get similar results if my ``~/.pypirc`` has a line in the ``[pypi]`` 
 section containing just ``password:``, whether or not I omit the ``register`` 
 command.

 I was able to upload the distribution by putting my password in ``~/.pypirc``.

 The ``upload`` command seems to be checking for the password independently 
 from ``register``; this runs contrary to the documentation_.

 .. _documentation: http://docs.python.org/distutils/packageindex.html#pypirc

 I'm running the bona fide (not ``distribute``) ``setuptools``, version 
 ``0.6c11``.  This assertion is based on

 ::

    $ cat `which easy_install` | grep load
    from pkg_resources import load_entry_point
       load_entry_point('setuptools==0.6c11', 'console_scripts', 
 'easy_install')()

 and the fact that I just deleted my old ``setuptools`` and installed by 
 executing the current tarball from the ``setuptools`` PyPI page.

 --
 messages: 553
 nosy: intuited
 priority: bug
 status: unread
 title: Unable to upload package without storing password in ~/.pypirc

 ___
 Setuptools tracker setupto...@bugs.python.org
 http://bugs.python.org/setuptools/issue117
 ___
 ___
 Distutils-SIG maillist  -  distutils-...@python.org
 http://mail.python.org/mailman/listinfo/distutils-sig




-- 
Tarek Ziadé | http://ziade.org
___
Distutils-SIG maillist  -  Distutils-SIG@python.org
http://mail.python.org/mailman/listinfo/distutils-sig