https://github.com/steder/txproject

Twisted project quickstart
https://github.com/steder/txproject

project-template python twisted

Last synced: about 1 month ago
JSON representation

Twisted project quickstart

• Host: GitHub
• URL: https://github.com/steder/txproject
• Owner: steder
• Created: 2012-02-03T17:20:01.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2015-04-13T14:17:43.000Z (about 10 years ago)
• Last Synced: 2025-02-10T12:43:18.527Z (3 months ago)
• Topics: project-template, python, twisted
• Language: Python
• Homepage:
• Size: 119 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# txProject

## About

txProject is a set of utilities for quickly creating getting simple Twisted Python based

projects off the ground with all the convenient boilerplate already in place.

By providing a working skeleton with tests, plugin files, and basic configuration

txProject makes it easier for a twisted newbie to see how things fit together.  They

get an idea how they might organize their code and they have something that is working

immediately that they can begin to explore.

txProject is driven by basic templates and these templates can easily be customized

to provide more or fewer features to fit the developers needs.

## Installation

### Standard installation with Distutils

$ tar -zxvf txProject-1.0.tar.gz

$ cd txProject

$ python setup.py build

$ sudo python setup.py install

## Example Usage

txProject provides a txproject command.

### Creating a simple Twisted Web application

    $ txproject hello

This command creates the following:

    Hello/

    |-- bin/

    |-- hello/

    |   |-- test/

    |   |   `-- test_web.py

    |   `-- web.py

    `-- twisted/

            plugins/

                hello_plugin.py