diff options
| author | ianb <devnull@localhost> | 2008-04-23 03:24:01 +0000 |
|---|---|---|
| committer | ianb <devnull@localhost> | 2008-04-23 03:24:01 +0000 |
| commit | ae342f3ec36faed8dd35f858e9cf342d45a9d864 (patch) | |
| tree | 53bd0fb22f08c4b9ab1fb2c986123ffcbf17b1fd /docs | |
| parent | fc3d6765adb8c7af7a4e06a14a90333db439cbae (diff) | |
| download | paste-ae342f3ec36faed8dd35f858e9cf342d45a9d864.tar.gz | |
remove defunct docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/develop-example.txt | 77 | ||||
| -rw-r--r-- | docs/enabled.txt | 42 | ||||
| -rw-r--r-- | docs/install-example.txt | 33 | ||||
| -rw-r--r-- | docs/package_index.txt | 20 | ||||
| -rw-r--r-- | docs/related-projects.txt | 41 |
5 files changed, 0 insertions, 213 deletions
diff --git a/docs/develop-example.txt b/docs/develop-example.txt deleted file mode 100644 index c93c482..0000000 --- a/docs/develop-example.txt +++ /dev/null @@ -1,77 +0,0 @@ -Development With Paste: An Example -++++++++++++++++++++++++++++++++++ - -This example uses `WebKit </webkit/>`_, `SQLObject -<http://sqlobject.org>`_, and `Zope Page Templates -<http://www.zope.org/DevHome/Wikis/DevSite/Projects/ZPT/>`_, but it's -all pluggable for other frameworks and tools. - -Paste enabled applications are all proper Python packages, and even -moreso they are installable by `easy_install -<http://peak.telecommunity.com/DevCenter/EasyInstall>`_, including -Paste itself:: - - $ easy_install PasteScript PasteWebKit SQLObject ZPTKit - ... messages fly by ... - -This example also uses Subversion repository (we'll assume you've set -up a repository with ``svnadmin create /home/me/testrepos``). When -you create a project, you can create a layout in your repository for -it. - -This will create the new project:: - - $ paster create --template=webkit --template=zpt \ - --svn-repository=file:///home/me/testrepos Wiki - ... the package is setup in the repository ... - ... file listings fly by ... - $ cd Wiki - $ svn commit -m "New project" - ... messages about committing ... - -The basic setup has a simplest of applications already set up; you can -test everything is working by running:: - - $ paster serve --reload docs/devel_config.ini - ... now your new app is served on http://localhost:8080/ ... - ... ^C to quit - -It also has set up a `py.test -<http://codespeak.net/py/current/doc/test.html>`_ fixture for you, so -you can run the first test (which just tests that the front page loads -up properly): - - $ py.test -v - ... test results ... - -Using the ``webkit`` template we've also added a new command for -setting up new servlets:: - - $ paster servlet listing - ... @@: creating files ... - -Also, all the metadata for SQLObject has been added to the template, -and can be used like:: - - $ sqlobject-admin create --egg=Wiki - ... database create statements ... - -You can add version information to your model as well, so that you can -develop and record your updates, and then apply them to old versions -of the database. - -Once you've made something you are ready to deploy, you can use -`buildutils <http://buildutils.lesscode.org/>`_ to tag it for -release:: - - $ python setup.py svntag --version=0.1 -b ../Wiki01 - $ cd ../Wiki01 - $ python setup.py sdist - ... boring messages ... - ... @@: Deploy stuff ... - -And then deploy it on another server:: - - $ ssh other-server - ... @@: More deploy stuff ... - diff --git a/docs/enabled.txt b/docs/enabled.txt deleted file mode 100644 index 8cc974f..0000000 --- a/docs/enabled.txt +++ /dev/null @@ -1,42 +0,0 @@ -Paste Enabled -+++++++++++++ - -*Paste Enabled* means that a web application has a simple and -consistent means of installation and configuration. - -What does this mean? Well, here's how you install the code and -dependencies for a Paste Enabled application:: - - easy_install ApplicationName - -Here's the configure file to use that application:: - - [app:main] - use = egg:ApplicationName - database = ... - title = - -Once you've configured it, you can serve that application immediately -and directly (using a simple HTTP server), or you can run it under -SCGI, FastCGI, HTTP proxy, AJP, and other protocols. - -If you want to run multiple applications on the same site, you just -create a mapping:: - - [app:main] - use = egg:Paste#urlmap - /forum = config:forum.ini - /contact = config:contact.ini - -A Paste Enabled application can be embedded in other applications, -easily included in other websites, managed by simple startup/shutdown -scripts, and easily upgraded. "Paste Enabled" means the application -is well encapsulated, ready for distribution and reuse, and easy to -manage. - -When a **framework** is Paste Enabled, it means it helps you build -Paste Enabled applications. A good framework should guide you through -the steps to - -Paste Enabled builds on other emerging standards like WSGI and Python -Eggs. diff --git a/docs/install-example.txt b/docs/install-example.txt deleted file mode 100644 index 42b74fd..0000000 --- a/docs/install-example.txt +++ /dev/null @@ -1,33 +0,0 @@ -Paste Installation -++++++++++++++++++ - -Installation of Paste-enabled applications is consistent and reliable; -you don't have to understand what technologies those applications -used. Paste-enabled applications are installable with `easy_install -<http://peak.telecommunity.com/DevCenter/EasyInstall>`_, like:: - - $ easy_install FileBrowser - ... messages ... - -Once an application is installed, you can set up an instance of that -application with ``paste deploy``:: - - $ paste deploy FileBrowser location - ... @@: make this work ;) ... - -This just wrote to ``location/filebrowser.ini`` -- you can configure -the application there, with whatever specifics that application needs. -Then you can integrate it into your website and other applications, -with a file like:: - - [composit:main] - use = egg:Paste#urlmap - /browser = config:filebrowser.ini - -You can attach applications to many locations using this. Once you've -set that file up with your local settings and preferences, you can -run:: - - $ paster serve location/apps.ini --daemon - -And it will be running in the background. diff --git a/docs/package_index.txt b/docs/package_index.txt deleted file mode 100644 index 2a6a38f..0000000 --- a/docs/package_index.txt +++ /dev/null @@ -1,20 +0,0 @@ -Paste: Package Index -==================== - -This page lists packages used in Paste that aren't in PyPI for some reason. - -* `ZopePageTemplates </download/ZopePageTemplates-1.4.1.tar.gz>`_ - -* `flup <http://svn.saddi.com/flup/trunk#egg=flup-dev>`_ - -* `WSGIUtils - <http://pylons.groovie.org/files/WSGIUtils-0.6-py2.4.egg>`_ - -* `LoginKit <http://svn.w4py.org/LoginKit/trunk#egg=LoginKit-dev>`_ - -* `Component - <http://svn.w4py.org/Component/tags/0.2#egg=Component-0.2>`_ (and - `trunk <http://svn.w4py.org/Component/trunk#egg=Component-dev>`_) - -* `ElementTree - <http://effbot.org/downloads/elementtree-1.2.6-20050316.zip>`_ diff --git a/docs/related-projects.txt b/docs/related-projects.txt deleted file mode 100644 index 23c3e38..0000000 --- a/docs/related-projects.txt +++ /dev/null @@ -1,41 +0,0 @@ -Related Projects -++++++++++++++++ - -These are all actually in the same package (``setuptools``): - -* `setuptools <http://peak.telecommunity.com/DevCenter/setuptools>`_ - for generation of packages. - -* `easy_install - <http://peak.telecommunity.com/DevCenter/EasyInstall>`_ for - installation of packages (``easy_install`` is a kind of front-end - for setuptools, and Python software installation in general). - -* `Python Eggs <http://peak.telecommunity.com/DevCenter/PythonEggs>`_ - for introspection of packages and general "pluggability". - (``setuptools`` creates and installs Eggs) - -Other packages are used in Paste, and development may bleed into those -projects. Though you don't have to use those projects to use Paste or -to have a Paste-enabled package, I think these are quality tools that -form a more complete development experience: - -* `Subversion <http://subversion.tigris.org/>`_ for version control. - -* `buildutils <http://buildutils.lesscode.org>`_ for some common - maintenance tasks. - -* `Pudge <http://pudge.lesscode.org>`_ for documentation generation - (at least this website is generated using Pudge). - -* `py.test <http://codespeak.net/py/current/doc/test.html>`_ for - testing. ``paste.fixture`` is entirely usable from within `unittest - <http://python.org/doc/current/lib/module-unittest.html>`_, but the - experience is more streamlined in ``py.test``. - -* `INITools <http://pythonpaste.org/initools/>`_ for .INI-file - parsing. Paste only partially uses this package, but probably will - more in the future. - -* `Cheetah <http://cheetahtemplate.org>`_ for file generation, - especially generating startup file layouts and configuration files. |
