[py-svn] r10421 - py/branch/py-collect/documentation
hpk at codespeak.net
hpk at codespeak.net
Fri Apr 8 03:26:56 CEST 2005
Author: hpk
Date: Fri Apr 8 03:26:56 2005
New Revision: 10421
Added:
py/branch/py-collect/documentation/releasescheme.txt (contents, props changed)
Modified:
py/branch/py-collect/documentation/getting_started.txt
Log:
moving towards a nice release scheme describing
- the structure of upcoming py releases
- how you can install it via subversion or tarballs
- how you can integrate into your project via svn-externals
- outlook on how to integrate it with distutils
Modified: py/branch/py-collect/documentation/getting_started.txt
==============================================================================
--- py/branch/py-collect/documentation/getting_started.txt (original)
+++ py/branch/py-collect/documentation/getting_started.txt Fri Apr 8 03:26:56 2005
@@ -25,12 +25,13 @@
to checkout the code, documentation, tool and example tree
into a ``dist-py`` checkout directory. Your naming desire may vary
-for your local checkout directory, of course.
+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".
+of just "codespeak.net". Alternatively, you may tweak
+your local subversion installation.
setting it up
-------------
@@ -50,10 +51,10 @@
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 currently,
-because we really want have the py lib installable
-on multiple python versions, want to have automated
-upgrades ...
+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
------------
@@ -77,7 +78,7 @@
the near coding feature to give a means for preliminary
feedback before code hits the ground.
-With our `coding style` we are mostly following
+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.
Added: py/branch/py-collect/documentation/releasescheme.txt
==============================================================================
--- (empty file)
+++ py/branch/py-collect/documentation/releasescheme.txt Fri Apr 8 03:26:56 2005
@@ -0,0 +1,117 @@
+The directory release layout of the repository::
+
+ svn/py/dist # latest released code
+ svn/py/tag/py-X.Y.Z # tagged releases
+ svn/py/branch/py-X.Y # contains release branch development
+ svn/py/trunk # head development
+
+Scenario "no svn and just let me play, please"
+==============================================
+
+If you don't have a subversion client you can download
+specific versions by going to
+
+ http://codespeak.net/download/py
+
+and pick a suitable archive file. You need to
+unpack it and run `setup.py` to install it for
+your platform.
+
+Installation Scenario "svn + stay close to released versions"
+-------------------------------------------------------------
+
+If you have a subversion client (you can easily install
+one :-) it is recommended that you choose the following
+method to install, irrespective if you want to install
+things via `distutils`_. Start by issueing the following
+shell command (or a graphical equivalent)::
+
+ svn co http://codespeak.net/svn/py/dist dist-py
+
+You will then want to make sure that the `dist-py/py/bin` directory
+is on your shell search path. This allows you to use "py.test" from
+the command line.
+
+If you not only want to use `py.test` but want to import
+the py lib within your application you have two choices:
+
+1) you make sure that `dist-py` is on your python search
+ path, e.g. via setting the `PYTHONPATH`. (you may
+ also consider the `svn-external scenario`_ if you
+ need to include the py lib in your application).
+
+2) go to the `dist-py` directory and run `python setup.py install`.
+
+If you now want to upgrade your version of the py lib
+you can simply issue::
+
+ svn up
+
+or to switch to the development trunk via::
+
+ svn switch http://codespeak.net/svn/py/trunk
+
+or to a specific version via::
+
+ svn switch http://codespeak.net/svn/py/tag/py-X.Y.Z
+
+or to a specific release branch::
+
+ svn switch http://codespeak.net/svn/py/branch/py-X.Y
+
+If you choose the option No. 2) above you have to repeat
+the distutils install after a checkout, aka
+`python setup.py install`.
+
+.. _`svn-external scenario`:
+
+Installation Scenario "svn + include py lib as an external"
+===========================================================
+
+OK, so you want to have the py lib supporting your
+application and are using subversion? Great because
+things are quite easy and flexible for this scenario.
+
+Tying the py lib into your subversion controled project
+-------------------------------------------------------
+
+On the `DIRECTORY` which contains your root package issue::
+
+ svn pe 'svn:externals' DIRECTORY
+
+and add the following line to your (possibly empty) list
+of svn-externals::
+
+ py http://codespeak.net/svn/py/dist
+
+This will make your projcet follow the most recent
+release of the py lib. (please substitute `dist` for `trunk`
+if you want to follow py lib development, this will let
+you catch interaction problems early on ...).
+If you now issue an `svn up` on your `DIRECTORY` you
+will retrieve the external into your application.
+
+If you want to follow a minor release branch seamlessly
+then use the following line::
+
+ py http://codespeak.net/svn/py/branch/py-X.Y
+
+where `X.Y` indicate the branch you want to follow.
+
+If you want to use a very fixed version of the py lib
+you can tie to a specific release::
+
+ py http://codespeak.net/svn/py/tag/py-X.Y.Z
+
+
+Integrating the py lib into your distutils `setup.py`
+-----------------------------------------------------
+
+XXX, maybe something like::
+
+ import py # XXX make sure this is the accomopanying py lib
+
+ def setup(
+ ...
+ .... XXX
+ )
More information about the pytest-commit
mailing list