README.md

Pymfony Standard Edition

Welcome to the Pymfony Standard Edition - a fully-functional Pymfony application that you can use as the skeleton for your new applications.

This document contains information on how to download, install, and start using Pymfony.

1. Installing the Standard Edition

---

As Pymfony uses Virtualenv to manage its dependencies, the recommended way to create a new project is to use it.

If you don't have Virtualenv yet, run the following command:

curl -O https://raw.github.com/pypa/virtualenv/master/virtualenv.py

To quickly test Pymfony, you can download an archive of the Standard Edition and unpack it somewhere.

Go to the Pymfony Standard Edition root directory (e.g. cd path/to/pymfony-standard) and run the following commands:

python virtualenv.py vendor
vendor/bin/pip install -r requirements.txt

2. Running the Demo Application

---

Congratulations! You're now ready to use Pymfony.

To see a real-live Pymfony in action, type the following command:

app/console hello Fabien

3. Getting started with Pymfony

---

This distribution is meant to be the starting point for your Pymfony applications, but it also contains some sample code that you can learn from and play with.

A default bundle, AcmeDemoBundle, shows you Pymfony in action. After playing with it, you can remove it by following these steps:

• delete the src/acme directory;

• remove the command entries referencing AcmeBundle in app/Resources/config/commands_dev.yml;

• remove the AcmeBundle from the registered bundles in app/app_kernel.py;

What's inside?

The Pymfony Standard Edition is configured with the following defaults:

It comes pre-configured with the following bundles:

• FrameworkBundle - The core Pymfony framework bundle

• AcmeDemoBundle (in dev/test env) - A demo bundle with some example code

Enjoy!