Skip to content
Browse files

remove addon (no longer in ptah) and update docs.

  • Loading branch information...
1 parent f10eb05 commit 636533fc0381c17f62f9867f16ae6ddb46009ec5 @runyaga runyaga committed
Showing with 27 additions and 103 deletions.
  1. +0 −32 docs/addon.rst
  2. +5 −3 docs/ptah_app_vs_manage.rst
  3. +22 −68 docs/virtualenv.rst
View
32 docs/addon.rst
@@ -1,32 +0,0 @@
-Addon
-=====
-
-The addon subsystem allows packages to be installed easily. This is experimental and should only be used if you are interested in helping with the design of the subsystem.
-
-Example
--------
-
-The example uses routes only. It does not use traversal. You can find an example of a addon here:
-
- - https://github.com/ptahproject/devel/tree/master/addons/devpoll
-
-Overview
---------
-
-All of your configuration will get loaded automatically by defining an entry-point as ptah. Your addon package will be scanned and all configuration will be visible in Ptah Manage. If your addon registration succeeds you will see it in Ptah Manage under Addons.
-
-AppStarting
------------
-
-The current, crude, method for you to register is to subscribe to the
-:py:class:`ptah.config.AppStarting` event. The event will have an attribute, `config` which will be a Configurator. You can use the configurator like you normally would. **DO NOT** commit a transaction in your subscriber; that will happen when someone installs the addon.
-
-More code
----------
-
-Before scaffolding we used this event for application's to insert their
-configuration via event listener. You can find this code here.
-
- - https://github.com/ptahproject/devel/blob/master/src/devapp/devapp/initialize.py
-
-Again, do you not use that code but it gives you example of how your addon can participate if it needs to do something more than register configuration. Remember by simply being in the addon directory with the entry-point in your setup.py; Ptah will scan all files and include them in (without commiting the configuration transaction) and will be available in the addon module in Ptah Manage.
View
8 docs/ptah_app_vs_manage.rst
@@ -49,8 +49,10 @@ The default "modules" for Ptah Manage are:
All templates which are registered through Ptah/Memphis will show up. They are grouped by package in which the template is defined. All templates are overridable.
-Your App
---------
+Ptah 301 App
+------------
+
+The Ptah301 scaffold is Your App.
Your App provides a primitive UI which provides a starting point for you to create an application. You can see your application at /
@@ -87,4 +89,4 @@ Conclusion
----------
Ptah Manage is useful for managing configuration and providing visibility into how your application(s) are configured. It's prime goal is to make you feel comfortable with what, how, where your application is configured. If you do not feel comfortable with Ptah Manage - please let us know. Asking for additional features (search for configuration variables) is out of scope. If the information is there but you have to click around a bit -- we can fix this with UI, else let us know.
-Your App is a default implementation of the `ptah.cms` and the software stack. It is your application. You are building a web application, right? So here is a start.
+Ptah 301 scaffold is a default implementation of the `ptah.cms` and the software stack. It is your application. You are building a web application, right? So here is a start.
View
90 docs/virtualenv.rst
@@ -1,77 +1,31 @@
-Virtualenv and Pip
-==================
-virtualenv and pip are convienant ways to install python packages.
+Virtualenv
+==========
+virtualenv is a convienant way to install python packages.
You will need Python 2.7 and git installed on your machine.
-Install virtualenv
-------------------
+ $ curl -k -O https://raw.github.com/pypa/virtualenv/master/virtualenv.py
+ $ python2.7 virtualenv.py --no-site-packages venv
+ $ cd venv
+ venv$ git clone git://github.com/ptahproject/ptah.git
+ venv$ cd ptah
+ venv/ptah$ ../bin/python setup.py develop
+
+If you like tests, run the tests::
-You need 1.6.4 of virtualenv or greater for Git support.
-use your existing virtualenv. It takes < 15 seconds to grab it.
+ venv/ptah$ ../bin/python setup.py test
-install virtualenv::
+Use paster to create **your own application**. The default username is **admin** and password is **12345**. Check myapp/__init__.py for more information::
- ~$ curl -O https://raw.github.com/pypa/virtualenv/master/virtualenv.py
- ~$ python2.7 virtualenv.py --no-site-packages venv
- ~$ cd venv
+ venv/ptah$ cd ..
+ venv$ bin/paster create -t ptah101 myapp
+ venv$ cd myapp
+ venv/myapp$ ../bin/python setup.py develop
+
+Start application via Paster::
-install ptah::
+ venv/myapp$ ../bin/paster serve settings.ini --reload
- ~/venv$ bin/pip install -e git+https://github.com/ptahproject/ptah.git#egg=ptah
- ~/venv$ cd src/ptah
- ~/venv/src/ptah$ ../../bin/python setup.py develop
-
-Create ptah addon
-~~~~~~~~~~~~~~~~~
+Login by opening your web browser to http://localhost:6543/ with credentials, login **admin** and password **12345**
-Let's create ptah addon with paster::
-
- ~/venv/src/ptah$ cd ..
- ~/venv/src$ ../bin/paster create -t ptahdemo myapp
- ~/venv/src$ cd myapp
- ~/venv/src/myapp$ ../../bin/python2.7 setup.py develop
-
-
-Start app
-~~~~~~~~~
-
-Start paster server::
-
- ~/venv$ bin/paster serve development.ini
-
-Login
-~~~~~
-
-A default user is created for you. login: admin and password: 12345
-
-Open your browser to see Ptah App, http://localhost:6543/
-
-You can see Ptah Manage, http://localhost:6543/ptah-manage/
-
-These are 2 separate wsgi apps. They are both optional. The "DT" tab
-on the right hand side of the screen is the Debug Toolbar from Pyramid.
-
-Run Tests
-~~~~~~~~~
-
-We use the `nose` test runner to collect which tests to run. You can
-read up how to use coverage integration. This is standard python usage
-of the the nose library; nothing fancy.
-
-Run ptah tests::
-
- ~$ cd src/ptah
- ptah$ ../bin/python setup.py develop
- ptah$ ../bin/python setup.py test
-
-Run myapp tests::
-
- ~$ cd myapp
- myapp$ ../bin/python setup.py test
-
-Summary
-~~~~~~~
-
-Look inside myapp/__init__.py and you will see the application
-startup configuration.
+You should read the source of myapp, after all it is your application. A good place to start is myapp/__init__.py

0 comments on commit 636533f

Please sign in to comment.
Something went wrong with that request. Please try again.