diff --git a/AUTHORS.rst b/AUTHORS.rst new file mode 100644 index 0000000..6fef61c --- /dev/null +++ b/AUTHORS.rst @@ -0,0 +1,4 @@ +Authors +------- + +.. todo:: Add authors \ No newline at end of file diff --git a/docs/intro/duction.rst b/docs/intro/duction.rst index a6b9b1f..a96ca88 100644 --- a/docs/intro/duction.rst +++ b/docs/intro/duction.rst @@ -1,8 +1,7 @@ Introduction ============ -Someone should write a general blurb introducing the Python language here. - +.. todo:: write a general blurb introducing the Python language About This Guide ---------------- diff --git a/docs/intro/learning.rst b/docs/intro/learning.rst index fadf351..01870fd 100644 --- a/docs/intro/learning.rst +++ b/docs/intro/learning.rst @@ -59,13 +59,9 @@ Advanced Pro Python ~~~~~~~~~~ -TODO: Write about this book - - `Pro Python `_ +.. todo:: Write about `Pro Python `_ Expert Python Programming ~~~~~~~~~~~~~~~~~~~~~~~~~ -TODO: Write about this book - - `Expert Python Programming `_ +.. todo:: Write about `Expert Python Programming `_ diff --git a/docs/notes/contribute.rst b/docs/notes/contribute.rst index 4ecb675..548c3a5 100644 --- a/docs/notes/contribute.rst +++ b/docs/notes/contribute.rst @@ -16,6 +16,7 @@ If you'd like to contribute, there's plenty to do. Here's a short todo_ list. .. _GitHub: http://github.com/kennethreitz/python-guide/ -.. _AUTHORS: http://github.com/kennethreitz/python-guide/blob/master/AUTHORS +.. _AUTHORS: http://github.com/kennethreitz/python-guide/blob/master/AUTHORS.rst .. _todo: https://github.com/kennethreitz/python-guide/blob/master/TODO.rst +.. include:: ../../AUTHORS.rst \ No newline at end of file diff --git a/docs/notes/license.rst b/docs/notes/license.rst index d03e7d1..d26b3c7 100644 --- a/docs/notes/license.rst +++ b/docs/notes/license.rst @@ -1,4 +1,4 @@ License ------- -TBD. \ No newline at end of file +.. todo:: Determine License \ No newline at end of file diff --git a/docs/scenarios/admin.rst b/docs/scenarios/admin.rst index f3a1492..1de9fa6 100644 --- a/docs/scenarios/admin.rst +++ b/docs/scenarios/admin.rst @@ -4,14 +4,24 @@ Systems Administration Fabric ------ +.. todo:: Write about Fabric Chef ---- +.. todo:: Write about Chef Puppet ------ +.. todo:: Write about Puppet Blueprint ---------- \ No newline at end of file +--------- + +.. todo:: Write about Blueprint + +Buildout +-------- + +.. todo:: Write about Buildout \ No newline at end of file diff --git a/docs/scenarios/ci.rst b/docs/scenarios/ci.rst index cd3d5dd..15166a2 100644 --- a/docs/scenarios/ci.rst +++ b/docs/scenarios/ci.rst @@ -5,23 +5,28 @@ Continuous Integration Why? ---- -Martin Fowler, who first wrote about Continuous Integration (short: CI) together with Kent Beck, describes the CI as follows: +Martin Fowler, who first wrote about `Continuous Integration `_ (short: CI) together with Kent Beck, describes the CI as follows: Continuous Integration is a software development practice where members of a team integrate their work frequently, usually each person integrates at least daily - leading to multiple integrations per day. Each integration is verified by an automated build (including test) to detect integration errors as quickly as possible. Many teams find that this approach leads to significantly reduced integration problems and allows a team to develop cohesive software more rapidly. This article is a quick overview of Continuous Integration summarizing the technique and its current usage. -Source: http://martinfowler.com/articles/continuousIntegration.html - Jenkins ------- -Jenkins CI (http://jenkins-ci.org) is an extensible continuous integration engine. Use it. +`Jenkins CI `_ is an extensible continuous integration engine. Use it. Buildbot -------- -Buildbot (http://buildbot.net/buildbot/docs/current) is a Python system to automate the compile/test cycle to validate code changes. +`Buildbot `_ is a Python system to automate the compile/test cycle to validate code changes. Mule? ----- + +.. todo:: Write about Mule + +Tox +--- + +.. todo:: Write about `Tox `_ diff --git a/docs/scenarios/cli.rst b/docs/scenarios/cli.rst index 216ad6b..cea7a3f 100644 --- a/docs/scenarios/cli.rst +++ b/docs/scenarios/cli.rst @@ -1,8 +1,9 @@ Command Line Applications ========================= - +.. todo:: Explain "Command Line Applications" Clint ----- +.. todo:: Write about Clint \ No newline at end of file diff --git a/docs/scenarios/db.rst b/docs/scenarios/db.rst index ad04d04..7b6ad95 100644 --- a/docs/scenarios/db.rst +++ b/docs/scenarios/db.rst @@ -22,3 +22,7 @@ database-agnostic code without SQL. pip install sqlalchemy +Django ORM +---------- + +.. todo:: Explain Django ORM \ No newline at end of file diff --git a/docs/scenarios/gui.rst b/docs/scenarios/gui.rst index de4e47d..8572f7b 100644 --- a/docs/scenarios/gui.rst +++ b/docs/scenarios/gui.rst @@ -12,16 +12,17 @@ http://developer.qt.nokia.com/wiki/PySideDownloads/ PyQt ---- -*Note: If your software does not fully comply with the GPL you will need a commercial license!* +.. note:: If your software does not fully comply with the GPL you will need a commercial license! + http://www.riverbankcomputing.co.uk/software/pyqt/download Cocoa ::::: -*Note: The Cocoa framework is only available on Mac OSX. Don't pick this if you're writing a cross-platform application!* +.. note:: The Cocoa framework is only available on Mac OSX. Don't pick this if you're writing a cross-platform application! PyObjC ------ -*Note: Only available on Mac OSX. Don't pick this if you're writing a cross-platform application.* +.. note:: Only available on Mac OSX. Don't pick this if you're writing a cross-platform application. WXPython :::::::: diff --git a/docs/scenarios/speed.rst b/docs/scenarios/speed.rst index 5a4bd13..81e695c 100644 --- a/docs/scenarios/speed.rst +++ b/docs/scenarios/speed.rst @@ -3,6 +3,7 @@ Speed CPython, the most commonly used implementation of Python, is slow for CPU bound tasks. `PyPy`_ is fast. +.. todo:: Fill in stub for Speed comparisons Context ::::::: diff --git a/docs/scenarios/web.rst b/docs/scenarios/web.rst index 60a478d..8d0ebe5 100644 --- a/docs/scenarios/web.rst +++ b/docs/scenarios/web.rst @@ -74,10 +74,13 @@ already exist to suit your needs. Pyramid ------- +.. todo:: Explian Pyramid Servers ::::::: +.. todo:: Explain Apache deployment + Apache + mod_wsgi ----------------- @@ -107,6 +110,7 @@ setup for Nginx + gUnicorn can be found in the gUnicorn Mongrel2 + Brubeck ------------------ +.. todo:: Explain Mongrel2 + Brubeck Mongrel2 + wsgid ---------------- @@ -209,6 +213,8 @@ Gondor publishes guides to deploying `Django projects Shared Web Hosting ------------------ +.. todo:: Fill in "Shared Web Hosting" stub + WebFaction ~~~~~~~~~~~ diff --git a/docs/shipping/freezing.rst b/docs/shipping/freezing.rst index 1f9fd4a..b6803af 100644 --- a/docs/shipping/freezing.rst +++ b/docs/shipping/freezing.rst @@ -10,6 +10,9 @@ Many applications you use every day do this: - BitTorrent - + +.. todo:: Fill in "Freezing Your Code" stub + Windows ::::::: diff --git a/docs/shipping/packaging.rst b/docs/shipping/packaging.rst index 40a0ac4..28762e1 100644 --- a/docs/shipping/packaging.rst +++ b/docs/shipping/packaging.rst @@ -3,6 +3,7 @@ Packaging Your Code Packaging your code is important. +.. todo:: Write introduction for "Packaging Your Code" For Python Developers ::::::::::::::::::::: @@ -14,7 +15,7 @@ If you're writing an open source Python module, `PyPI `_ Pip vs. easy_install -------------------- -Use pip. More details `here `_ +Use `pip `_. More details `here `_ Personal PyPI @@ -54,10 +55,13 @@ $ pip install http://127.0.0.1:9000/MyPackage.tar.gz Chishop +++++++ +`Chishop `_ is a simple PyPI server written in django which allows you to register/upload with distutils and install with easy_install/pip. For Linux Distributions :::::::::::::::::::::::: +.. todo:: Fill in "For Linux Distributions" packaging stub + Useful Tools ------------ diff --git a/docs/starting/dev-env.rst b/docs/starting/dev-env.rst index b1f2498..bdee749 100644 --- a/docs/starting/dev-env.rst +++ b/docs/starting/dev-env.rst @@ -54,6 +54,19 @@ the following lines into your vimrc:: .. todo:: add supertab notes +TextMate +-------- + +"`TextMate `_ brings Apple's approach to operating systems into the world of text editors. By bridging UNIX underpinnings and GUI, TextMate cherry-picks the best of both worlds to the benefit of expert scripters and novice users alike." + +Sublime Text +------------ + +"`Sublime Text `_ is a sophisticated text editor for code, html and prose. You'll love the slick user interface and extraordinary features." + +Sublime Text uses Python for its plugin API. + +`Sublime Text 2 `_ is currently in beta. IDEs :::: @@ -61,7 +74,7 @@ IDEs PyCharm / IntelliJ IDEA ----------------------- -PyCharm is developed by JetBrains, also known for IntelliJ IDEA. Both share the same code base and most of PyCharm's features can be brought to IntelliJ with the free `Python Plug-In `_.. +`PyCharm `_ is developed by JetBrains, also known for IntelliJ IDEA. Both share the same code base and most of PyCharm's features can be brought to IntelliJ with the free `Python Plug-In `_. Eclipse ------- @@ -82,8 +95,7 @@ Spyder Includes integration with `pyflakes `_, `pylint `_, and `rope `_. -Spyder is open-source (free), offers code completion, syntax highlighting, class and function browser, and object -inspection +Spyder is open-source (free), offers code completion, syntax highlighting, class and function browser, and object inspection. @@ -100,7 +112,7 @@ It solves the "Project X depends on version 1.x but, Project Y needs 4.x" dilemm virtualenvwrapper ----------------- -Virtualenvwrapper makes virtualenv a pleasure to use by wrapping the command line API with a nicer CLI. +`Virtualenvwrapper `_ makes virtualenv a pleasure to use by wrapping the command line API with a nicer CLI. :: @@ -121,9 +133,17 @@ Other Tools IPython ------- +`IPython `_ provides a rich toolkit to help you make the most out of using Python interactively. Its main components are: + +* Powerful Python shells (terminal- and Qt-based). +* A web-based notebook with the same core features but support for rich media, text, code, mathematical expressions and inline plots. +* Support for interactive data visualization and use of GUI toolkits. +* Flexible, embeddable interpreters to load into your own projects. +* Tools for high level and interactive parallel computing. + :: - $ pip install ipython + pip install ipython @@ -132,6 +152,6 @@ BPython :: - $ pip install bpython + pip install bpython diff --git a/docs/writing/license.rst b/docs/writing/license.rst index 6d91fea..739271d 100644 --- a/docs/writing/license.rst +++ b/docs/writing/license.rst @@ -4,7 +4,7 @@ Choosing a License Open source. - +.. todo:: Fill in License stub Non-Restrictive diff --git a/docs/writing/structure.rst b/docs/writing/structure.rst index 849bdea..b83f09a 100644 --- a/docs/writing/structure.rst +++ b/docs/writing/structure.rst @@ -3,6 +3,7 @@ Structuring Your Project Structuring your project properly is extremely important. +.. todo:: Fill in "Structuring Your Project" stub Structure is Key ----------------