[py-svn] r10847 - py/dist/py/documentation
hpk at codespeak.net
hpk at codespeak.net
Tue Apr 19 13:38:37 CEST 2005
Author: hpk
Date: Tue Apr 19 13:38:37 2005
New Revision: 10847
Added:
py/dist/py/documentation/getting-started.txt
- copied unchanged from r10846, py/dist/py/documentation/getting_started.txt
Removed:
py/dist/py/documentation/getting_started.txt
Modified:
py/dist/py/documentation/api.txt
py/dist/py/documentation/future.txt
py/dist/py/documentation/index.txt
py/dist/py/documentation/releasescheme.txt
py/dist/py/documentation/test.txt
Log:
reshaping the index page for the py lib
and some renamining (with referential
integrity checked via py.test ...)
Modified: py/dist/py/documentation/api.txt
==============================================================================
--- py/dist/py/documentation/api.txt (original)
+++ py/dist/py/documentation/api.txt Tue Apr 19 13:38:37 2005
@@ -16,4 +16,4 @@
documentation may state additional restrictions which
take precedence.
-.. _`getting started`: getting_started.html
+.. _`getting started`: getting-started.html
Modified: py/dist/py/documentation/future.txt
==============================================================================
--- py/dist/py/documentation/future.txt (original)
+++ py/dist/py/documentation/future.txt Tue Apr 19 13:38:37 2005
@@ -343,7 +343,7 @@
visions would make the link-checker a snap. It could serve
as a nice script in our ``example`` tree.
-.. _`getting started`: getting_started.html
+.. _`getting started`: getting-started.html
.. _`restructured text`: http://docutils.sourceforge.net/docs/user/rst/quickref.html
.. _`python standard library`: http://www.python.org/doc/2.3.4/lib/lib.html
.. _`xpython EuroPython 2004 talk`: http://codespeak.net/svn/user/hpk/talks/xpython-talk.txt
Deleted: /py/dist/py/documentation/getting_started.txt
==============================================================================
--- /py/dist/py/documentation/getting_started.txt Tue Apr 19 13:38:37 2005
+++ (empty file)
@@ -1,122 +0,0 @@
-Getting started with the py lib
-===============================
-
-.. contents::
-.. sectnum::
-
-Obtaining the current py lib
-============================
-
-Due to the nature of its innovative goals `the py lib`_ can't be
-easily released without a certain API consistency. Nevertheless,
-the API is pretty stable in many respects and very
-well tested. So we invite you to participate and
-use it - especially if you share `the frustrations with
-current python package development`_.
-
-.. _`the py lib`: index.html
-
-getting it via subversion
--------------------------
-
-Checkout the py lib distribution tree with subversion, e.g. use::
-
- svn co http://codespeak.net/svn/py/dist py-dist
-
-to checkout the code, documentation, tool and example tree
-into a ``py-dist`` checkout directory. Your naming desire may vary
-for your local checkout directory.
-
-If you experience problems with the subversion checkout e.g.
-because you have a http-proxy in between that doesn't proxy
-DAV requests you can try to use "codespeak.net:8080" instead
-of just "codespeak.net". Alternatively, you may tweak
-your local subversion installation.
-
-setting it up
--------------
-
-You need to put the checkout-directory into your ``PYTHONPATH``
-and you want to have the ``py-dist/py/bin/py.test`` script in
-your system path, which lets you execute test files and directories.
-
-There already is a convenient way for Bash/Shell based systems
-to setup the ``PYTHONPATH`` as well as the shell ``PATH``, insert::
-
- eval `python ~/path/to/py-dist/py/env.py`
-
-into your ``.bash_profile``. Of course, you need to
-specify your own checkout-directory.
-
-If you know of a good developer-style way of doing the
-equivalent on win32 (non-cygwin) environments, tell us_.
-
-And no, we don't provide a distutils-install until
-we have settled on a convenient way to upgrade seamlessly
-via an `svn up` while at the same time allowing
-installs/upgrades via the distutils `setup.py` way.
-
-upgrading it
-------------
-
-Well, easy. Go to your checkout directory and issue::
-
- svn up
-
-have fun and `get an account`_ :-)
-
-
-Participating in development
-============================
-
-Coding and communication
-------------------------
-
-We are practicing what could be called documentation,
-vision, discussion and automated test driven development.
-In the `future`_ book we try to layout visions and ideas for
-the near coding feature to give a means for preliminary
-feedback before code hits the ground.
-
-With our `coding style`_ we are mostly following
-cpython guidance with some additional restrictions
-some of which projects like twisted_ or zope3_ have
-adopted in similar ways.
-
-.. _`zope3`: http://www.zope3.org
-.. _twisted: http://www.twistedmatrix.org
-.. _`get an account`:
-.. _future: future.html
-
-The py-dev and py-svn mailing lists
------------------------------------
-
-If you feel the desire to help tackle bugs and fixes,
-or support resolution of some `frustrations`_ or to
-just lurk in then please subscribe to one or both
-of our mailinglists:
-
- `py-dev developers list`_
-
-and our
-
- `py-svn general commit mailing list`_
-
-get an account on codespeak
----------------------------
-
-codespeak_ is generally deploying a very liberal committing
-scheme. If you know someone who is active on codespeak already
-or you are otherwise known in the community then you will most
-probably just get access. But even if you are new to the
-python developer community you may still get one if you
-want to improve things and can be expected to honour the
-style of coding and communication.
-
-.. _`coding style`: coding-style.html
-.. _`frustrations`:
-.. _`the frustrations with current python package development`: why_py.html#frustrations
-.. _us: http://codespeak.net/mailman/listinfo/py-dev
-.. _codespeak: http://codespeak.net/
-.. _`py-dev developers list`: http://codespeak.net/mailman/listinfo/py-dev
-.. _`py-svn general commit mailing list`: http://codespeak.net/mailman/listinfo/py-svn
Modified: py/dist/py/documentation/index.txt
==============================================================================
--- py/dist/py/documentation/index.txt (original)
+++ py/dist/py/documentation/index.txt Tue Apr 19 13:38:37 2005
@@ -5,11 +5,21 @@
development process addressing important deployment,
versioning, testing and documentation issues - seen
primarily from the perspective of a FOSS (Free and
-Open Source) developer. At the same time, or maybe
-just because of that, the py lib is very usable
-for real life python applications.*
+Open Source) developer. While the primary focus
+is on developer activities this does not preclude
+usage of the py lib for applications.*
- `why what how py?`_ describes a bit of the motivation and background
+Important Links:
+
+ `getting started`_ quick start for using py.test and the py lib.
+
+ **py-dev at codespeak net** the development mailing list
+
+ **#pylib on irc.freenode.net** (upcoming) development IRC channel
+
+ `why what how py?`_, describing motivation and background of the py lib
+
+Usage Documentation:
`py.test`_ introduces to the new'n'easy **py.test** utility
@@ -24,19 +34,17 @@
`future`_ handles development visions and plans for the near future.
Note that some parts of these texts refer to future development and
-do not exactly reflect the current state.
-
-**Welcome to documentation and test driven development** :-)
-
-There is some preliminary documentation for `getting started`_
+do not reflect the current state. **Welcome to documentation and
+test driven development** :-)
+.. _`getting started`: getting-started.html
.. _`py.execnet`: execnet.html
.. _`py.magic.greenlet`: greenlet.html
.. _`py.test`: test.html
.. _`py.xml`: xml.html
.. _`Why What how py?`: why_py.html
.. _`future`: future.html
-.. _`getting started`: getting_started.html
+.. _`getting started`: getting-started.html
.. _`miscellaneous features`: misc.html
Modified: py/dist/py/documentation/releasescheme.txt
==============================================================================
--- py/dist/py/documentation/releasescheme.txt (original)
+++ py/dist/py/documentation/releasescheme.txt Tue Apr 19 13:38:37 2005
@@ -38,7 +38,7 @@
2) go to the `py-dist` directory and run `python setup.py install`.
-.. _`getting started`: getting_started.html
+.. _`getting started`: getting-started.html
If you later want to upgrade your version of the py lib
to the newest release you simply issue::
Modified: py/dist/py/documentation/test.txt
==============================================================================
--- py/dist/py/documentation/test.txt (original)
+++ py/dist/py/documentation/test.txt Tue Apr 19 13:38:37 2005
@@ -475,7 +475,7 @@
allow plain test functions (without being in a class) and
allow classes to simply mean "grouping" of tests.
-.. _`getting started`: getting_started.html
+.. _`getting started`: getting-started.html
.. _`py-dev mailing list`: http://codespeak.net/mailman/listinfo/py-dev
More information about the pytest-commit
mailing list