Skip to content

Commit 9057d75

Browse files
committed
Update README
1 parent ccaae1b commit 9057d75

File tree

1 file changed

+81
-0
lines changed

1 file changed

+81
-0
lines changed

README.rst

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
===================================
2+
TurboGears 2 DevTools
3+
===================================
4+
5+
[![Build Status](https://img.shields.io/travis/TurboGears/tg2devtools.svg)](https://travis-ci.org/TurboGears/tg2devtools)
6+
[![PyPI version](https://img.shields.io/pypi/v/tg.devtools.svg)](https://pypi.org/project/tg.devtools)
7+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
8+
9+
TurboGears 2 DevTools is a command-line toolkit that streamlines the development of TurboGears2 applications.
10+
Built on top of Gearbox, it helps you quickly scaffold new full-stack projects, generate extensions,
11+
manage database migrations, and launch interactive shells—all from one unified interface.
12+
13+
Key Features
14+
------------
15+
- **Quickstart**: Scaffold a new TurboGears2 project in minutes.
16+
- **Extension Generator**: Easily create and integrate TurboGears extensions.
17+
- **Database Migrations**: Run migration commands for SQLAlchemy and Alembic effortlessly.
18+
- **Interactive Shell**: Launch a shell preloaded with your app's context for rapid testing.
19+
- **Gearbox Integration**: Seamlessly work with Gearbox to serve and manage your applications.
20+
21+
Getting Started
22+
---------------
23+
**Installation:**
24+
25+
To install via pip, run:
26+
27+
::
28+
29+
pip install tg.devtools
30+
31+
For development and testing, install with extras:
32+
33+
::
34+
35+
pip install -e .[testing]
36+
37+
**Creating a New Project:**
38+
39+
Use the quickstart command to generate a new TurboGears2 full-stack application:
40+
41+
::
42+
43+
gearbox quickstart myproject
44+
45+
This creates a ready-to-run project with a standard directory structure and preconfigured settings.
46+
47+
Usage Examples
48+
--------------
49+
- **Generate a TG Extension:**
50+
51+
::
52+
53+
gearbox tgext
54+
55+
- **Run Database Migrations:**
56+
57+
::
58+
59+
gearbox sqla-migrate
60+
gearbox migrate
61+
62+
- **Launch an Interactive Shell:**
63+
64+
::
65+
66+
gearbox tgshell
67+
68+
Resources
69+
---------
70+
- **TurboGears Website**: `http://www.turbogears.org`
71+
- **Documentation**: `https://turbogears.readthedocs.io`
72+
- **Community & Support**: Join our mailing list or Gitter chatroom.
73+
74+
Contributing
75+
------------
76+
Contributions, bug reports, and feature requests are welcome!
77+
78+
License
79+
-------
80+
TurboGears 2 DevTools is licensed under the MIT License.
81+
See the [LICENSE](LICENSE.txt) file for details.

0 commit comments

Comments
 (0)