Skip to main content

Piano. Beginner friendly Plone development.

Project description

piano
=======

.. image:: https://travis-ci.org/for-beginner-piano/for-beginner-piano.svg?branch=master

Piano. Beginner friendly Plone development.

.. warning:: This is very much ALPHA!. In the spirit of release early, here it is.

Installation
============

Quick Install
-------------

To install `piano` quickly, run the following commands:

::

wget -qO- goo.gl/NmFSel | bash
source ~/.bashrc

This will use `pipsi` to install the relevant packages in user space.
It also ensures that piano is using the most up-to-date version of
setuptools.

Longer Install
---------------

We prefer and recommend `pipsi`.
(Here are installation instructions for pipsi https://github.com/mitsuhiko/pipsi#readme.)

Once you have pipsi run:

::

pipsi install for-beginner-piano
~/.local/venvs/for-beginner-piano/bin/pip install -U setuptools

.. note:: It is important to ensure that the latest version of setuptools is installed
for this reason we run the second command above.

Usage
=====

To create a new Plone buildout project
--------------------------------------

Use the subcommand `newbuildout` to create a buildout project.

For example, if your project will be called `my-plone-site`:

::

piano newbuildout my-plone-site

.. note:: A buildout is a folder which holds all the settings required to build
and deploy a Plone site

You'll see output similar to this:

::

Creating virtualenv... (my-plone-site)
Installing Buildout...
Downloading installer (https://launchpad.net/plone/4.3/4.3.3/+download/Plone-4.3.3-UnifiedInstaller.tgz)
Unpacking installer...
Unpacking cache...
Installing eggs...
Installing cmmi & dist...
Configuring cache...
Running Buildout...


Creating a Plone add-on
------------------------

This is not working yet, but:

::

piano newaddon myaddon

(coming soon, this command doesn't work yet)

Credits
--------

piano is created and managed by David Bain, it is built on top of plock which was
created and maintained by Alex Clark.



Changelog
=========

0.2.5 (2015-02-02)
------------------

- made adjustments to README

0.2.3 (2015-02-02)
------------------

- added MANIFEST.in
- added README and CHANGES to long description of setup.py

0.2.2 (2015-02-02)
------------------

- now unpacks unified installer cache to ~/.buildout/
- creates ~/.buildout/default.cfg file
- keeps a cache based on settings in default.cfg,
cache is, by default ~/.buildout/[eggs|downloads|extends-cache]

0.2.1 (2015-02-01)
------------------

- fix broken release

0.2.0 (2015-02-01)
------------------

- added and documented quick install script
- added Change log

0.1.0 (2015-02-01)
------------------

- Initial release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

for-beginner-piano-0.2.7.tar.gz (5.8 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page